Step 2. Cashier gets full Customer’s information
Cashier will request customer information endpoint from the Merchant's side as soon as the Merchant requests the deposit page URL described in Step 1.
This endpoint should be created on the Merchant side to let Cashier request it to get full information of the Customer for whom the Merchant wants to show the Cashier Deposit Page. Cashier system will use this information to show relevant payment methods configured by the Merchant inside the Cashier Backoffice.
URL: Merchant API Validation URL
Merchant will provide it as soon as they prepare the endpoint described below.
HTTP Method: GET
Headers:
- Content-type:
application/json - Authorization: Deposit Page JWT bearer token.
Response Fields:
| Name | Type | Size/Format | Mandatory | Description |
|---|---|---|---|---|
customerId | string | true | Customer unique identifier from Merchant system | |
address | string | Chars (256) | false | Customer address. |
city | string | Chars (256) | false | Customer city. |
country | string | ISO 2 digits country code | true | Customer country code. |
postalCode | string | false | Customer postal code. | |
email | string | Format: email | true | Customer email. |
fullPhoneNumber | string | International phone number format | true | Full phone number. |
firstName | string | Chars (256) | true | Customer’s first name. |
lastName | string | Chars (256) | true | Customer’s last name. |
currency | string | Currency ISO Code | true | Customer trading account currency. |
status | string | Char(1) | false | 0 - success; 1 – error. |
isDepositor | boolean | false | true - customer has deposits; false - customer doesn't have deposits. | |
affiliateName | string | false | Customer's affiliate name. | |
balance | string | false | ||
assignedToDepartmentTreePath | string | false | Definition of the department/team associated with the transaction . | |
documents | Array[] | false | Array of objects with next fields { “type”: “string, “number”:“string”, “country”: “string” } |
Response body example:
Successful Return Code: HTTP 200 OK
{
"address": "42 Testreet",
"city": "Testown",
"country": "NL",
"postalCode": "A3455",
"email": "[email protected]",
"fullPhoneNumber": "+491711234567",
"firstName": "John",
"lastName": "Doe",
"customerId": "1",
"currency": "EUR",
"status": 0,
"isDepositor": "false",
"affiliateName": "Google",
"assignedToDepartmentTreePath": "Sales"
}