Comment on page
Create an external payment
How to create an external payment via API
To create a new external payment, send a
POST request to the /api/external_payments endpoint, passing the resource arguments in the request body.POST https://yourdomain.commercelayer.io/api/external_payments
Body Parameter | Type | Required |
|---|---|---|
type | string | Required |
attributes.payment_source_token | string | Required |
attributes.options | object | Optional |
attributes.reference | string | Optional |
attributes.reference_origin | string | Optional |
attributes.metadata | object | Optional |
relationships.order | object | Required |
Request
Response
The following request creates a new external payment:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/external_payments' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "external_payments",
"attributes": {
"payment_source_token": "xxxx.yyyy.zzzz"
},
"relationships": {
"order": {
"data": {
"type": "orders",
"id": "ABCRtyUpBa"
}
}
}
}
}'
On success, the API responds with a
201 Created status code, returning the created resource object:{
"data": {
"id": "xYZkjABcde",
"type": "external_payments",
"links": {
"self": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde"
},
"attributes": {
"payment_source_token": "xxxx.yyyy.zzzz",
"options": {
"foo": "bar"
},
"payment_instrument": {
"issuer_type": "external_payment",
"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/external_payments/xYZkjABcde/relationships/order",
"related": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/order"
}
},
"payment_gateway": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/relationships/payment_gateway",
"related": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/payment_gateway"
}
},
"wallet": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/relationships/wallet",
"related": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/wallet"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/external_payments/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}
Last modified 3mo ago