API Reference

Create a card

post
https://api.stage.payouts.com/issuing/cards/create

Required permissions for this API:

  • WRITE:FINANCE
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

Set this to true to activate the physical card when it is created. This will enable use of the card while it’s being delivered to the cardholder. Virtual cards will always be activated upon creation.

additionalCardholderIds
array of strings

The IDs of additional cardholders to associate this card with.

additionalCardholderIds
authorizationControls
object
required

Spend controls that determine the rules and restrictions to check for transaction authorizations.

string

Scheme for Issuance. Default VISA.

string
required
Defaults to 7f687fe6-dcf4-4462-92fa-80335301d9d2

The ID of the cardholder to associate this card with.

string

Client data which will be stored against the card record.

string
required
Defaults to John Smith

Full legal name of user requesting new card

string
enum
required
Defaults to VIRTUAL

Form of the card - PHYSICAL or VIRTUAL

Allowed:
string

A unique identifier that links a card to its designated funding source. This ID determines which funding source will be accessed for the deduction of funds during transactions. The funding_source_id can be retrieved from the client's account manager. If funding_source_id is not provided, the default funding source would be the account's wallet.

boolean
required
Defaults to false

Determines whether the card should be assigned to a singular individual or to the business with multiple cardholders who are authorized to use the card. Note - only personalized cards can be created as physical and added to digital wallet providers.

metadata
object

A set of key-value pairs that can be attached to the Card. You can specify up to 20 keys, with key names up to 20 characters long and values up to 150 characters long.

string

A nick name for the card.

string

Notes that are to be stored against the card request (for client reference).

postalAddress
object

Optional postal address of physical card delivery. The card will be issued to the cardholder's postal address if this value is not set. The cardholder's address will be used instead if cardholder's postal address does not exist.

program
object
required

Card program

string
enum
Defaults to BUSINESS_EXPENSES

Optional purpose for card's usage when card issueTo is ORGANISATION.

string
required
Defaults to 7f687fe6-dcf4-4462-92fa-80335301d9d2

A unique request ID specified by the client. Requests with the same request_id will be ignored. This allows requests to be replayed if client is unsure of the outcome, e.g. due to network issues, system failures, etc. Note: Can be non-UUID as long as it is unique between requests.

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?