List all satispay payments
How to fetch a collection of satispay payments via API
To fetch a collection of satispay payments, send a
GET
request to the /api/satispay_payments
endpoint.GET https://yourdomain.commercelayer.io/api/satispay_payments
Request
Response
The following request fetches a collection of satispay payments:
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/satispay_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": "satispay_payments",
"links": {
"self": "https://yourdomain.commercelayer.io/api/satispay_payments/xYZkjABcde"
},
"attributes": {
"payment_id": "xxxx-yyyy-zzzz",
"flow": "MATCH_CODE",
"status": "PENDING",
"redirect_url": "http://commercelayer.dev/satispay/redirect",
"payment_url": "https://online.satispay.com/pay/xxxx-yyyy-zzzz?redirect_url={redirect_url}",
"intent_amount_cents": 1000,
"intent_amount_float": 10.0,
"formatted_intent_amount": "€10,00",
"payment_response": {
"foo": "bar"
},
"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/satispay_payments/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/satispay_payments/xYZkjABcde/order"
}
},
"payment_gateway": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/satispay_payments/xYZkjABcde/relationships/payment_gateway",
"related": "https://yourdomain.commercelayer.io/api/satispay_payments/xYZkjABcde/payment_gateway"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/satispay_payments/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/satispay_payments/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
},
{
"other": "... 9 satispay_payments (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://yourdomain.commercelayer.io/api/satispay_payments?page[number]=1&page[size]=10",
"next": "https://yourdomain.commercelayer.io/api/satispay_payments?page[number]=2&page[size]=10",
"last": "https://yourdomain.commercelayer.io/api/satispay_payments?page[number]=14&page[size]=10"
}
}
flow
status
id
created_at
updated_at
reference
reference_origin
id
created_at
updated_at
reference
reference_origin
order
payment_gateway
versions
Last modified 23d ago