Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Customer

Create Customer

This web service creates a new customer/cardholder

post/pws/pws_create_customer

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

cu_fnamestring required

Customer First Name

cu_mobilestring required

Customer Mobile Number. mobile number format i.e 00 (country code) phone number or + (country code) phone number.

cu_snamestring required

Customer Last Name

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

cu_titlestring
companystring

Customer Company

cu_refstring

Customer Ref

cu_bldg_nostring

Customer building number

cu_add1string

Customer address1

cu_add2string

Customer address2

cu_add3string

Customer Address3

cu_pcodestring

Customer PCode

cu_citystring

Customer City Name

cu_countrystring

Customer Country Name

cu_emailstring email

Customer Email

cu_pass_codestring

Customer Pass Code

cu_langstring

Customer Native Language

cu_nationalitystring

Customer Nationality

cu_genderinteger
<p>Customer Gender.Possible values are:</p><ul><li>1=Male</li><li>2=Female</li><li>3=Other</li></ul>
cu_alternate_emailstring email

Customer Alternate Email

cu_statestring

Customer State

cu_dobstring

Customer Date of Birth

default_rule_alert_sms_severityinteger

Default rule alert sms severity

default_rule_alert_email_severityinteger

Default rule alert email severity

bank_customer_nostring

Bank Customer Number

cu_alternate_mobilestring

Customer Alternate Mobile

cu_phone_homestring

Customer Phone Home

cu_id_typestring

Customer Id Type

cu_id_numberstring

Customer id number can be driving licence,citizenship number

credit_ratingnumber double

Credit rating

credit_rating_sourceinteger

Credit rating source

display_namestring

Display Name

kyc_statusstring
<p>KYC status</br>possible options are:</p><ul><li>1 =Awaiting first verification attempt</li> <li>2 = KYC data submitted, Awaiting Response</li> <li>3 = KYC successful</li> <li>4 = KYC unsuccessful</li> <li>5 = KYC verification attempts expired</li> <li>6 = KYC not possible (permeant)</li> <li>7=Awaiting KYC re-verification</li></ul>
kyc_status_detailsstring
<p>KYC status details.</br>User defined text to describe the reason of status</p>
kyc_ext_referencestring

External reference id provided by KYC provider to refer last KYC attempt

key_provider_namestring
<p>Key provider name.</br>Possible options are:</p><ul><li>1 = Jumio (supported for now)</li> <li>2 = IDNow</li> <li>3 = Sumsub</li></ul>
kyc_attempt_countinteger

Counter which is decremented with each KYC attempt

kyc_attempt_datestring

Date with timestamp . It will contain the value when last KYC attempt was made

is_main_cardholderboolean
<p>Indicates if the customer to be created is main cardholder or not.</br>The possible values are true or false.</p>

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "cu_fname": "John",
  "cu_mobile": "2227654321",
  "cu_sname": "Blogs",
  "cu_bldg_no": "A1234",
  "cu_add1": "UK",
  "cu_add2": "Dubai",
  "cu_add3": "Africa",
  "cu_pcode": "A123X",
  "cu_city": "London",
  "cu_country": "UK",
  "cu_email": "emailaddress@gmail.com",
  "cu_pass_code": "1234",
  "cu_lang": "ENG",
  "cu_nationality": "Indian",
  "cu_gender": 1,
  "cu_alternate_email": "emailaddress@gmail.com",
  "cu_state": "Pokhara",
  "cu_dob": "1990-02-30",
  "default_rule_alert_sms_severity": -1,
  "default_rule_alert_email_severity": -1,
  "bank_customer_no": "0",
  "cu_alternate_mobile": "3337654321",
  "cu_phone_home": "44454321",
  "cu_id_type": "Driver License",
  "cu_id_number": "123/12345",
  "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",
  "is_main_cardholder": true
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "customer_id": 607748
  }
}