Skip to main content

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:

NameTypeSize/FormatMandatoryDescription
customerIdstringtrueCustomer unique identifier from Merchant system
addressstringChars (256)falseCustomer address.
citystringChars (256)falseCustomer city.
countrystringISO 2 digits country codetrueCustomer country code.
postalCodestringfalseCustomer postal code.
emailstringFormat: emailtrueCustomer email.
fullPhoneNumberstringInternational phone number formattrueFull phone number.
firstNamestringChars (256)trueCustomer’s first name.
lastNamestringChars (256)trueCustomer’s last name.
currencystringCurrency ISO CodetrueCustomer trading account currency.
statusstringChar(1)false0 - success; 1 – error.
isDepositorbooleanfalsetrue - customer has deposits; false - customer doesn't have deposits.
affiliateNamestringfalseCustomer's affiliate name.
balancestringfalse
assignedToDepartmentTreePathstringfalseDefinition of the department/team associated with the transaction .
documentsArray[]falseArray 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"
}