Links

Create a customer payment source

How to create a customer payment source via API
To create a new customer payment source, send a POST request to the /api/customer_payment_sources endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/customer_payment_sources

Arguments

Body Parameter
Type
Required
type
string
Required
attributes.customer_token
string
Optional
attributes.payment_source_token
string
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.customer
object
Required
relationships.payment_method
object
Optional
relationships.payment_source
object
Optional

Example

Request
Response
The following request creates a new customer payment source:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/customer_payment_sources' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "customer_payment_sources",
"relationships": {
"customer": {
"data": {
"type": "customers",
"id": "ABCRtyUpBa"
}
}
}
}
}'
On success, the API responds with a 201 Created status code, returning the created resource object:
{
"data": {
"id": "xYZkjABcde",
"type": "customer_payment_sources",
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde"
},
"attributes": {
"name": "XXXX-XXXX-XXXX-1111",
"customer_token": "cus_xxxyyyzzz",
"payment_source_token": "pm_xxxyyyzzz",
"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": {
"customer": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/relationships/customer",
"related": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/customer"
}
},
"payment_method": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/relationships/payment_method",
"related": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/payment_method"
}
},
"payment_source": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/relationships/payment_source",
"related": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/payment_source"
}
},
"versions": {
"links": {
"self": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/relationships/versions",
"related": "https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde/versions"
}
}
},
"meta": {
"mode": "test"
}
}
}