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 ParameterTypeRequired

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

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"
        }
      }
    }
  }
}'

Last updated