Skip to main content

Card creation endpoint

POST 

/v1/cards

Required States: ACTIVE

This endpoint creates a card instance if the following conditions are satisfied:

  • Party is in a relevant state ACTIVE
  • Party has a valid account that is ACTIVE
  • Party has not reached the maximum number of cards allowed for the product
  • The selected card type is allowed for the product
  • The account product is mapped to the requesting client/brand

This method creates a card instance against the nominated account. The account must be in ACTIVE state and is subject to restrictions imposed by the underlying card provider and product configuration.

Card Types:

  • PHYSICAL - A physical card will be created and sent to the party.
  • VIRTUAL - A virtual card will be created and made available for the party to use.
  • PHYSICAL_AND_VIRTUAL - A physical card will be created and sent to the party, and a virtual card will be created and made available for the party to use.

Dependent on the card type, the card will be created in the following states:

  • PHYSICAL: The card will be created in a NEW state, and be visible in the card listing after it has been submitted to the provider for provisioning.
  • VIRTUAL: The card will be created in a ACTIVE state
  • PHYSICAL_AND_VIRTUAL: The card will be created in a ACTIVE state

Request

Responses

Created