Skip to main content

PayerCreateRequest

externalIdstringrequired

External ID of the payer

Possible values: <= 36 characters

Example: EX123
typestringrequired

The type of the payer

Possible values: [INDIVIDUAL, BUSINESS]

fullLegalNamestringrequired

Full legal name of the payer

Possible values: <= 255 characters

emailAddressstringrequired

Email address of the payer

Possible values: <= 255 characters

phoneNumberstring

Required if payer is crypto enabled

Possible values: <= 255 characters

countrystringrequired

Country of the payer

Possible values: non-empty

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

cryptoEnabledbooleanrequired

Set to true to allow this payer to make cryptocurrency payments

PayerCreateRequest
{
  "externalId": "EX123",
  "type": "INDIVIDUAL",
  "fullLegalName": "string",
  "emailAddress": "string",
  "phoneNumber": "string",
  "country": "string",
  "notificationEnabled": true,
  "address": "string",
  "areaOrCity": "string",
  "provinceOrState": "string",
  "postalCode": "string",
  "cryptoEnabled": true
}