---
title: "Get Card Details"
method: POST
path: "/pws/pws_get_card_detail/"
tags: ["Card"]
---

# Get Card Details

`POST /pws/pws_get_card_detail/`

This web service retrieves card holder details, token flag details and descriptions.  Pass a public token and client ID, to retrieve card details.

## Request body

- CardDetailsModel — -- This web service retrieves card holder details, along with token flag details and descriptions. -- Pass a public token and client ID, to retrieve card details
  - `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
  - `token` integer, required — Public token of card.
  - `user_id` string — User Id of the Customer who triggered the API request.
  - `remarks` string — Remarks for API request

## Response `200`

Successful Response

- GetCardDetailsResponseModel
  - `header` GetCardDetailsResponseHeader
    - `error_id` integer — error id
    - `error_desc` string — error message
  - `body` GetCardDetailsResponseBody
    - `image_name` string, required — Image template name for the card to be generated.
    - `token` integer, required — Public token.
    - `ch_title` string — Card holder title
    - `ch_fname` string — <p>Card holder first name<br />Based on configuration on client level, we either show masked first name or encrypted name.</p> <p>We have field at client level as enable_customer_name.</p> <ul> <li>0 =&gt; Display name as ********</li> <li>1 =&gt; Display name encrypted with cp key. Client can use cp key to decrypt name</li> </ul> <p>&nbsp;</p>
    - `ch_sname` string — <p>Card holder last name<br />Based on configuration on client level, we either show masked last name or encrypted name.</p> <p>We have field at client level as enable_customer_name.</p> <ul> <li>0 =&gt; Display name as ********</li> <li>1 =&gt; Display name encrypted with cp key. Client can use cp key to decrypt name</li> </ul> <p>&nbsp;</p>
    - `ch_addr1` string — Card holder address 1
    - `ch_addr2` string — Card holder address 2
    - `ch_pcode` string — Card holder postal code
    - `ch_city` string — Card holder city
    - `ch_country` string — Card holder country
    - `ch_email` string, email — Card holder email
    - `ch_mobile` string — Card holder mobile number
    - `cu_ref` string — Customer reference
    - `del_title` string — Delivery title
    - `del_fname` string — Delivery person first name Based on configuration on client level, we either show masked name or encrypted name. We have field at client level as enable_customer_name. 0 => Display name as ******** 1 => Display name encrypted with cp key. Client can use cp key to decrypt name
    - `del_sname` string — Delivery person last name Based on configuration on client level, we either show masked name or encrypted name. We have field at client level as enable_customer_name. 0 => Display name as ******** 1 => Display name encrypted with cp key. Client can use cp key to decrypt name
    - `del_addr1` string — Delivery address 1
    - `del_addr2` string — Delivery address 2
    - `del_pcode` string — Delivery postal code
    - `del_city` string — Delivery city
    - `del_country` string — Delivery country
    - `del_email` string, email — Delivery email
    - `del_mobile` string — Delivery mobile
    - `pur_title` string — Purchaser title
    - `pur_fname` string — Purchaser person first name Based on configuration on client level, we either show masked name or encrypted name. We have field at client level as enable_customer_name. 0 => Display name as ******** 1 => Display name encrypted with cp key. Client can use cp key to decrypt name
    - `pur_sname` string — Purchaser person last name Based on configuration on client level, we either show masked name or encrypted name. We have field at client level as enable_customer_name. 0 => Display name as ******** 1 => Display name encrypted with cp key. Client can use cp key to decrypt name
    - `pur_addr1` string — Purchaser address 1
    - `pur_addr2` string — Purchaser address 2
    - `pur_pcode` string — Purchaser postal code.
    - `pur_city` string — Purchaser city.
    - `pur_country` string — Purchaser country.
    - `pur_email` string, email — Purchaser email.
    - `pur_mobile` string — Purchaser mobile number
    - `pur_cust_type` integer — Purchaser customer type 0 ==> card will be assigned to cardholder details. 1 ==> card will be assigned to purchaser details.
    - `exp_date` string — Expiry date Format : YYMM
    - `emboss_name` string — Emboss name : name that appears on front of card.
    - `card_type` integer — <ul> <li class="docBullet">1 ==&gt;Physical</li> <li class="docBullet">2 ==&gt; Virtual card</li> <li class="docBullet">3==&gt;Converted(Virtual to Physical)</li> </ul>
    - `product_ref` string — Product reference Product identifier, i.e. physical card design reference used by the card printer
    - `custom_1` string — Customer special details, i.e. QR code If custom_1 ==> 1, then we will provide : MMYY+Public Token (MMYY ->the date of card creation ). If custom_1 value other than "1" , PT will include what ever client input in the same field in create.
    - `envelope_ref` integer — Identifies envelope type.
    - `carrier_type` string — Allows client to stipulate carrier type (card packaging type choice - for shipment to customer)
    - `status_nwk` integer — <p>Status network :</p> <ul> <li class="docBullet">1000 : Fully operational DE39=00</li> <li class="docBullet">1001 : Refer to issuer DE39= 01</li> <li class="docBullet">1004 : Capture card DE39=04</li> <li class="docBullet">1005 : Decline all txns DE39=05</li> <li class="docBullet">1008 : Honour with ID DE39=08</li> <li class="docBullet">1009 : Void card (Visa: DE39=46) (MC: DE39=62)</li> <li class="docBullet">1010 : Due Payment Block</li> <li class="docBullet">1011 : KYC/AML/compliance hold</li> <li class="docBullet">1041 : Lost card - capture DE39= 41</li> <li class="docBullet">1043 : Stolen card - capture DE39=43</li> <li class="docBullet">1054 : Expired card - report DE39=54</li> <li class="docBullet">1154 : Expire card - don't inform</li> <li class="docBullet">1062 : Restricted card</li> <li class="docBullet">1199: Void card - report DE39=05</li></ul>
    - `pin_rem_onl` integer — Pin remaining online
    - `pin_rem_chp` integer — Pin remaining chip
    - `cre_dt` string — Created date
    - `ac_parent` integer — Parent account number.
    - `atm_lang_preference` string — Language to be used in ATM <ul><li class="docBullet">01 ==> Chinese</li><li class="docBullet">02 ==> English</li><li class="docBullet">03 ==> Portugese</li><li class="docBullet">04 ==> Spanish</li></ul>
    - `ccy_bill` string — Billing currency. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)
    - `ch_dob` string — Card holder birth date,format yyyy-mm-dd.
    - `chip_ccy` string — Chip currency. (Three digit ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)
    - `prod_id` integer — Product Id
    - `prod_name` string — Product name
    - `perso_fields` string — <p> Configuration for sensitive data </p> <table> <tbody> <tr> <th><strong>Position</strong></th> <th><strong>Field</strong></th> <th><strong>Description</strong></th> </tr> <tr> <td>1</td> <td>RFU</td> <td>Reserved for future</td> </tr> <tr> <td>2</td> <td>CVV</td> <td>0 : Hide Cvv, 1 : Show Cvv</td> </tr> <tr> <td>3</td> <td>RFU</td> <td>Reserved for future</td> </tr> <tr> <td>4</td> <td>RFU</td> <td>Reserved for future</td> </tr> <tr> <td>5</td> <td>Emboss Name</td> <td>0 : Lower case, 1 : Upper case</td> </tr> </tbody> </table> <p> Default value : 01001 Means show cvv and save emboss name as uppercase </p>
    - `load_status` integer — Enable or disable load for a card.0 ==> don't allow to load | 1 ==> Allow load for a card
    - `tok_flag` TokFlag[] — Flags for token to assign various tasks to the card. 0 ==>Flag inactive | 1==> Flag Active <table class="relative-table confluenceTable"> <tbody> <tr> <td class="confluenceTd"><strong>TOK_NAME</strong></td> <td class="confluenceTd"><strong>TOK_DESCRIPTION</strong></td> <td class="confluenceTd"><strong>BIT_POSITION</strong></td> </tr> <tr> <td class="confluenceTd">pin_new</td> <td class="confluenceTd">generate new rand pin and send to card on nxt EMV txn</td> <td class="confluenceTd">2</td> </tr> <tr> <td class="confluenceTd">send_bal</td> <td class="confluenceTd">Send card bal in De54 in next auth</td> <td class="confluenceTd">3</td> </tr> <tr> <td class="confluenceTd">pin_ub</td> <td class="confluenceTd">Send Pin unblock to card</td> <td class="confluenceTd">4</td> </tr> <tr> <td class="confluenceTd" colspan="1">Blk_all_txn</td> <td class="confluenceTd" colspan="1">Sets card to decline all tranasaction except ecommerce</td> <td class="confluenceTd" colspan="1">5</td> </tr> <tr> <td class="confluenceTd" colspan="1">Blk_cnt_less</td> <td class="confluenceTd" colspan="1">Set card to decline all Contactless transaction</td> <td class="confluenceTd" colspan="1">6</td> </tr> <tr> <td class="confluenceTd">Blk_ecom</td> <td class="confluenceTd">Sets card to decline all Ecommerce</td> <td class="confluenceTd">9</td> </tr> <tr> <td class="confluenceTd">Blk_atm</td> <td class="confluenceTd">Sets card to decline all ATM</td> <td class="confluenceTd">10</td> </tr> <tr> <td class="confluenceTd">Blk_bal_enq</td> <td class="confluenceTd">Sets card to deline Bal enquiry over auth</td> <td class="confluenceTd">11</td> </tr> <tr> <td class="confluenceTd">Blk_csh_bak</td> <td class="confluenceTd">Sets card to decline cash back txns</td> <td class="confluenceTd">12</td> </tr> <tr> <td class="confluenceTd">Blk_csh_disb</td> <td class="confluenceTd">Sets card to decline De3_1 = 17</td> <td class="confluenceTd">13</td> </tr> <tr> <td class="confluenceTd">Blk_cr_auth</td> <td class="confluenceTd">Sets card to decline credit pur/refund (DE3_1=20)</td> <td class="confluenceTd">14</td> </tr> <tr> <td class="confluenceTd">Blk_cr_auth</td> <td class="confluenceTd">Sets card to decline credit deposit (DE3_1=21)</td> <td class="confluenceTd">15</td> </tr> <tr> <td class="confluenceTd">Blk_cr_auth</td> <td class="confluenceTd">Sets card to decline credit adjust (DE3_1=22)</td> <td class="confluenceTd">16</td> </tr> <tr> <td class="confluenceTd">Blk_cr_auth</td> <td class="confluenceTd">Sets card to decline chq deposit guarantee (DE3_1=23)</td> <td class="confluenceTd">17</td> </tr> <tr> <td class="confluenceTd">Blk_cr_auth</td> <td class="confluenceTd">Sets card to decline chq deposit (DE3_1=24)</td> <td class="confluenceTd">18</td> </tr> <tr> <td class="confluenceTd">Blk_cr_auth</td> <td class="confluenceTd">Sets card to decline credit payment (DE3_1=28)</td> <td class="confluenceTd">19</td> </tr> <tr> <td class="confluenceTd">Blk_cr_auth</td> <td class="confluenceTd">Sets card to decline non base currency txn</td> <td class="confluenceTd">20</td> </tr> <tr> <td class="confluenceTd">Blk_acc_enq</td> <td class="confluenceTd">Sets card to decline all account enq (de61_7=8)</td> <td class="confluenceTd">21</td> </tr> <tr> <td class="confluenceTd">Blk_crd_np</td> <td class="confluenceTd">sets card to decline Card not present txns</td> <td class="confluenceTd">22</td> </tr> <tr> <td class="confluenceTd">Blk_ch_np</td> <td class="confluenceTd">sets card to decline Cardholder not present txns</td> <td class="confluenceTd">23</td> </tr> <tr> <td class="confluenceTd">Blk_fo_cm_atm</td> <td class="confluenceTd">sets card to decline failover to mag at emv capable atm</td> <td class="confluenceTd">24</td> </tr> <tr> <td class="confluenceTd">Blk_mag_atm</td> <td class="confluenceTd">sets card to decline mag at atm</td> <td class="confluenceTd">25</td> </tr> <tr> <td class="confluenceTd">Alow_fallbk_cac</td> <td class="confluenceTd">Alow if fallback chp-&gt;mag at chp capable pos DE22_1=80</td> <td class="confluenceTd">26</td> </tr> <tr> <td class="confluenceTd">Alow_mag_atm</td> <td class="confluenceTd">Allow if de22_1=02 &amp; De48_88 =Y</td> <td class="confluenceTd">27</td> </tr> <tr> <td class="confluenceTd" colspan="1">Alow_AVS_Fail</td> <td class="confluenceTd" colspan="1">Sets card to approve if AVS match fails</td> <td class="confluenceTd" colspan="1">28</td> </tr> <tr> <td class="confluenceTd">Ext_Auth_OFF</td> <td class="confluenceTd">Set card to External Auth OFF (<em><strong>depreciated. Replaced by auth_type in request card create request</strong></em>)</td> <td class="confluenceTd">32</td> </tr> </tbody> </table>
      - `description` string
      - `details` string
      - `bit_pos` integer
      - `status` string
    - `note` string — <p>This field specifies reason for card status change. Card status can change in following case :</p><ul><li class="docBullet">Client updating card status via pws_set_card_status web service.</li><li class="docBullet">Editing card status from paycontrol.</li><li class="docBullet">Pin retries exceed more than 3 times.</li><li class="docBullet">Pin verification failed for successive four times.</li></ul>
    - `accounts` string — List of accounts that the card belongs to.
    - `get_enable_customer_name` integer
    - `bulk_delv_add_code` integer
    - `del_code` integer
    - `fulfil1` string
    - `3ds_enrolled_status` integer

## 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)
