Get bank details
Changed onReturns the Ripple bank account to wire fiat to when buying stablecoin - the same object embedded as bankDetails on every fiat instruction, served on its own.
The bank belongs to your account rather than to any one instruction, so this is the endpoint to call when you want the wire destination without creating or listing an instruction: rendering a "where to send funds" panel, caching the details, or checking them on a schedule.
This endpoint does not return a memo. A memo is per-payment and comes only from a fiat instruction; the bank details alone are not enough to have a payment attributed. Create an instruction for every payment you intend to send.
Unlike the embedded bankDetails field, which is simply absent on any failure so that the instruction and its memo still come back, this endpoint keeps its failures apart: a 404 is a settled answer and retrying will not change it, a 502 is transient.
Request
- Base URLhttps://api.ripple.com
- AuthOAuth 2Client credentialsToken URLhttps://api.ripple.com/v2/oauth/tokenScopesrlusd_customers:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
The Ripple bank account to wire fiat to
Example response
{
"bankName": "ABC Bank",
"accountName": "RIPPLE LABS CAYMAN LTD.",
"accountNumber": "000000",
"swiftBicCode": "ABCBUS33XXX",
"routingNumber": "0000",
"bankAddress": {
"street": "1 Example Street",
"city": "Singapore",
"state": "Singapore",
"zipCode": "000000",
"country": "Singapore"
}
}Changes
- info
endpoint added
- info