Skip to main content
GET
Retrieve a Blockchain Payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

blockchain_payment_id
string
required

The ID of the blockchain payment object to be retrieved.

Minimum string length: 5
Pattern: ^blockchain_payment_\w+$

Response

A Blockchain Payment object.

A blockchain payment object representing a fiat or cross-border payment.

id
string

The ID of the Blockchain Payment object.

Pattern: ^blockchain_payment_\w+$
Example:

"blockchain_payment_xyz123"

debtor
object

The source of funds for the transfer, with enriched entity data.

creditor
object

Common creditor fields shared by every payment rail. This is the base of the rail-specific creditor variants; integrations reference BlockchainPaymentCreditor, which selects the correct variant from payment_rail.

creditor_agent
object

Details of the receiving financial institution. Required when creditor.payment_rail is not a blockchain network (solana, base, ethereum). When creditor.payment_rail is swift, address is also required.

amounts
object

The transfer amounts, currency codes, and settlement details.

payment_purpose
object

The purpose of the transfer.

reference
string

The reference message for the transfer. For sepa payments created without a reference, this is a value generated automatically at creation, of the form Payment via Lead <payment id> (the payment's public ID with underscores replaced by hyphens, e.g. Payment via Lead blockchain-payment-2x7abc...). See reference on the create request for the per-rail formatting rules.

Example:

"INV2024001"

status
enum<string>

The current status of the blockchain payment.

Available options:
created,
under_review,
awaiting_funds,
submitted,
posted,
rejected,
canceled
Example:

"created"

rejection_reason
enum<string>

Reason the transfer was rejected, as a closed machine-readable code (BlockchainPaymentStatusReasonCode). Present only when status is rejected. See that enum for the per-value terminal-vs-retryable semantics you need to build the right resubmit logic.

Available options:
payment_could_not_be_processed,
name_mismatch,
name_not_validated,
account_closed
Example:

"name_mismatch"

cancelation_reason
string

Reason the transfer was canceled. Present only if status is canceled.

Example:

"Requested by customer"

created_at
string<date-time>

ISO 8601 format timestamp representing when the blockchain payment was created.

Example:

"2024-06-27T11:22:33Z"

updated_at
string<date-time>

ISO 8601 format timestamp representing when the blockchain payment was last updated.

Example:

"2024-06-27T11:22:33Z"