List all payment options
How to fetch a collection of payment options via API
To fetch a collection of payment options, send a GET
request to the /api/payment_options
endpoint.
Request
GET https://yourdomain.commercelayer.io/api/payment_options
Example
The following request fetches a collection of payment options:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/payment_options/' \
-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": "payment_options",
"links": {
"self": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde"
},
"attributes": {
"created_at": "2018-01-01T12:00:00.000Z",
"data": {
"application_fee_amount": 1000,
"on_behalf_of": "pm_xxx"
},
"metadata": {
"foo": "bar"
},
"name": "Stripe Payment Option",
"payment_source_type": "stripe_payments",
"reference": "ANY-EXTERNAL-REFEFERNCE",
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
"updated_at": "2018-01-01T12:00:00.000Z"
},
"relationships": {
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/attachments"
}
},
"order": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/payment_options/xYZkjABcde/order"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 payment_options (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/payment_options?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/payment_options?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/payment_options?page[number]=14&page[size]=10"
}
}
Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of payment options can be sorted by the following fields:
Attributes
Relationships
Filterable fields
The list of payment options can be filtered by the following fields:
Attributes
Relationships