---
title: "Get Card Image"
method: POST
path: "/pws/pws_get_card_image/"
tags: ["Card"]
---

# Get Card Image

`POST /pws/pws_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)

## Request body

- CardImageModel — -- This web service gets card image details (PAN, CVV, expiry or image details; based on public token provided.) -- Response data is based on image_delivery input fields. -- Provide token, image_name etc.
  - `api_call_unique_identifier` string, required — Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required — Unique identifier for the client which Paymentology will provide at outset
  - `image_delivery` integer, 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_fields` string, 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_name` string, 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.
  - `token` integer, required — Public token for the card.
  - `xml_fields` string, 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_id` string — User Id of the Customer who triggered the API request.
  - `remarks` string — Remarks for API request

## Response `200`

Successful Response

- GetCardImageResponseModel
  - `header` GetCardImageResponseHeader
    - `error_id` integer — error id
    - `error_desc` string — error message
  - `body` GetCardImageResponseBody
    - `cvv` string — card security code
    - `image_base64` string — Image data in base64 form
    - `epan` string — Encrypted pan number
    - `emboss_name` string — Name that appears in card
    - `expiry` string — Expiry in MM/YY format
    - `token` integer — Public token for card created
    - `ac_id` integer — account id in response
    - `mpan` string — masked pan. Returned only when image_delivery = 4

## Other responses

- `404` — Webservices does not exist
- `500` — Internal Server error

---

[API](https://skmtc.net/paymentology/apis/payapi-docs.md) · [All operations](https://skmtc.net/paymentology/apis/payapi-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paymentology/payapi-docs/revisions/a675891b0365/schema)