Sign in

v3

latestOpenAPI 3.1.02026-08-06186981679.4 KB
merchant

Get Withdraws

Get All Withdraws associated with the merchant

get/merchant/withdraws

Query parameters

sincestring
untilstring
pagenumber double
statusstring
searchstring
sortBy'createdAt' | 'amount'
sortDirectionnumber double
speedstring
providerstring
merchantIdstring
limitnumber double
bankSettlementsOnlyboolean

Headers

Authorizationstring required

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Response

Ok

transactionstring required
createdAtstring date-time required
speed'asap' | 'same_day' | 'standard' | 'card' | 'iban' | 'pix' | 'eft' | 'venmo' | 'paypal' | 'wire' | 'interac' | 'swift' required
idempotencyKeystring
blockchain'solana' | 'eth' | 'polygon' | 'base' | 'user' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' required
walletstring required
transferIdstring required
accountIdstring required
usdToForeignExchangeRatenumber double required

This is the conversion rate from USD to the foreign currency. For example 0.90 = 0.90 USD/GBP

So if you want to convert GBP to USD you would multiply 15 GBP * 0.90 USD/GBP = 13.5 USD If you want to convert USD to GBP you would multiply 13.5 USD * 1/0.90 GBP/USD = 15 GBP

invoiceIdstring required

Set on completion when merchantPaidFees were not settled inline: the Accruing invoice the fees were attached to. Mirrors the refund/chargeback/payment invoicing pattern — presence of invoiceId marks the fees as billed.

returnStatus'pending_return' | 'return_completed'
expectedDeliveryDatestring date-time required
updatedAtstring date-time required
providerstring required
returnTransactionstring
returnedAtstring date-time
userIdstring
detailMessagestring
errorDatastring
pinstring

Only used for Interac payments if the user must provide their bank a PIN to claim the transfer.

isFirstPartyboolean

True when this withdraw was a first-party payout (the merchant withdrawing from their own settlement wallet).

payoutInitiatedboolean
orchestrationTraceIdstring
achTraceIdstring required

The provider's ACH trace ID for this withdraw, when available. Used by support to give customers a reference the receiving bank can look up. Currently populated for Braid ACH payouts (transaction.ach.traceNumber), AptPay ACH payouts (the settled webhook's os-trace), and AptPay push-to-card payouts (the transaction's RRN / Retrieval Reference Number).