Skip to main content

Create a payment instrument

Creates and activates a new payment instrument resource by saving a payment card for an identified customer. Implement to improve customer experience by skipping the step of entering payment instrument details.

The token created via this endpoint can not be used for recurring payments by merchants operating within the EU. For more information visit our recurring payments guide.

Request Body
  • type string required

    Possible values: [card]

    Type of the payment instrument.

  • card object required

    Required when payment type is card. Details of the payment card.

  • name string required

    Name of the cardholder as it appears on the payment card.

  • number string required

    Number of the payment card (without spaces).

  • expiry_year string required

    Possible values: >= 2 characters and <= 4 characters

    Year from the expiration time of the payment card. Accepted formats are YY and YYYY.

  • expiry_month string required

    Possible values: [01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12]

    Month from the expiration time of the payment card. Accepted format is MM.

  • cvv string required

    Possible values: >= 3 characters and <= 4 characters

    Three or four-digit card verification value (security code) of the payment card.

  • zip_code string

    Possible values: >= 5 characters and <= 5 characters

    Required five-digit ZIP code. Applicable only to merchant users in the USA.

Responses

Created


Schema
  • token string

    Unique token identifying the saved payment card for a customer.

  • active boolean

    Default value: true

    Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a DELETE request to the resource endpoint.

  • type string

    Possible values: [card]

    Type of the payment instrument.

  • card object

    Details of the payment card.

  • last_4_digits string

    Possible values: >= 4 characters and <= 4 characters

    Last 4 digits of the payment card number.

  • type string

    Possible values: [AMEX, CUP, DINERS, DISCOVER, ELO, ELV, HIPERCARD, JCB, MAESTRO, MASTERCARD, VISA, VISA_ELECTRON, VISA_VPAY, UNKNOWN]

    Issuing card network of the payment card.

  • mandate object

    Created mandate

  • type string

    Indicates the mandate type

  • status string

    Mandate status

  • merchant_code string

    Merchant code which has the mandate

  • created_at date-time

    Creation date of payment instrument. Response format expressed according to <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank" rel="noopener">ISO8601</a> code.