Version: 1.0.2

Add a Virtual Card

Issing virtual card to an existing card holder.

Method: POST

{{URL}}/cardv2

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameters	Description
reference Optional	String Unique reference ID of the request Sample Value: "S9KA2033332314"
transactionType Mandatory	String Type of operation / transaction Constant Value: "ADD_CARD"
customerId Mandatory	String Unique ID of customer who holds the card Sample Value: "100000000033002"
accountNumber Mandatory	String Account number linked to the card Sample Value: "210199823931012"
product Mandatory	String Name of the product associated with the card Sample Value: "DEFAULT"
channel Mandatory	Enum Processing channel through which the card transaction happens Valid Values: PULSE VISA_DPS Sample Value: "VISA_DPS"
program Mandatory	String Name of the program to which the card product is mapped Sample Value: "DEFAULT"
card	Object
cardHolderId Mandatory	String Unique id of the card holder Sample value: "CH00000000019001"
cardType Mandatory	String Card type is virutal, by default Sample Value: "VIRTUAL "
expiryYear Mandatory	String Expiration year set to the card Sample Value: "2024 "
expiryMonth Mandatory	String Expiration month set to the card Sample Value: "11 "
cardLimit Conditional Mandatory (If ‘singleUseCard' value is ‘ YES', the field is mandatory)	String Transaction limit of the card Sample Value: "100 "
singleUseCard Conditional Mandatory (If the value is ‘ YES', the field is mandatory)	Enum Whether card is for single use or multiple use Valid Values: Yes - SingleUseCard – Card is used for single transaction within configured card limit No – MultiUse Card - Card can be used for multiple transactions within configured card limit daily/monthly/yearly/lifetime Sample Value: "YES "
cardName Optional	String Name given to the card Sample Value: "DEMOCARD "
countryGroupId Optional	String Card is restricted for specific countries Sample Value: ""
mccGroupId Optional	String Card is restricted for specific types of merchants Sample Value: ""
lockCardAcceptor Optional	Enum Whether card is restricted to specific card acceptor or not, which is depending upon the given value Valid Values: DEFAULT – takes the value (YES or NO) given by admin YES – card is restricted to specific card acceptor NO – card is not restricted to specific card acceptor Sample Value: "DEFAULT "

Parameters

Description

reference

Optional

String

Unique reference ID of the request

Sample Value: "S9KA2033332314"

transactionType

Mandatory

String

Type of operation / transaction

Constant Value: "ADD_CARD"

customerId

Mandatory

String

Unique ID of customer who holds the card

Sample Value: "100000000033002"

accountNumber

Mandatory

String

Account number linked to the card

Sample Value: "210199823931012"

product

Mandatory

String

Name of the product associated with the card

Sample Value: "DEFAULT"

channel

Mandatory

Enum

Processing channel through which the card transaction happens

Valid Values:

PULSE

VISA_DPS

Sample Value: "VISA_DPS"

program

Mandatory

String

Name of the program to which the card product is mapped

Sample Value: "DEFAULT"

card

Object

cardHolderId

Mandatory

String

Unique id of the card holder

Sample value: "CH00000000019001"

cardType

Mandatory

String

Card type is virutal, by default

Sample Value: "VIRTUAL "

expiryYear

Mandatory

String

Expiration year set to the card

Sample Value: "2024 "

expiryMonth

Mandatory

String

Expiration month set to the card

Sample Value: "11 "

cardLimit

Conditional Mandatory

(If ‘singleUseCard' value is ‘ YES', the field is mandatory)

String

Transaction limit of the card

Sample Value: "100 "

singleUseCard

Conditional Mandatory

(If the value is ‘ YES', the field is mandatory)

Enum

Whether card is for single use or multiple use

Valid Values:

Yes - SingleUseCard – Card is used for single transaction within configured card limit

No – MultiUse Card - Card can be used for multiple transactions within configured card limit daily/monthly/yearly/lifetime

Sample Value: "YES "

cardName

Optional

String

Name given to the card

Sample Value: "DEMOCARD "

countryGroupId

Optional

String

Card is restricted for specific countries

Sample Value: ""

mccGroupId

Optional

String

Card is restricted for specific types of merchants

Sample Value: ""

lockCardAcceptor

Optional

Enum

Whether card is restricted to specific card acceptor or not, which is depending upon the given value

Valid Values:

DEFAULT – takes the value (YES or NO) given by admin

YES – card is restricted to specific card acceptor

NO – card is not restricted to specific card acceptor

Sample Value: "DEFAULT "

cURL
C#
Go
NodeJs

curl --location --globoff --request GET '{{URL}}/cardv2' \
--header 'Content-Type: application/json' \
--data '{"method":"ledger.CARD.request","id":"1","params":{"payload":{"reference":"S9KA2033332314","transactionType":"ADD_CARD","customerId":"100000000033002","accountNumber":"210199823931012","product":"DEFAULT","channel":"VISA_DPS","program":"DEFAULT","card":{"cardHolderId":"CH00000000019001","cardType":"VIRTUAL","expiryYear":"2024","expiryMonth":"11","cardLimit":"100","singleUseCard":"YES","cardName":"DEMOCARD","countryGroupId":"","mccGroupId":"","lockCardAcceptor":"DEFAULT"}},"api":{"signature":"{{signature}}","apiKey":"{{Api-key}}","credential":"{{cred}}"}}}'

using System;
using RestSharp;
using System.Threading;
using System.Threading.Tasks;
namespace HelloWorldApplication {
  class HelloWorld {
    static async Task Main(string[] args) {
      var options = new RestClientOptions("{{URL}}/cardv2")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""ledger.CARD.request"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""reference"": ""S9KA2033332314"",
" + "\n" +
@"            ""transactionType"": ""ADD_CARD"",
" + "\n" +
@"            ""customerId"": ""100000000033002"",
" + "\n" +
@"            ""accountNumber"": ""210199823931012"",
" + "\n" +
@"            ""product"": ""DEFAULT"",
" + "\n" +
@"            ""channel"": ""VISA_DPS"",
" + "\n" +
@"            ""program"": ""DEFAULT"",
" + "\n" +
@"            ""card"": {
" + "\n" +
@"                ""cardHolderId"": ""CH00000000019001"",
" + "\n" +
@"                ""cardType"": ""VIRTUAL"",
" + "\n" +
@"                ""expiryYear"": ""2024"",
" + "\n" +
@"                ""expiryMonth"": ""11"",
" + "\n" +
@"                ""cardLimit"": ""100"",
" + "\n" +
@"                ""singleUseCard"": ""YES"",
" + "\n" +
@"                ""cardName"": ""DEMOCARD"",
" + "\n" +
@"                ""countryGroupId"": """",
" + "\n" +
@"                ""mccGroupId"": """",
" + "\n" +
@"                ""lockCardAcceptor"": ""DEFAULT""
" + "\n" +
@"            }
" + "\n" +
@"        },
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""apiKey"": ""{{Api-key}}"",
" + "\n" +
@"            ""credential"": ""{{cred}}""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
    }
  }
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{URL}}/cardv2"
  method := "GET"

  payload := strings.NewReader(`{`+"
"+`
    "method": "ledger.CARD.request",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "payload": {`+"
"+`
            "reference": "S9KA2033332314",`+"
"+`
            "transactionType": "ADD_CARD",`+"
"+`
            "customerId": "100000000033002",`+"
"+`
            "accountNumber": "210199823931012",`+"
"+`
            "product": "DEFAULT",`+"
"+`
            "channel": "VISA_DPS",`+"
"+`
            "program": "DEFAULT",`+"
"+`
            "card": {`+"
"+`
                "cardHolderId": "CH00000000019001",`+"
"+`
                "cardType": "VIRTUAL",`+"
"+`
                "expiryYear": "2024",`+"
"+`
                "expiryMonth": "11",`+"
"+`
                "cardLimit": "100",`+"
"+`
                "singleUseCard": "YES",`+"
"+`
                "cardName": "DEMOCARD",`+"
"+`
                "countryGroupId": "",`+"
"+`
                "mccGroupId": "",`+"
"+`
                "lockCardAcceptor": "DEFAULT"`+"
"+`
            }`+"
"+`
        },`+"
"+`
        "api": {`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "apiKey": "{{Api-key}}",`+"
"+`
            "credential": "{{cred}}"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': '{{URL}}',
  'path': '/cardv2',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ledger.CARD.request",
  "id": "1",
  "params": {
    "payload": {
      "reference": "S9KA2033332314",
      "transactionType": "ADD_CARD",
      "customerId": "100000000033002",
      "accountNumber": "210199823931012",
      "product": "DEFAULT",
      "channel": "VISA_DPS",
      "program": "DEFAULT",
      "card": {
        "cardHolderId": "CH00000000019001",
        "cardType": "VIRTUAL",
        "expiryYear": "2024",
        "expiryMonth": "11",
        "cardLimit": "100",
        "singleUseCard": "YES",
        "cardName": "DEMOCARD",
        "countryGroupId": "",
        "mccGroupId": "",
        "lockCardAcceptor": "DEFAULT"
      }
    },
    "api": {
      "signature": "{{signature}}",
      "apiKey": "{{Api-key}}",
      "credential": "{{cred}}"
    }
  }
});

req.write(postData);

req.end();

Body

{
    "method": "ledger.CARD.request",
    "id": "1",
    "params": {
        "payload": {
            "reference": "S9KA2033332314",
            "transactionType": "ADD_CARD",
            "customerId": "100000000033002",
            "accountNumber": "210199823931012",
            "product": "DEFAULT",
            "channel": "VISA_DPS",
            "program": "DEFAULT",
            "card": {
                "cardHolderId": "CH00000000019001",
                "cardType": "VIRTUAL",
                "expiryYear": "2024",
                "expiryMonth": "11",
                "cardLimit": "100",
                "singleUseCard": "YES",
                "cardName": "DEMOCARD",
                "countryGroupId": "",
                "mccGroupId": "",
                "lockCardAcceptor": "DEFAULT"
            }
        },
        "api": {
            "signature": "{{signature}}",
            "apiKey": "{{Api-key}}",
            "credential": "{{cred}}"
        }
    }
}

Response: 200

Response Parameters

Parameters	Description
Id	String Response ID echoed from the request ID Sample Value: "1"
result	Object
card	Object
cardId	String Unique ID of the card Sample Value: "d3360652aec34493976fa0d24b9d098d"
cardType	String Card type that has been added is virtual, by default Sample Value: "VIRTUAL "
postedDate	String Date and time when the details for adding card was posted Sample Value: "2024-11-20T06:56:11.399830826Z"
updatedDate	String Date and time when the details for adding card was updated Sample Value: "2024-11-20T06:56:11.399831053Z"
cardMaskNumber	String Masked representation of the card number Sample Value: "************3535"
cardStatus	String Current status of card Sample Value: "ACTIVATED"
cardExpiryDate	String Expiration date of the card in YYYYMM format Sample Value: "202501"
allowAtm	Boolean Allowing card for transactions through ATM Sample Value: false
allowEcommerce	Boolean Allowing card for e-commerce transactions Sample Value: false
allowMoto	Boolean Allowing card for transactions through mobile Sample Value: false
allowPos	Boolean Allowing card for point-of-sale (POS) terminal transaction Sample Value: false
allowTips	Boolean Allowing card for tips transaction Sample Value: false
allowPurchase	Boolean Allowing card for purchase transaction Sample Value: false
allowRefund	Boolean Allowing card for refund transaction Sample Value: false
allowCashback	Boolean Allowing card for cashback transaction Sample Value: false
allowWithdraw	Boolean Allowing card for ATM withdrawal transaction Sample Value: false
allowAuthAndCompletion	Boolean Allowing for authorization and completion of transaction that happens through card Sample Value: false
smart	Boolean Allowing card for smart transaction Sample Value: false
checkAvsZip	Boolean Allowing card to perform AVS checks on the legalRep ZIP code during transaction Sample Value: false
checkAvsAddr	Boolean Allowing card to perform AVS checks on the legalRep address during transaction Sample Value: false
cvv	String Card Verification Value of the card Sample Value: ""
transactionMade	Boolean Inicates whether any transactions can be made using the card or not Sample Value: false
orderStatus	String Current order status of the card Sample Value: "ORDER_COMPLETED"
orderId	String ID of the order placed for the card Sample Value: "4UOJG5XIDW8Y000"
isReIssue	Boolean Inicates whether the card is reissued Sample Value: false
isReplace	Boolean Inicates whether the card is replaced Sample Value: false
api	Object
type	String Acknowledgement for type of operation requested for Sample Value: "ADD_CARD_ACK"
reference	String Unique reference for the API response Sample Value: "REFS9KA2033332314"
dateCreated	Number Unix timestamp of the response was created Sample Value: 1730790735
originalReference	String Original reference ID taken from the request Sample Value: "S9KA2033332314"

{
    "id": "1",
    "result": {
        "card": {
            "cardId": "d3360652aec34493976fa0d24b9d098d",
            "cardType": "VIRTUAL",
            "postedDate": "2024-11-20T06:56:11.399830826Z",
            "updatedDate": "2024-11-20T06:56:11.399831053Z",
            "cardMaskNumber": "************3535",
            "cardStatus": "ACTIVATED",
            "cardExpiryDate": "202501",
            "allowAtm": false,
            "allowEcommerce": false,
            "allowMoto": false,
            "allowPos": false,
            "allowTips": false,
            "allowPurchase": false,
            "allowRefund": false,
            "allowCashback": false,
            "allowWithdraw": false,
            "allowAuthAndCompletion": false,
            "smart": false,
            "checkAvsZip": false,
            "checkAvsAddr": false,
            "cvv": "",
            "transactionMade": false,
            "orderStatus": "ORDER_COMPLETED",
            "orderId": "4UOJG5XIDW8Y000",
            "isReIssue": false,
            "isReplace": false
        },
        "api": {
            "type": "ADD_CARD_ACK",
            "reference": "REFS9KA2033332314",
            "dateCreated": 1730790735,
            "originalReference": "S9KA2033332314"
        }
    }
}

Add a Virtual Card

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200