Skip to main content
GET
Get payment status

Authorizations

Authorization
string
header
required

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

Query Parameters

payment_id
string
required

Payment identifier to check

enable_withdraw_pending
string

Controls whether the WITHDRAW_PENDING status is reported for this payment.

Response

Payment status retrieved successfully!

payment_id
string
required
org_id
string
required

Organization identifier

status
enum<string>
required
Available options:
PENDING,
COMPLETE,
FAILED,
EXPIRED,
WITHDRAW_PENDING,
WITHDRAWN,
TAINTED,
UNCONFIRMED
funded
boolean
required

Whether the payment has been funded

created_at
string<date-time>
required
updated_at
string<date-time>
required
initiate_fund_by
string<date-time>
required

Deadline for funding the payment.

quoted
object
required
fulfilled
object
required
current_prices
object
required

Mapping of asset symbols to their unit prices

Example:
price_currency
string
required

Fiat asset used for pricing

Example:

"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

processing_addresses
object[]
required
owner_chain
string
required

Chain identifier for the owner

owner_address
string
required

Address of the owner of the payment

destination_address
string
required

Address of the destination of the payment

withdrawals
object[] | null
required

Withdrawals associated with this payment, or null.

client_redirect_url
string | null
required

Client redirect URL

geolocation
object | null
required

Geolocation of the payment owner, or null.

declaration
object | null
required

Declaration object

completed_at
string<date-time>
quote_request
object

The original quote request.

customer_id
string

ID of the customer who created the payment

label
string

Optional payment label

Maximum string length: 255
next_instruction
object

Instruction payload that returns the funding pages if the payment requires funding.

Example:
issues
object[]

Payment validation issues

parent_payment_id
string<uuid>

Parent payment reference