PApaymentology
Ledger API - Customers

Get customer details (PWS)

<ul> <li class="docBullet">Ledger API version of the PWS <a href="https://developer.paymentology.com/bankinglive/reference/pws_get_customer_details">Get Customer Details</a> call. Request and response use the same format, served by the Ledger API.</li> </ul>
post/pty/customer/v1/pws_get_customer_details

Request

  • Base URL
    https://api.uat.paymentology.com
  • URL
    https://api.uat.paymentology.com/pty/customer/v1/pws_get_customer_details
  • Auth
    HTTP bearer

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

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

cu_fnamestring

Customer First Name

cu_snamestring

Customer Last Name

cu_emailstring

Customer Email Id

cu_refstring

Customer Reference

cu_idinteger required

Customer Id

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "user_id": "string",
  "remarks": "string",
  "cu_fname": "John",
  "cu_sname": "Blogs",
  "cu_email": "cardholder@example.com",
  "cu_ref": "string",
  "cu_id": 743318
}

Response

Request processed. Check header.error_id: 0 means success. Any other value is a business error, reported with HTTP 200 and an empty body. Common codes: 992 (invalid account id), 993 (invalid card token), 995 (validation failed), 1043 (account does not belong to the client), 1055 (invalid program_code), 1531 (invalid customer id).

api_call_unique_identifierstring required
client_idinteger required
user_idstring
remarksstring

Example response

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "user_id": "string",
  "remarks": "string",
  "header": {
    "error_desc": "success"
  },
  "body": {
    "company": "string",
    "cre_dt": "2020-08-30 11:12:15",
    "cu_id": 607748,
    "cu_fname": "*****",
    "cu_sname": "*****",
    "cu_type": 1,
    "cu_ref": "string",
    "cu_bldg_no": "string",
    "cu_add1": "UK",
    "cu_add2": "Dubai",
    "cu_pcode": "A123X",
    "cu_city": "London",
    "cu_country": "UK",
    "cu_email": "cardholder@example.com",
    "cu_mobile": "9846866252",
    "cu_pass_code": "1234",
    "cu_lang": "ENG",
    "cu_nationality": "Indian",
    "cu_gender": 1,
    "cu_alternate_email": "cardholder@example.com",
    "cu_state": "Pokhara",
    "cu_dob": "1996-07-25",
    "default_rule_alert_sms_severity": -1,
    "default_rule_alert_email_severity": -1,
    "bank_customer_no": "0",
    "is_main_cardholder": true,
    "cu_alternate_mobile": "9846477204",
    "cu_phone_home": "061621612",
    "cu_id_type": "Driver License",
    "cu_id_number": "101/1019",
    "display_name": "Ram",
    "kyc_status": "1",
    "kyc_status_details": "verification requirement failed",
    "kyc_ext_reference": "1234",
    "key_provider_name": "null",
    "kyc_attempt_count": 5,
    "kyc_attempt_date": "2020-11-25 11:12:13"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.