Retrieve a paypal payment
How to fetch a specific paypal payment via API
To fetch a single paypal payment, send a GET request to the /api/paypal_payments/:id endpoint, where id is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/paypal_payments/:id
Example
The following request fetches the paypal payment identified by the ID "XAyRWNUzyN":
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'On success, the API responds with a 200 OK status code, returning a single resource object:
{
"data": {
"id": "XAyRWNUzyN",
"type": "paypal_payments",
"links": {
"self": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN"
},
"attributes": {
"return_url": "https://yourdomain.com/thankyou",
"cancel_url": "https://yourdomain.com/checkout/payment",
"note_to_payer": "Thank you for shopping with us!",
"paypal_payer_id": "ABCDEFGHG123456",
"name": "ABCDEFGHG123456",
"paypal_id": "1234567890",
"status": "created",
"approval_url": "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-1234567890ABCDEFGHG",
"mismatched_amounts": false,
"payment_instrument": {
"issuer": "cl bank",
"card_type": "visa"
},
"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"
}
},
"relationships": {
"order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/order"
}
},
"payment_gateway": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/relationships/payment_gateway",
"related": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/payment_gateway"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/versions"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/paypal_payments/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated