Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Card

Get Card Image

This web service provides the card image based on public token provided and the card details specified in the call viz. PAN, CVV, expiry or image details. <br /> Note : Encrypted Pan/image returned will be AES encrypted by client Processing key (CP-Key)

post/pws/pws_get_card_image/

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

image_deliveryinteger required
<p>How to deliver image back to client. Example :</p> <ul> <li class="docBullet">1==&gt; Image in plain base64, encrypted pan, cvv, token, expiry, and emboss_name).</li> <li class="docBullet">2 ==&gt; Image in byte encrypted, encrypted pan, cvv, token, expiry, and emboss_name.</li> <li class="docBullet">3 ==&gt; Data details JSON (encrypted pan, cvv, token, expiry, and emboss_name but no image.</li> <li class="docBullet">4 ==&gt; Image in byte encrypted, masked pan back, cvv, token, expiry, and emboss_name.</li> </ul>
image_fieldsstring required
<p>Show or hide pan, cvv, expiry, token, and emboss_name in response image. 1 means show and 0 means hide</p> <table > <tbody> <tr> <th ><strong>Position</strong></th> <th ><strong>Field</strong></th> </tr> <tr> <td >1</td> <td >pan</td> </tr> <tr> <td >2</td> <td >cvv </td> </tr> <tr> <td >3</td> <td>expiry</td> </tr> <tr> <td >4</td> <td>emboss_name</td> </tr> <tr> <td >5</td> <td>token</td> </tr> </tbody> </table> <p>EG : 00111 (Hide pan and cvv but show expiry, token, and emboss_name).</p>
image_namestring required

Image template name for the card to be generated. This field is case sensitive. card image has to be populated as configured in PayControl.

tokeninteger required

Public token for the card.

xml_fieldsstring required
<p>Show or hide pan, cvv, expiry, token, and emboss_name in response json. 1 means show and 0 means hide</p> <table > <tbody> <tr> <th ><strong>Position</strong></th> <th ><strong>Field</strong></th> </tr> <tr> <td >1</td> <td >pan</td> </tr> <tr> <td >2</td> <td >cvv. (This can be overrided from client level setting to show or hide cvv) </td> </tr> <tr> <td >3</td> <td>expiry</td> </tr> <tr> <td >4</td> <td>token</td> </tr> <tr> <td >5</td> <td>emboss_name</td> </tr> </tbody> </table> <p>EG : 00111 (Hide pan and cvv but show expiry, token, and emboss_name).</p>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "image_delivery": 1,
  "image_fields": "11111",
  "image_name": "paymentology",
  "token": 311012081,
  "xml_fields": "11111"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "cvv": "***",
    "image_base64": "ZSBzaG9ydCB2Z=",
    "epan": "***********",
    "emboss_name": "JOHN DOVE",
    "expiry": "03/21",
    "token": 788193393,
    "ac_id": 788193393,
    "mpan": "5445*****434**4354"
  }
}