Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Card Account

Create Card Account

A card account (or card token) can be created by providing the card details and a customer reference.

The API will provide a cardaccount object as a response, with a unique cardaccountid, that can be used to initiate a transaction.

post/tokenizer/ve1_2/token/create

Headers

BD-Traceidstring required
Example:20201203182838

BD-TraceID is a unique identifier passed by the merchant to ensure request idempotency. Requests with identical BD-TraceID within a 24 hour window would fail.

BD-Timestampstring required
Example:20201203182838

Request timestamp to identify date and time of origin of request. Example, a value of BD-Timestamp 20210113180403 identifies the request to have originated on 13th January 2021 at 06:04:03 PM.

Content-Typestring required
Example:application/json

Request Content-Type to take the values application/jose

Acceptstring required
Example:application/jose

Accept Response Content-Type to take the values application/jose

Request body

mercidstring required

Unique identifier as defined by BillDesk for each merchant

orderidstring required

Unique ID generated by the merchant for each request

customer_refidstring required

Unique reference of the customer in the merchant system, and can be linked to different subscriptions of the same customer Required for mandate and tokenization

coft_consentstring required

Example request

{
  "mercid": "BDMERCID",
  "orderid": "TEST0000009005",
  "customer_refid": "CSREF00001",
  "card": {
    "number": "4242420000001234",
    "expiry_month": "02",
    "expiry_year": "2029",
    "holder_name": "John Doe",
    "cvv": "123"
  },
  "authentication_data": {
    "transactionid": "U4560001099939",
    "authenticationid": "A1HM0000389872",
    "ds_transaction_id": "9ae6259e-08b8-42bb97a2-48d8a1d2a690"
  }
}

Response

OK

objectid'transaction' | 'authentication' | 'mandate' | 'invoice' | 'cardaccount' | 'validatevpa' | 'dispute' | 'settlement' | 'altid' | 'mandate_token' | 'accountvalidation'

String representing the object's type. Objects of the same type share the same value.

mercidstring

Unique identifier as defined by BillDesk for each merchant

customer_refidstring

Unique reference of the customer in the merchant system, and can be linked to different subscriptions of the same customer Required for mandate and tokenization

cardaccountidstring

Unique ID created by BillDesk for the combination of card number, mercid and customer_refid

orderidstring

Unique ID generated by the merchant for each request

masked_valuestring

Masked card number, with the last four digits

holder_namestring

Cardholder name

issuerstring

Card issuer

networkstring

Card Network

cardaccount_statusstring
coft_consentstring
createdonstring date-time

object creation timestamp

cardaccount_error_codestring

Represents the error code for the response

cardaccount_error_typestring

Represents the error type for the response

cardaccount_error_descstring

Represents the error description for the response

Example response

{
  "mercid": "BDMERCID",
  "customer_refid": "CSREF00001",
  "cardaccountid": "CA0AAEF9000000000123",
  "orderid": "TEST0000009005",
  "masked_value": "xxxxxxxxxxxx1001",
  "network": "VISA, MASTER",
  "network_token": {
    "token_ref_no": "0f276cf3-a251-4f49-9567-da12ba9e028a",
    "status": "ACTIVE"
  },
  "issuer token": {
    "token_ref_no": "0f276cf3-a251-4f49-9567-da12ba9e028a",
    "status": "ACTIVE"
  }
}