API Reference

Create Card for Customer

post
http://localhost:8080/v0/cards/create
Body Params
uuid
required

Unique identifier (UUID) of the Account

string
enum

Card design, applicable to multiple Card designs for product. Mapping of designs will be provided. Possible values:

  • SUB_DESIGN_1 (default if not provided)
  • SUB_DESIGN_2
  • SUB_DESIGN_3
  • SUB_DESIGN_4
  • SUB_DESIGN_5
  • SUB_DESIGN_6
  • SUB_DESIGN_7
  • SUB_DESIGN_8
  • SUB_DESIGN_9
  • SUB_DESIGN_10
  • SUB_DESIGN_...
  • SUB_DESIGN_...
  • SUB_DESIGN_100
string
enum

Type of card to create. Can convert virtual to physical card at a later time:

  • PHYSICAL (default if not provided)
  • VIRTUAL
Allowed:
uuid
required

Unique identifier (UUID) of the Customer (cardholder)

deliveryAddress
object
required

Card delivery address.

string
enum

Card delivery method. Possible values:

  • STANDARD (default if not provided)
  • REGISTERED
  • COURIER
  • EXPRESS
Allowed:
string
required
length ≥ 1

Email address of the Customer

string
required
length ≥ 1

First name of the Customer

uuid
required

Unique value (UUID) used to identify this request and used to recognise any subsequent retries

string
required
length ≥ 1

Last name of the Customer

string
length between 0 and 23

Cardholder name as printed on the Card

string
length between 0 and 23

Additional line printed on the Card along side nameOnCard

phoneNumber
object
required

Phone number of the cardholder

string
required
length ≥ 1

Card PIN, typically 4 digits but supports 4-12 digits

string

Title of the Customer

Responses

Updated 11 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 months ago