HomeGuidesRecipesAPI ReferenceRelease NotesLogin
API Reference
  1. LEDGER API
  2. Customers

Create customer (REST)

post
https://api.uat.paymentology.com/pty/customer/v1/customers
  • REST-style endpoint for the same operation as Create customer (PWS). Same request body and response envelope.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 40

Unique number that must be passed at each API request. Identifier to make each API request unique

int32
required
≥ 1

Unique identifier for the client which Paymentology will provide at outset

string
required
length between 0 and 500
^(?!\d+$).+

Customer First Name

string
required
length between 0 and 20

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

string
required
length between 0 and 500
^(?!\d+$).+

Customer Last Name

string
length between 0 and 50

User Id of the Customer who triggered the API request.

string
length between 0 and 200

Remarks for API request

string

Customer title

string
length between 0 and 50

Customer Company

string
length between 0 and 50

Customer Ref

string
length between 0 and 10

Customer building number

string
length between 0 and 100

Customer address1

string
length between 0 and 100

Customer address2

string
length between 0 and 50

Customer address3

string
length between 0 and 15

Customer PCode

string
length between 0 and 50

Customer City Name

string
length between 0 and 50

Customer Country Name

string
length between 0 and 60

Customer Email

string
length between 0 and 10

Customer Pass Code

string
length between 0 and 3

Customer Native Language

string
length between 0 and 60

Customer Nationality

int32
enum

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

Allowed:
string
length between 0 and 60

Customer Alternate Email

string
length between 0 and 80

Customer State

string

Customer Date of Birth

int32

Default rule alert sms severity

int32

Default rule alert email severity

string
length between 0 and 20

Bank Customer Number

string
length between 0 and 20

Customer Alternate Mobile

string
length between 0 and 20

Customer Phone Home

string
length between 0 and 50

Customer Id Type

string
length between 0 and 100

Customer id number can be driving licence,citizenship number

double

Credit rating

int32

Credit rating source

string

Display Name

string
enum

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

Allowed:
string
length between 0 and 1000

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

string
length between 0 and 1000

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

string
enum

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

Allowed:
int32

Counter which is decremented with each KYC attempt

string

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

boolean

Indicates if the customer to be created is main cardholder or not. The possible values are true or false.

Responses

401

Missing or invalid access token. Empty body.

403

Access token rejected by the API gateway (for example, expired).

Updated 21 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago

Did this page help you?