transactionstring required
createdAtstring date-time required
speed'asap' | 'same_day' | 'standard' | 'card' | 'iban' | 'pix' | 'eft' | 'venmo' | 'paypal' | 'wire' | 'interac' | 'swift' | 'crypto' required
blockchain'solana' | 'eth' | 'polygon' | 'base' | 'user' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' required
transferIdstring 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_in_progress' | 'return_submitted' | 'return_completed'
unclaimedAtstring date-time
When the provider reported the payout as unclaimed: sent to an email or phone with no account behind it, so the recipient has to claim it before the provider cancels it (30 days for PayPal).
awaitingProviderReturnAtstring date-time
When the provider reported that it is holding the payout and will not let us cancel it, so the withdraw stays pending until the provider returns the funds (30 days for PayPal).
expectedDeliveryDatestring date-time required
updatedAtstring date-time required
returnedAtstring date-time
returnAddressstring
Optional end-user address to send a failed-withdraw refund to instead of
the originating wallet. Copied from the CryptoWithdrawSession at creation.
returnGlideSessionIdstring
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).
payoutInitiatedAtstring date-time
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).