Create Card

post

https://merchant.cop-staging.straitsx.com/api/v1/issuing_plans/{issuing_plan_opaque_id}/users/{customer_opaque_id}/cards

Create a card for a user. Note you need to create a user first before calling this endpoint

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

To understand the difference between cardholder_name & [first_name ,middle_name ,surname], please reference here in the FAQ section
For PCI DSS certified merchant, please refer to Encrypted SAD to learn more about the encryption algorithm and details.
This endpoint supports idempotent requests to prevent duplicate card creation caused by network timeouts or retries.
- Usage:
  - Include an Idempotency-Key header in your request. The key must be 256 characters or fewer.
  - If the same key is used within 24 hours, the API will return the original response without creating a new card.
- Response Behavior:
  - When a request is replayed, the response header will include Idempotency-Replayed: true.
  - The response body will be identical to the original request's response.

Path Params

issuing_plan_opaque_id

string

required

Issuing Plan Opaque ID

customer_opaque_id

string

required

User Opaque ID

Query Params

show_encrypted_card_number

boolean

Defaults to false

Set to true to show the encrypted card number in the response. Requires you to be PCI DSS certified

show_encrypted_cvv

boolean

Defaults to false

Set to true to show the encrypted cvv in the response. Requires you to be PCI DSS certified. Currently this will only work if the contract product that you provide is a virtual type

Body Params

card_product_opaque_id

string

required

Card Product Opaque ID

cardholder_name

string

required

This field will be used as the embossed name on the printed card if the contract product type is physical (including physical and digital cards). Must have a-z characters or space, dash,
and period (.) characters only. Length must be at least 2 and be no greater than 26.

cardholder_first_name

string

required

cardholder first name. must have a-z characters or space, dash, and period (.) characters only. Note: combined length of cardholder_surname/cardholder_first_name (including the "/" separator) must be at least 2 and be no greater than 26.

cardholder_second_name

string

cardholder second name (optional). must have a-z characters or space, dash, and period (.) characters only.

cardholder_surname

string

required

cardholder surname. must have a-z characters or space, dash, and period (.) characters only. Note: combined length of cardholder_surname/cardholder_first_name (including the "/" separator) must be at least 2 and be no greater than 26.

contact_number

string

required

cardholder contact number
Using google libphonenumber to validate. Please refer to here for quick verification

funding_source

string

enum

required

one of=remote-host, xfers, xfers-wallet, fazzbiz, paymentcore
cardholder funding source. use remote-host for Remote Host Card. Consult with the Card Issuing team to determine what information to include in this payload.

Allowed:

card_is_primary

boolean

optional. flag to determine if the card is the primary card

account_currency

string

enum

optional, one of=SGD, USD
The currency that will be used during transaction time
If no currency is specified, SGD will be assumed for the transaction.

Allowed:

address

object

required

address object. all address must not contains <, >, &, ', ", {, }, :, ;, = character. Latin symbols are not allowed (ex: àếủàộệ)

card_art_opaque_id

string

Custom Card Art Opaque ID. If this is omitted, default card art will be used for provisioning. Card creation will be failed if you insert incorrect custom card art opaque id.

stock_keeping_code

string

optional field with max length validation of 12, only applicable for the available physical pool product

last_four_digits

string

optional. Last four digits of the card number. Length must be exactly 4. Only applicable for merchants that have the pick last four digit feature enabled.

Headers

Idempotency-Key

string

Optional. A unique key to ensure idempotent card creation.
Max 256 characters
TTL: 24 hours

Responses

200200

400400