API reference
Search…
⌃K
Links

List all checkout.com payments

How to fetch a collection of checkout.com payments via API
To fetch a collection of checkout.com payments, send a GET request to the /api/checkout_com_payments endpoint.

Request

GET https://yourdomain.commercelayer.io/api/checkout_com_payments

Example

Request
Response
The following request fetches a collection of checkout.com payments:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/checkout_com_payments/' \
-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 paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "checkout_com_payments",
"links": {
"self": "https://yourdomain.commercelayer.io/api/checkout_com_payments/xYZkjABcde"
},
"attributes": {
"public_key": "pk_test_xxxx-yyyy-zzzz",
"payment_type": "token",
"token": "tok_4gzeau5o2uqubbk6fufs3m7p54",
"session_id": "sid_y3oqhf46pyzuxjbcn2giaqnb44",
"success_url": "http://commercelayer.dev/checkout_com/success",
"failure_url": "http://commercelayer.dev/checkout_com/failure",
"source_id": "src_nwd3m4in3hkuddfpjsaevunhdy",
"customer_token": "cus_udst2tfldj6upmye2reztkmm4i",
"redirect_uri": "https://api.checkout.com/3ds/pay_mbabizu24mvu3mela5njyhpit4",
"payment_response": {
"foo": "bar"
},
"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/checkout_com_payments/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/checkout_com_payments/xYZkjABcde/order"
}
},
"payment_gateway": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/checkout_com_payments/xYZkjABcde/relationships/payment_gateway",
"related": "https://yourdomain.commercelayer.io/api/checkout_com_payments/xYZkjABcde/payment_gateway"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 checkout_com_payments (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/checkout_com_payments?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/checkout_com_payments?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/checkout_com_payments?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of checkout.com payments can be sorted by the following fields:
  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Filterable fields

The list of checkout.com payments can be filtered by the following fields:

Attributes

  • id
  • created_at
  • updated_at
  • reference
  • reference_origin

Relationships

  • order
  • payment_gateway