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. 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 source funds were returned.

Available options:
created,
funded,
claimable,
completed,
failed,
canceled,
refunded
memo
string | null
required
source
object
required
destination
object
required
fees
object[]
required
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: