Create Card

POST 
/api/cards

Create a card under a specified card program and affiliated with a Funding Source. Returns an ID with which to retrieve card details.

Request

application/json

Body

required

cardProgramId stringrequired

ID of card program to use when creating a card

fundingSourceId stringrequired

ID of the Funding Source the card will authorize against

Responses

200

Successful operation

application/json

Schema

Schema

cardId string

The created card ID

Example (from schema)

{
  "cardId": "string"
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

403

User is not allowed to perform the action with the reason stated in the message

FORBIDDEN Insufficient permissions to perform the action.

LIVENESS_MISMATCH Card program or cardholder have the wrong liveness for the request.

CARD_PROGRAM_INVALID Card program does not belong to a partner this cardholder is associated with.

FUNDING_SOURCE_INVALID Funding source cannot be used with this card program.

KYC_REQUIRED KYC profile is missing, does not have PASSED status, or does not match card program region. Use the spending prerequisites endpoint for more details.

CONTACT_EMAIL_REQUIRED Cardholder does not have a contact phone.

CONTACT_PHONE_REQUIRED Cardholder does not have a contact email.

AML_CHECK_FAILED AML check failed.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...