Skip to main content
POST
Create a Withdrawal Request

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Headers

Idempotency-Key
string
required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Body

application/json

Submit a withdrawal request from a quote.

quoteId
string
required

The quote to withdraw from (qt_ prefix).

webSessionId
string

Web session id of the person submitting, for fraud screening.

deviceFingerprint
string

Device fingerprint of the person submitting, for fraud screening.

metadata
object

Free-form key-value pairs stored on the request and echoed back on reads.

Response

The request has succeeded and a new resource has been created as a result.

A withdrawal submitted from a quote. When the project requires approval it waits for a second person, and approving creates the transaction; otherwise submitting creates the transaction at once.

id
string
required

Withdrawal request ID (wdr_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
quoteId
string
required

The quote the request was submitted from (qt_ prefix). Read it for the full destination, including the bank rail, when building the approval quote.

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
status
enum<string>
required

Current status.

Available options:
pendingApproval,
approved,
rejected,
cancelled
customer
object
required

The customer the withdrawal is for.

source
OMS wallet · object
required

The funding side, with resolved instrument detail.

destination
OMS wallet · object
required

The receiving side, with resolved instrument detail.

pricing
object
required

Pricing from the latest quote.

createdBy
object
required

Who submitted the request.

createdAt
string<date-time>
required

When the request was created.

updatedAt
string<date-time>
required

When the request was last updated.

reviewedBy
object

Who approved or rejected the request.

reviewedAt
string<date-time>

When the request was approved or rejected. Set for approved and rejected requests only.

transactionId
string

The transaction an approved request created (txn_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
transaction
object

The transaction an approved request created. Present on submit and approve responses only.

metadata
object

Free-form key-value pairs supplied at submission.