Create withdrawal request

POST

/v2/send/withdrawals

• Staging
• Development

Create a new withdrawal request to convert USDC to fiat

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

Request Body ^required

object

corridorId

required

Corridor ID for this withdrawal

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

userId

required

End user ID who owns this withdrawal

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

amount

required

Amount in base units (smallest unit). For USDC with 6 decimals: 1.00 USDC = 1000000. Must be provided as base units, not decimal format.

string

1000000

currency

required

Currency code (e.g., USDC)

string

USDC

Responses

201

Withdrawal created successfully

object

id

required

Withdrawal ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

corridorId

required

Corridor ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

organisationId

required

Organisation ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

userId

required

User ID

string format: uuid

e271bc5c-f870-44cd-8462-54280d0411f6

status

required

Withdrawal status

string

Allowed values: created networkinprogress networkcompleted networkfailed payoutinprogress payoutcompleted payoutfailed banktransferinprogress banktransfercompleted banktransferfailed completed failed

amount

required

Amount in USDC

string

1000.00

currency

required

Currency code

string

USDC

networkDetails

Network transaction details (e.g., contractTransactionHash, blockNumber, gasUsed)

object

payoutDetails

Payout details (e.g., payoutId, payoutReference, payoutMethod)

object

bankTransferDetails

Bank transfer details (e.g., transferReference, bankCode, clearingDate)

object

failureReason

Failure reason if failed

string

networkCompletedAt

Network completion timestamp

string format: date-time

payoutCompletedAt

Payout completion timestamp

string format: date-time

bankTransferCompletedAt

Bank transfer completion timestamp

string format: date-time

completedAt

Completion timestamp

string format: date-time

createdAt

required

Creation timestamp

string format: date-time

updatedAt

required

Last update timestamp

string format: date-time

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error