Skip to main content

PayerUpdateRequest

emailAddressstring<email>

Email address of the payer. Optional. Required to refresh the payment session for a crypto-enabled payment request.

Possible values: <= 255 characters

phoneNumberstring

Required if payer is crypto enabled

Possible values: <= 255 characters

notificationEnabledboolean

Enable to send transaction-update emails to this payer

addressstring

Required if payer is crypto enabled

Possible values: <= 255 characters

areaOrCitystring

Required if payer is crypto enabled and type INDIVIDUAL

Possible values: <= 255 characters

provinceOrStatestring

Required if payer is crypto enabled and type BUSINESS

Possible values: <= 255 characters

postalCodestring

Required for a crypto-enabled BUSINESS payer outside the UAE. Optional when the payer country is AE. Leave it blank if not applicable; do not send N/A or a made-up postcode.

Possible values: <= 255 characters

registrationNumberstring

Optional corporate registration number for a BUSINESS payer. Supply it when known for a crypto-enabled payer to avoid requesting it during checkout.

Possible values: <= 255 characters

identificationDocumentTypestring

Optional identification document type for an INDIVIDUAL payer. Supply it when known for a crypto-enabled payer to avoid requesting it during checkout. Must be provided with identificationDocumentNumber.

Possible values: [NATIONAL_ID, PASSPORT, DRIVING_LICENSE]

identificationDocumentNumberstring

Optional identification document number for an INDIVIDUAL payer. Supply it when known for a crypto-enabled payer to avoid requesting it during checkout. Must be provided with identificationDocumentType.

Possible values: <= 255 characters

cryptoEnabledbooleanrequired

Set to true to allow this payer to make cryptocurrency payments

PayerUpdateRequest
{
"emailAddress": "user@example.com",
"phoneNumber": "string",
"notificationEnabled": true,
"address": "string",
"areaOrCity": "string",
"provinceOrState": "string",
"postalCode": "string",
"registrationNumber": "string",
"identificationDocumentType": "NATIONAL_ID",
"identificationDocumentNumber": "string",
"cryptoEnabled": true
}