Withdrawals
Last updated
Last updated
Convert USD stablecoins to local African currencies using Direct Ramp withdrawals. This guide covers the complete withdrawal lifecycle, from initiation to settlement.
Get a valid
Initiate withdrawal with quote
Wait for withdrawal to be processed
Mark withdrawal as received
Use initiateRampQuoteWithdrawal
to create a new withdrawal request.
rampQuote
ID!
Yes
Quote ID from rampQuote
query
paymentMethod
ID!
Yes
reference
String
No
Your unique reference for reconciliation
id
ID!
Global ID for the deposit request
status
String!
Current status (see Status Lifecycle)
agent
String!
Assigned payout agent
paymentDetails
String!
User's payout instructions (bank details, mobile money number)
exchangeRate
Decimal!
Locked FX rate for this withdrawal
amountLocal
Decimal!
Amount in local currency
amountUsd
Decimal!
Amount in USD stablecoins
picked_up
Initial state
Awaiting payout
completed
Funds settled
Customer received funds
canceled
Manually canceled
-
Use markWithdrawalAsReceived
to allow your customer to indicate that they have received the funds.
paymentRequest
ID!
Yes
Withdrawal request ID
Your customer's payment method ID ()