Customer Payment Sources

Customer payment sources are association models that link customers to credit cards. During checkout, a logged customer can retrieve their saved cards and use them to pay the order.

The customer payment source object

A customer payment source object is returned as part of the response body of each successful create, list, retrieve or update API call. The following table contains the list of all its fields along with their type, description and example values.
Object fields:
name
string
Returns the associated payment source's name
Example:
XXXX-XXXX-XXXX-1111
id
integer
Unique identifier for the resource.
Example:
1234
created_at
datetime
Time at which the resource was created.
Example:
2018-01-01T12:00:00.000Z
updated_at
datetime
Time at which the resource was last updated.
Example:
2018-01-01T12:00:00.000Z
reference
string
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
relationship (N:1)
The associated customer.
payment_source
relationship (N:1)
The associated payment source (i.e. credit card).

Create a customer payment source

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. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.
Arguments:
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
#
required
The associated customer.
payment_source
required
The associated payment source (i.e. credit card).
Example request:
POST /api/customer_payment_sources HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "customer_payment_sources",
    "relationships": {
      "customer": {
        "data": {
          "type": "customers",
          "id": "1234"
        }
      },
      "payment_source": {
        "data": {
          "type": "payment_sources",
          "id": "1234"
        }
      }
    }
  }
}
Example response: 201 Created
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "customer_payment_sources",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234"
    },
    "attributes": {
      "name": "XXXX-XXXX-XXXX-1111",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/customer",
          "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/customer"
        }
      },
      "payment_source": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/payment_source",
          "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/payment_source"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all customer payment sources

To fetch a collection of customer payment sources, send a GET request to the /api/customer_payment_sources endpoint.

Example request:
GET /api/customer_payment_sources HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "1234",
      "type": "customer_payment_sources",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234"
      },
      "attributes": {
        "name": "XXXX-XXXX-XXXX-1111",
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "customer": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/customer",
            "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/customer"
          }
        },
        "payment_source": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/payment_source",
            "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/payment_source"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 customer_payment_sources (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/customer_payment_sources?page[number]=1&page[size]=25",
    "prev": "/api/customer_payment_sources?page[number]=2&page[size]=25",
    "next": "/api/customer_payment_sources?page[number]=4&page[size]=25",
    "last": "/api/customer_payment_sources?page[number]=5&page[size]=25"
  }
}
Available filters
idreferencecustomer_ididscreated_at_fromcreated_at_toupdated_at_fromupdated_at_to
Sortable attributes
idcreated_atupdated_atreference

Retrieve a customer payment source

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.
Example request:
GET /api/customer_payment_sources/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "customer_payment_sources",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234"
    },
    "attributes": {
      "name": "XXXX-XXXX-XXXX-1111",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/customer",
          "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/customer"
        }
      },
      "payment_source": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/payment_source",
          "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/payment_source"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a customer payment source

To update an existing customer payment source, send a PATCH request to the /api/customer_payment_sources/{{id}} endpoint, where {{id}} is the id of the resource that you want to update. The following table contains the list of all the possible arguments that you can pass with the request body, along with their type, description and examples values. Please note that all arguments are optional.
Arguments:
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
#
optional
The associated customer.
payment_source
optional
The associated payment source (i.e. credit card).
Example request:
PATCH /api/customer_payment_sources/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "customer_payment_sources",
    "id": 1234,
    "attributes": {
      "reference": "ANYREFEFERNCE"
    },
    "relationships": {
    }
  }
}
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "customer_payment_sources",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234"
    },
    "attributes": {
      "name": "XXXX-XXXX-XXXX-1111",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "customer": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/customer",
          "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/customer"
        }
      },
      "payment_source": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/relationships/payment_source",
          "related": "https://your-brand.commercelayer.io/api/customer_payment_sources/1234/payment_source"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a customer payment source

To delete a customer payment source, send a DELETE request to the /api/customer_payment_sources/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.
Example request:
DELETE /api/customer_payment_sources/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 204 No Content
HTTP/1.1 204 No Content

Get our machine-readable JSON schema that follows the OpenAPI Specification (formerly Swagger).

Get our Postman collection in one click and start making real calls to Commerce Layer API in minutes.

Get in touch with our support team if you have any questions or want to learn more about Commerce Layer.