Skip to content
FSCO Docs

List withdrawals

GET
/v2/send/withdrawals

List all withdrawals for the current user with pagination

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page[number]
number
default: 1

Page number (starts at 1)

Example
1
page[size]
number
default: 10

Items per page

Example
10
status
string
Allowed values: created networkinprogress networkcompleted networkfailed payoutinprogress payoutcompleted payoutfailed banktransferinprogress banktransfercompleted banktransferfailed completed failed

Filter by withdrawal status

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of withdrawals

object
items
required

List of withdrawals

Array<object>
object
id
required

Withdrawal ID

string format: uuid 
82c4fce1-d2c7-48cb-a647-6993dbe37819
corridorId
required

Corridor ID

string format: uuid 
82c4fce1-d2c7-48cb-a647-6993dbe37819
organisationId
required

Organisation ID

string format: uuid 
82c4fce1-d2c7-48cb-a647-6993dbe37819
userId
required

User ID

string format: uuid 
82c4fce1-d2c7-48cb-a647-6993dbe37819
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
page
required

Pagination info

object
number
required

Page number (starts at 1)

number
1
size
required

Items per page

number
10
totalPages
required

Total number of items

number
100
totalCount
required

Total number of pages

number
10
hasNext
required

Whether there is a next page

boolean
true
hasPrev
required

Whether there is a previous page

boolean

400

Section titled “400 ”

Bad Request

401

Section titled “401 ”

Unauthorized

403

Section titled “403 ”

Forbidden

404

Section titled “404 ”

Not Found

500

Section titled “500 ”

Internal Server Error