Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Cards

Create customer card

Store a card against a customer for use in later stored-card payments. If the customer already has an active card with the same holder name and card number, the existing card is returned with any updates from your request.

post/customers/{customer_id}/cards

Path parameters

customer_idstring uuid required

Unique ID assigned by Acquired.com for the customer.

Request body

holder_namestring required

The name of the cardholder.

scheme'visa' | 'mastercard' | 'amex'

The scheme the card belongs to.

numberstring required

The card number.

expiry_monthinteger required

The month the card expires in.

expiry_yearinteger required

The year the card expires in.

cvvstring

The 3 or 4-digit security code that appears on the card.

scheme_reference_datastring

Scheme reference data from a prior successful transaction on the same card. Visa values are 15 digits; Mastercard values are 13 alphanumeric characters.

source'card' | 'apple_pay' | 'google_pay'

Identifies how the card was created.

Example request

{
  "holder_name": "E Johnson",
  "scheme": "visa",
  "number": "4000011180138710",
  "expiry_month": 10,
  "expiry_year": 30,
  "cvv": "123",
  "scheme_reference_data": "123456789012345",
  "source": "card"
}

Response

OK - the customer already has a card with the same holder name and card number. The existing card_id is returned and any new details from your request are saved to the stored card.

card_idstring uuid

Unique identifier of the existing card.

Example response

{
  "card_id": "a7e3fde5-5b83-44f4-9915-782bc7121717"
}