PApaymentology
Ledger API - Customers

Update customer (REST)

<ul> <li class="docBullet">REST-style endpoint for the same operation as <a href="https://developer.paymentology.com/bankinglive/reference/v3_pws_update_customer">Update customer (PWS)</a>. Same request fields and response envelope.</li> <li class="docBullet">The customer is identified by <code>customer_id</code> in the path instead of <code>cu_id</code> in the body.</li> </ul>
patch/pty/customer/v1/customers/{customer_id}

Request

  • Base URL
    https://api.uat.paymentology.com
  • URL
    https://api.uat.paymentology.com/pty/customer/v1/customers/{customer_id}
  • Auth
    HTTP bearer

Path parameters

customer_idinteger required
Example:1234567

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_titlestring

Customer title

cu_fnamestring

Customer First Name

cu_snamestring

Customer Last Name

companystring

Customer Company

cu_typeinteger

Customer Type

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 Postal Code

cu_citystring

Customer City Name

cu_countrystring

Customer Country Name

cu_emailstring

Customer Email

cu_mobilestring

Customer Mobile Number must be formatted as + followed by up to 15 digits, without spaces, dashes, or other characters.

cu_pass_codestring

Customer Pass Code

cu_langstring

Customer Native Language

cu_nationalitystring

Customer Nationality

cu_gender1 | 2 | 3

Gender. Possible values are: 1=Male 2=Female 3=Other

cu_alternate_emailstring

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 must be formatted as + followed by up to 15 digits, without spaces, dashes, or other characters.

cu_phone_homestring

Customer Phone Home must be formatted as + followed by up to 15 digits, without spaces, dashes, or other characters.

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_status'1' | '2' | '3' | '4' | '5' | '6' | '7'

KYC status possible options are: 1=Awaiting first verification attempt 2=KYC data submitted, Awaiting Response 3=KYC successful 4=KYC unsuccessful 5=KYC verification attempts expired 6=KYC not possible (permeant) 7=Awaiting KYC re-verification

kyc_status_detailsstring

KYC status details. User defined text to describe the reason of status

kyc_ext_referencestring

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

key_provider_name'1' | '2' | '3'

Key provider name. Possible options are: 1=Jumio (supported for now) 2=IDNow 3=Sumsub

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

Indicates whether the customer is the main cardholder

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "user_id": "string",
  "remarks": "string",
  "cu_mobile": "+359888123456",
  "cu_alternate_mobile": "+359888123457",
  "cu_phone_home": "+35952333444"
}

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

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "Customer Edited Successfully for given cu_id 607748"
  }
}

Changes

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