Create a new virtual or physical card

post https://example.com/cards

A POST request sent to create a card. Prior to create a card, the user must have completed KyC and verified his wallet. Cards can have different designs setup during onboarding. If no designId is specified in the request, and a default designId has been specified during setup of the card program, the default will be used. If there is no designId neither in the request nor a default specified, an error response will be returned.

Body Params

Card object that needs to be created/issued for a card owner.

type

string

required

The card's type that will be issued:

physical - A physical card (plastic/metal) will get issued and shipped to the card holder. It is usable at physical terminals and, if it has a long number on it, also online. Only one physical card can be active at a given moment.
virtual - A virtual card will get issued and activated immediately. Only one virtual card can be active at a given moment.

userId

string

required

A User identifier. Begins with 'usr-' followed by a v4 UUID

designId

string

A Design identifier. Begins with 'dsn-' followed by a v4 UUID. If a value is not supplied, a default value will be used which will be pre-agreed on during setup.

customerType

string

The customer type.

tier

string

The card tier.

currencyCode

string

required

Defaults to USD

The currency for the card. Three-character ISO 4217 currency code.

reissueFromCard

object

This field, if filled, indicates this card should replace the designated card. The new card inherits the long number (PAN) and, if applicable, the personal identification number (PIN). The new card will have a fresh expiration date and a different CVV2 number. Only virtual and physical cards should ever need reissuing. Digital cards are tokenized and so they do not have a PAN and PIN to be preserved, and hence can simply be revoked and a new token issued.

deliveryType

string

The delivery type when ordering a physical card (do not set for virtual ones):

ship_to_user - Cards will get shipped directly to the user using a courier service.

Responses

400

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

403

The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.

429

The user has sent too many requests in a given amount of time ("rate limiting").

500

The server has encountered a situation it does not know how to handle.

502

This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.

503

The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded.

504

This error response is given when the server is acting as a gateway and cannot get a response in time.

Language

Credentials

Header


xxxxxxxxxx
10
1
const options = {
2
  method: 'POST',
3
  headers: {accept: 'application/json', 'content-type': 'application/json'},
4
  body: JSON.stringify({type: 'physical', currencyCode: 'USD'})
5
};
6
7
fetch('https://example.com/cards', options)
8
  .then(res => res.json())
9
  .then(res => console.log(res))
10
  .catch(err => console.error(err));

Choose an example:

application/json

201Card created successfully