LIlithic-com
Blockchain Recipient

Get blockchain recipient

Changed on

Get a blockchain recipient by token

Use this to poll the verification_state after registering an address: a recipient cannot receive a payout until screening completes and moves it out of PENDING

get/v1/blockchain_recipients/{blockchain_recipient_token}

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/blockchain_recipients/{blockchain_recipient_token}
  • Auth
    API key in header Authorization

Path parameters

blockchain_recipient_tokenstring uuid required

Response

OK

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