Search…
API Reference
Resources
Retrieve a braintree payment
How to fetch a specific braintree payment via API
To fetch a single braintree payment, send a GET request to the /api/braintree_payments/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

GET https://yourdomain.commercelayer.io/api/braintree_payments/:id

Example

Request
Response
The following request fetches the braintree payment identified by the id "xYZkjABcde":
1
curl -g -X GET \
2
'https://yourdomain.commercelayer.io/api/braintree_payments/xYZkjABcde' \
3
-H 'Accept: application/vnd.api+json' \
4
-H 'Authorization: Bearer your-access-token'
Copied!
On success, the API responds with a 200 OK status code, returning a single resource object:
1
{
2
"data": {
3
"id": "xYZkjABcde",
4
"type": "braintree_payments",
5
"links": {
6
"self": "https://yourdomain.commercelayer.io/api/braintree_payments/xYZkjABcde"
7
},
8
"attributes": {
9
"client_token": "xxxx.yyyy.zzzz",
10
"payment_method_nonce": "xxxx.yyyy.zzzz",
11
"payment_id": "xxxx.yyyy.zzzz",
12
"local": true,
13
"options": {
14
"customer_id": "1234567890"
15
},
16
"created_at": "2018-01-01T12:00:00.000Z",
17
"updated_at": "2018-01-01T12:00:00.000Z",
18
"reference": "ANY-EXTERNAL-REFEFERNCE",
19
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
20
"metadata": {
21
"foo": "bar"
22
}
23
},
24
"relationships": {
25
"order": {
26
"links": {
27
"self": "https://yourdomain.commercelayer.io/api/braintree_payments/xYZkjABcde/relationships/order",
28
"related": "https://yourdomain.commercelayer.io/api/braintree_payments/xYZkjABcde/order"
29
}
30
},
31
"payment_gateway": {
32
"links": {
33
"self": "https://yourdomain.commercelayer.io/api/braintree_payments/xYZkjABcde/relationships/payment_gateway",
34
"related": "https://yourdomain.commercelayer.io/api/braintree_payments/xYZkjABcde/payment_gateway"
35
}
36
}
37
},
38
"meta": {
39
"mode": "test"
40
}
41
}
42
}
Copied!
Last modified 23d ago
Copy link