Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apidocs.bridge.xyz/llms.txt

Use this file to discover all available pages before exploring further.

The transfer status refers to the current state of a transfer. There are several possible states that a transfer can be in, including:
StatusDescription
awaiting_fundsBridge is waiting to receive funds from the customer before processing the transfer. This applies to incoming crypto deposits, wires, or ACH pushes.
in_reviewA rare, temporary state triggered when transfer data needs further confirmation. Typically resolves in seconds; otherwise, Bridge will reach out within 24 hours.
funds_receivedBridge has received the funds and is preparing to move them on the customer’s behalf.
payment_submittedBridge submitted the crypto payment.

Important: the transaction hash provided at this stage may be preliminary and is not guaranteed to be final. Please use the transaction hash returned in the payment_processed state as the finalized transaction hash.
payment_processedThe transfer is complete and funds have been successfully delivered to the destination.
undeliverableBridge was unable to deliver funds due to an issue like an invalid account or unsupported asset at the destination.
returnedThe payment was sent but failed. Funds have returned to Bridge and a refund to the sender is underway.
missing_return_policyIn order for us to return the crypto deposit, we need you to configure a crypto return policy with us. Please refer here.
refundedThe payment was refunded Bridge no longer has the funds.

This means the payment was either sent back to the original sender, refunded based on the configured crypto return policy, or sent back to the originating Bridge wallet or Bridge prefunded account.
refund_in_flightA refund has been initiated and is in progress.
refund_failedThe refund attempt failed. This usually occurs for fiat deposits — means the sending bank account Bridge is refunding to is closed, deactivated, or suspended. Before escalating to Bridge, please have your customer contact their sending bank to confirm the account’s status. Bridge can only refund fiat deposits to the original sending account, so we’ll need that account to be reachable before we can retry.
canceledThe transfer was canceled. This can only happen from the awaiting_funds state via the DELETE /v0/transfers/{transferID} endpoint.
errorA problem occurred that blocked processing. This typically requires manual review or developer action.
  • Please note that a transfer will always progress from awaiting_fundsfunds_receivedpayment_submittedpayment_processed. It can never go backwards.
  • States including returned, refunded, undeliverable, or error indicate exception paths.