Skip to main content

PayerUpdateRequest

emailAddressstring

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 if payer is crypto enabled and type BUSINESS

Possible values: <= 255 characters

registrationNumberstring

Optional corporate registration number for a BUSINESS payer

Possible values: <= 255 characters

identificationDocumentTypestring

Optional identification document type for an INDIVIDUAL payer. Must be provided with identificationDocumentNumber.

Possible values: [NATIONAL_ID, PASSPORT, DRIVING_LICENSE]

identificationDocumentNumberstring

Optional identification document number for an INDIVIDUAL payer. Must be provided with identificationDocumentType.

Possible values: <= 255 characters

cryptoEnabledbooleanrequired

Set to true to allow this payer to make cryptocurrency payments

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