Skip to main content

Payer

idstring<uuid>required
externalIdstringrequired

Possible values: non-empty

accountIdstring<uuid>required
typestringrequired

Possible values: [INDIVIDUAL, BUSINESS]

fullLegalNamestringrequired

Possible values: non-empty

emailAddressstring | nullnullable
phoneNumberstring
countrystringrequired

Possible values: non-empty

notificationEnabledboolean
addressstring
areaOrCitystring
provinceOrStatestring
postalCodestring
registrationNumberstring
identificationDocumentTypestring

Identification document type for an individual crypto payer

Possible values: [NATIONAL_ID, PASSPORT, DRIVING_LICENSE]

identificationDocumentNumberstring
cryptoEnabledbooleanrequired
acceptedPaymentTermsbooleanrequired

Whether this payer has accepted the payment terms shown on the Hubpay checkout

paymentTermsAcceptedAtstring<date-time>

When this payer accepted the payment terms. Absent if they never have

Example: 2023-01-01T00:00:00Z
Payer
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "externalId": "string",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "INDIVIDUAL",
  "fullLegalName": "string",
  "emailAddress": "string",
  "phoneNumber": "string",
  "country": "string",
  "notificationEnabled": true,
  "address": "string",
  "areaOrCity": "string",
  "provinceOrState": "string",
  "postalCode": "string",
  "registrationNumber": "string",
  "identificationDocumentType": "NATIONAL_ID",
  "identificationDocumentNumber": "string",
  "cryptoEnabled": true,
  "acceptedPaymentTerms": true,
  "paymentTermsAcceptedAt": "2023-01-01T00:00:00Z"
}