Retrieve a payment option
How to fetch a specific payment option via API
Request
Example
curl -g -X GET \
'https://yourdomain.commercelayer.io/api/payment_options/XAyRWNUzyN' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token'{
"data": {
"id": "XAyRWNUzyN",
"type": "payment_options",
"links": {
"self": "https://yourdomain.commercelayer.io/api/payment_options/XAyRWNUzyN"
},
"attributes": {
"name": "Stripe Payment Option",
"payment_source_type": "stripe_payments",
"data": {
"application_fee_amount": 1000,
"on_behalf_of": "pm_xxx"
},
"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/payment_options/XAyRWNUzyN/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/payment_options/XAyRWNUzyN/order"
}
},
"attachments": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/payment_options/XAyRWNUzyN/relationships/attachments",
"related": "https://yourdomain.commercelayer.io/api/payment_options/XAyRWNUzyN/attachments"
}
},
"event_stores": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/payment_options/XAyRWNUzyN/relationships/event_stores",
"related": "https://yourdomain.commercelayer.io/api/payment_options/XAyRWNUzyN/event_stores"
}
}
},
"meta": {
"mode": "test",
"organization_id": "xRRkjDFafe",
"trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
}
}
}Last updated