Sign in
Blockchain Recipient

Create blockchain recipient

Register a blockchain address as a withdrawal destination for a financial account

The recipient is created with a PENDING verification state and cannot receive a payout until screening of the address completes. Registering an address that is already registered to the same financial account returns the existing recipient and its current verification state, rather than creating a second one

post/v1/blockchain_recipients

Request body

chainstring required

The blockchain network that the address belongs to

addressstring required

The blockchain address funds will be withdrawn to

address_tagstring

An optional tag or memo used by some chains to identify the destination of a transfer within a shared address

namestring

The nickname for this blockchain recipient

ownerstring required

Legal name of the business or individual who owns the blockchain address

owner_type'INDIVIDUAL' | 'BUSINESS' required
account_tokenstring uuid required

The financial account the blockchain recipient belongs to

Response

OK, the address was already registered to this financial account

tokenstring uuid required

A globally unique identifier for this blockchain recipient

chainstring required

The blockchain network that the address belongs to

address_tagstring nullable required

An optional tag or memo used by some chains to identify the destination of a transfer within a shared address

external_idstring nullable required

The identifier the recipient is registered under with the payment provider

namestring nullable required

The nickname for this blockchain recipient

ownerstring required

Legal name of the business or individual who owns the blockchain address

owner_type'INDIVIDUAL' | 'BUSINESS' required
account_tokenstring uuid nullable required

The financial account the blockchain recipient belongs to, or null when the recipient is registered against the program rather than a financial account

program_idstring uuid required

Globally unique identifier for the program the blockchain recipient is associated with

createdstring date-time required

An ISO 8601 string representing when this blockchain recipient was created

updatedstring date-time required

An ISO 8601 string representing when this blockchain recipient was last updated

state'ENABLED' | 'CLOSED' | 'PAUSED' required
verification_state'PENDING' | 'ENABLED' | 'FAILED_VERIFICATION' | 'INSUFFICIENT_FUNDS' required

Changes

Changed in 2 of the 83 revisions of this API.21

  • 76b96ae9a0b92See the full diff
    • ▲

      the response property account_token became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property account_token became nullable for the status 201

      response-property-became-nullable

  • 94be180633be1See the full diff
    • ○

      endpoint added

      endpoint-added