Skip to main content
GET
List financial accounts available to fund a payout

Authorizations

Authorization
string
header
required

ES256 JWT bearer token, minted fresh per request.

See Authentication for the claims, including the nonce, the request signature, the two scopes, and which status means what.

X-Request-Signature
string
header
required

Body-bound ES256 signature over the request, required alongside the bearer token on every call. Base64url of an IEEE P-1363 fixed 64-byte r‖s signature.

See Authentication for the canonical string it signs, including the JWT nonce that binds it to the bearer token.

Headers

X-App-Mode
enum<string>
default:SANDBOX

Which environment this request runs against.

An omitted header means SANDBOX. Send it explicitly on every call rather than relying on that default, so live money movement is never missed because a header was forgotten: a live API key that reaches a live instance without an explicit LIVE value is rejected with AUTH_API_KEY_SANDBOX_REQUIRED. When present, the value must be SANDBOX or LIVE, matched without regard to case. Any other value, including an empty one, returns 400 INVALID_APP_MODE; details.received echoes the value you sent.

Available options:
SANDBOX,
LIVE
Example:

"SANDBOX"

X-Request-Id
string

Your own correlation id for this request, returned on the response exactly as you sent it.

Optional. Where you send none the response omits it, and the X-Trace-Id response header is the handle to correlate on instead.

Example:

"9f2c1b7e-4d3a-4f81-9c2e-6b0a5d7e1f34"

Query Parameters

receiveCurrency
string
required

Currency the payout settles in on the receive side. The response is narrowed to the financial accounts that can source a payout delivering this currency.

Pattern: ^[A-Z0-9]{2,15}$
Example:

"INR"

Response

The financial accounts available to fund a receiveCurrency payout (non-paginated). May be empty when your organization is enabled for the currency but has no eligible financial account.

The financial accounts your organization can currently fund a receiveCurrency payout from, one entry per FinancialAccount. See listFinancialAccounts for pagination and empty-list semantics.

data
object[]
required