Skip to content

Update Customer Information

Function Description

  • Update customer information

Customer Status Description

Currently, the mandatory information that customers need to complete is the ID card photo. If the customer has not been banned, when the customer updates the information and has set the ID card photo, the customer status will be reset to pending.

WARNING

  1. If the updated data submitted is consistent with the customer's existing data, the customer information remains unchanged and no status change is made.
  2. Changes to customer information do not affect the payment orders that have been created for the customer. The payment orders will continue to be processed according to the customer information at the time of creation.

Update Customer Profile API

Request URL

  • /payee/custom/file

Request Method

  • POST

Request Parameters

The request parameters are as follows:

TIP

  1. If one of the merchant customer ID and system customer ID is not transmitted, the interface will respond to parameter missing errors.
  2. In the sandbox environment, you can use the test account to simulate the customer's review status.
ParameterRequiredTypeDefault ValueDescription
mercustomidNstring-Merchant customer ID, length limit 128 characters
customidNstring-System customer ID, length limit 64 characters
fileYfile-The file size cannot exceed 2048kb, and the file must be of image type as following:
jpeg
png
bmp
gif
svg
webp
md5Ystring-MD5 value of the file
typeYstring-File type:
identitypic: ID card photo
signpic: Signature photo

Response Parameters

After successful file processing, the latest customer information is returned.

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 the 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": "updTest2",
        "name_a": "usera",
        "identity": "NbX4Ex6OsXEujrdo3p3fqKPlI1607Z59xwRIZDwlaHlHtUNLSJCP6Hp9TQVVZt66Pw+7LLENT84l6TiH7owxgY+jUl5qfRs4+ooNb3Hb4tWgXcUBi3f8NDKI3KNL5FdiXXsaqy/l8uWZoiDuRuwfQCZEUJPl3yacVfwgq8IwUO4Gqld9iN6ciyxAT16w/rkafV56gNDaWNrLet8/3HxaCUXmYfs1SpYyUwi3Hn2uI1sDme9MLZtPUo/0Nwbq5MyR5IANq4O6Enw1K3LQ4g9ZmmS7QpY7iFGT/3zKFAsycjD8focAmM9+quITspykDR3p0y9Pvs6PWMXiR5FjhAaRsw==",
        "identitypic": "S6U6BDjYfqgHxJVGfgrRNoK+lMM050wJaxZZJ68k6dnLpyoqETiSbLvjVmmFnfdTnzQRKu3qXAKRe/PJYDq4EgT5G2hS0iS3UtvkHKgjACcDvgPqVIGDpH4ru7UbopZwJNRfrBLlVcV+N+wWMqii/r1t5wTGdx8yupy/3jhZX7hhO8HFl+BvR4JSgdPWNH00zu4sTi/w2P5wEayIzK4ya/Be7w0ULbhFgoczNRrdo9hoIbewH529s74OApked4/U3uaquCjjv6h+m+U/P9efRTsOl+5u/AmYxO4mTI2C+k8SY8lK9JUBI+1wVQm/Sj81UcXAFLN2IjFYo/bbrZuOww==",
        "signpic": "",
        "bankname": "Riyad Bank",
        "bankcode": "1174c",
        "cardno": "ZVanGfGN1gpvxACjCBvDuToQevSAgZbvmksSioWvej4ATnTjp2ytSmdcIkKA3CtkcoiZXTVp11yazyj4JYpQDC99uO+mE13zIz48Uxs98GM8DY+USO3SPCAEn70YyBZ5jX9GfhWob+1UwUkqjh++WOvQbYZl7JxxMLyTG62T4pXo74XWHZeX5kUTTFOJvX8Lc9h3WmVV8GG6xcU+HZ2dWlUO0EZHTIFm7ymre5w1fXUfR9ljHzb7AVYnTIArLENPPFSNYh7HvzZIMloA0exffgcUT4sZwUD5iTeNXDSAjfLRb/n7HDFAlTvZZpxWt0cKNSruPtvyQ5xiptAA3RmEOw==",
        "ibanaccount": "1234567892",
        "stcaccount": "W1pNqEGNzONfUPfixrH61nJsgh8iFI1pv1e0VFo/rNZO6d34fFPwj/SPMqajWRjOFp8IJjBJZWOMbFALS8nTx93lhIJddtEWkNPf3t+qKSlyehORZhF/5RYzvmAu7ThV/124BOzSs/LsX7u8ZKzhudpVU6GWFZr+0GgwzDZNr/SdVm9S2ec621wSuUVgzu3ahINg/7ko5RuVzkK6eUPZ+R/v8xnRowH6SCjKfuNtHONU/7u0si1gryL8D7cb1NYy2yAx7FxWexRFyDendPZB0TsISMwAqV29RSDxG+AfJDvbsfs3mZia352avZmEpxcxILntqncjOdRnVrjEheq8sQ==",
        "status": 0,
        "statusdesc": "2023-06-15 06:14:45",
        "autoapproval": 1,
        "otpappname": "test",
        "demand_perfection": [],
        "created_at": 1686809574,
        "updated_at": 1686809685
    },
    "sensitiveFields": [
        "identity",
        "identitypic",
        "signpic",
        "stcaccount",
        "cardno"
    ],
    "requestId": "B299710699082B7D5EA8E6C793E74649"
}