Sign in

v1

latestOpenAPI 3.0.02026-07-2431146358.7 KB
Card Account

Retrieve Card Account

Retrieve details of a cardaccount either by using the mercid and cardaccountid or the mercid, orderid and customer_refid as inputs.

post/tokenizer/ve1_2/token/retrieve

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

cardaccountidstring

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

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

orderidstring

Unique ID generated by the merchant for each request

Example request

{
  "mercid": "BDMERCID",
  "cardaccountid": "CA0AAEF9000000000123",
  "customer_refid": "CSREF00001",
  "orderid": "TEST0000009005"
}

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

statusstring
coft_consentstring
createdonstring date-time

object creation timestamp

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"
  }
}