Create a payment instrument

post /paymentInstruments

Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.

For more information, refer to Issue cards or Issue business accounts.

Endpoint destination URL
Click to copy

Request parameters

balanceAccountId string Required

The unique identifier of the balance account associated with the payment instrument.

card object

Contains information about the card. Required when you create a payment instrument of type card.

description string
Max length: 300

Your description for the payment instrument, maximum 300 characters.

issuingCountryCode string Required

The two-character ISO 3166-1 alpha-2 country code where the payment instrument is issued. For example, NL or US.

paymentInstrumentGroupId string

The unique identifier of the payment instrument group to which the payment instrument belongs.

reference string
Max length: 150

Your reference for the payment instrument, maximum 150 characters.

status string

The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to active by default. However, there can be exceptions for cards based on the card.formFactor and the issuingCountryCode. For example, when issuing physical cards in the US, the default status is inactive.

Possible values:

  • active: The payment instrument is active and can be used to make payments.

  • inactive: The payment instrument is inactive and cannot be used to make payments.

  • suspended: The payment instrument is suspended, either because it was stolen or lost.

  • closed: The payment instrument is permanently closed. This action cannot be undone.

statusReason string

The reason for the status of the payment instrument.

Possible values: accountClosure, damaged, endOfLife, expired, lost, stolen, suspectedFraud, transactionRule, other. If the reason is other, you must also send the statusComment parameter describing the status change.

type string Required

Type of payment instrument.

Possible value: card, bankAccount.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy