RIripple
Fiat instructions

Get a fiat instruction

Changed on

Returns a single fiat instruction by id, including its memo and current status. Works for both buy and redemption instructions belonging to your account.

Only your own instructions are visible. An id belonging to another customer, a deleted instruction, and an id that never existed are all reported as 404 FIAT_INSTRUCTION_NOT_FOUND.

get/v1/stablecoin/fiat-instructions/{id}

Request

Path parameters

idstring uuid required

Fiat instruction UUID

Response

Instruction found

idstring uuid required

Instruction identifier. You supply it in the PUT path for a buy instruction; Ripple generates it for a redemption instruction.

memostring required

Routing memo that correlates a fiat payment back to this instruction - quote it verbatim in the payment's reference field so the funds can be attributed. Assigned by Ripple and globally unique: RL followed by 14 Crockford base32 characters, 16 in total. Crockford base32 excludes I, L, O and U to avoid transcription ambiguity.

currencystring nullable

ISO-4217 fiat currency code. Always present on a buy instruction. May be absent on a redemption instruction whose originating fiat payment carries no currency.

status'UNUSED' | 'USED' | 'DELETED' | 'CANCELED' required

Lifecycle status. A new instruction is UNUSED and never expires; it becomes USED when its fiat payment claims it, or CANCELED when Ripple cancels the payment behind it. Both are terminal.

DELETED exists on the underlying record but is never served: the reads exclude deleted instructions outright, so a deleted instruction returns 404 FIAT_INSTRUCTION_NOT_FOUND rather than a DELETED status.

createdAtstring date-time required

Timestamp when the instruction was created

Example response

{
  "memo": "RL7Q3K9ZP2MTX4VB",
  "currency": "USD",
  "destination": {
    "walletRipId": "RIP0000001"
  },
  "bankDetails": {
    "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