Skip to main content
POST
Refresh funding instructions

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

id
string<uuid>
required

The order id, which is the quoteId it was created from.

Response

The order.

id
string<uuid>
required

The order id. Equal to the quoteId it was created from.

organizationId
string<uuid>
required

The organization the order belongs to.

status
enum<string>
required

created: waiting for the source funds. funded: source funds received. sourcingLiquidity: source funds received, and the payout is waiting while we add funds to our payout account, usually by the next business day. It usually happens only for larger orders, and generally only for payouts to a bank account. The order stays in this status until it is completed or failed. claimable: delivered, waiting for the customer to claim; see claimInstructions. completed: delivered. failed: could not be completed; see failure. canceled: canceled before completion. refunded: the order ended and we sent its source funds back. A returned deposit in returnedDeposits does not end the order.

Available options:
created,
funded,
sourcingLiquidity,
claimable,
completed,
failed,
canceled,
refunded
memo
string | null
required
source
object
required
destination
object
required
fees
object[]
required
returnedDeposits
object[]
required

Deposits we sent back because they did not match the order, oldest first: a deposit from the order's source wallet for the wrong amount, or a bank transfer with this order's reference for the wrong amount. The order stays open and waits for a deposit that matches. We return at most one deposit from a wallet per order, and only a single transfer of the order's asset from the source wallet. A second wrong deposit, or a deposit with more than one transfer, sender or asset, is held for our team and not sent back automatically. We never send back a deposit from any other wallet. Empty when we returned nothing.

fundingInstructions
object
required

How the source funds the order.

claimInstructions
stellarClaimableBalance · object | null
required

Set while the order is claimable. Otherwise null.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
completedAt
string<date-time> | null
required
failure
object

Present only when status is failed.

authorization
object | null

Set while the order waits for the account holder to approve a transfer we built. Otherwise null. Approve it with POST /organization/{organizationId}/order/{id}/authorization.

Example: