Retrieve a customer payment source How to fetch a specific customer payment source via API
To fetch a single customer payment source, send a GET
request to the /api/customer_payment_sources/:id
endpoint, where id
is the ID of the resource that you want to retrieve.
Request
GET https://yourdomain.commercelayer.io/api/customer_payment_sources/:id
Example
Request Response
The following request fetches the customer payment source identified by the id "xYZkjABcde":
Copy curl -g -X GET \
'https://yourdomain.commercelayer.io/api/customer_payment_sources/xYZkjABcde' \
-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 single resource object:
Copy {
"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"
}
}
}