Skip to content

Query Customer Detail

Function Description

  • Query customer detail

Query Customer Detail API

Request URL

  • /payee/custom/detail

Request Method

  • GET

Request Parameters

The request parameters are as follows:

TIP

If one of the merchant customer ID and system customer ID is not transmitted, the interface will respond to parameter missing errors.

parameterRequiredTypeDefault ValueDescription
mercustomidNstring-Merchant customer ID, length limit 128 characters
customidNstring-System customer ID, length limit 64 characters

Response Parameters

The response parameters are as follows:

  • Response Body
ParameterTypeDescription
customidstringSystem customer ID
mercustomidstringMerchant customer ID
name_estringCustomer english name
name_astringCustomer arabic name
identitystringID number (sensitive information, encrypted with merchant public key)
identitypicstringID card photo URL (sensitive information, encrypted using merchant public key)
signpicstringSignature photo URL (sensitive information, encrypted using merchant public key)
banknamestringBank name
bankcodestringBank code
cardnostringBank account (sensitive information, encrypted using merchant public key)
ibanaccountstringIBAN
stcaccountstringSTCPay account (sensitive information, encrypted using merchant public key)
statusnumberCustomer status
statusdescstringCustomer status description
autoapprovalnumberWhether to enable automatic approval:
0: Disable
1: Enable
otpappnamestringProduct name for sending OTP verification
demand_perfectionarrayWhat information does the user currently need to improve
created_atnumberCreation time
updated_atnumberUpdate time

Response Parameter Example

json
{
    "code": 200,
    "message": "Request succeeded.",
    "data": {
        "customid": "12ad4",
        "mercustomid": "u004",
        "name_e": "usera",
        "name_a": "usera",
        "identity": "noGsqF+6wpnfchtRtiIjkuzL3t6YPFv3rqK1KobZf5cVnLRCZ7HjxoqMHoD9b+YHasd1izzd58GPJAl5DswpI8f4PxauKBv9ba45us0PlUZAUurpc0/8FmZrx/xuDTz+rtfGBUckUBiwz0iZXdbJ46PYAPdB9Hlz27Nn7eYU9UXBiluuISBKt/1Q1aJ4nKfhjvONntmDXOUyP719hD8BIyjD3aYYK96OxwIrPCbT4nDMbA/qQdhboOVPQTdom774OWUjlVv32bU7Ck1jzmERvsMptCkveb/Qjr4b/9Z6ZKDIx0VtPPzHDtffNwRohfpEv9RiKzG4RM52Mfr3jV78Eg==",
        "identitypic": "",
        "signpic": "",
        "bankname": "Riyad Bank",
        "bankcode": "1174c",
        "cardno": "jH8+rl4v3EqKOZWgyacTtNhGGdP+DvyRpeVhDuXhvEam4pcI2vuPEUMtAaYD6LOpZ85z8sHZd344dDzTLmNuIOMs9GnvdrV0RA2kCqwHHIkgRshci1CHE/S4Ds+MBNdCcs+eeVYGHMa/PH2dZRIsYpdkGw17ldUxF8TL2gcRyNZvF/VWz3ZduuKUwFZ3eYeqLmMoAwQcslPZNcAPW28vXhiPw4DSyPc9jp1wRJWVLLVaTXYrSnx5847I0WscR++O052XSuSUPLlKsjhNVXKPW/3QPkAHifvIRxwgEb2tv9y7Clxp8GrD1K+vpojs3yhSpaUiPiVb6MEgXZq2In0rBA==",
        "ibanaccount": "1234567892",
        "stcaccount": "",
        "status": 4,
        "statusdesc": "2023-06-15 06:12:54",
        "autoapproval": 1,
        "otpappname": "test",
        "demand_perfection": [
            "identitypic"
        ],
        "created_at": 1686809574,
        "updated_at": 1686809574
    },
    "sensitiveFields": [
        "identity",
        "identitypic",
        "signpic",
        "stcaccount",
        "cardno"
    ],
    "requestId": "13AB5E3E15526172EF73CB2939D08535"
}