Create a braintree gateway
How to create a braintree gateway via API
To create a new braintree gateway, send a POST request to the /api/braintree_gateways endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/braintree_gateways
Arguments
type
string
Required
attributes.name
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
attributes.merchant_account_id
string
Required
attributes.merchant_id
string
Required
attributes.public_key
string
Required
attributes.private_key
string
Required
attributes.descriptor_name
string
Optional
attributes.descriptor_phone
string
Optional
attributes.descriptor_url
string
Optional
relationships.braintree_payments
array
Optional
Example
The following request creates a new braintree gateway:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/braintree_gateways' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "braintree_gateways",
"attributes": {
"name": "US payment gateway",
"merchant_account_id": "xxxx-yyyy-zzzz",
"merchant_id": "xxxx-yyyy-zzzz",
"public_key": "xxxx-yyyy-zzzz",
"private_key": "xxxx-yyyy-zzzz"
}
}
}'On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "XAyRWNUzyN",
"type": "braintree_gateways",
"links": {
"self": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN"
},
"attributes": {
"name": "US payment gateway",
"created_at": "2018-01-01T12:00:00.000Z",
"updated_at": "2018-01-01T12:00:00.000Z",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"metadata": {
"foo": "bar"
},
"descriptor_name": "company*productabc1234",
"descriptor_phone": "3125551212",
"descriptor_url": "company.com",
"webhook_endpoint_url": "https://core.commercelayer.co/webhook_callbacks/braintree_gateways/xxxxx"
},
"relationships": {
"payment_methods": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/relationships/payment_methods",
"related": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/payment_methods"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/event_stores"
}
},
"braintree_payments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/relationships/braintree_payments",
"related": "https://yourdomain.commercelayer.io/api/braintree_gateways/XAyRWNUzyN/braintree_payments"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated

