RIripple
Fiat instructions

Create a buy instruction

Changed on

Declares an incoming fiat payment under an id you choose, and returns the memo to quote in that payment's reference field so the funds can be attributed and the RLUSD minted to the wallet you named.

You generate the UUID for {id} client-side and it becomes the instruction's identity. Reusing an id that already exists is rejected with a 409 carrying code FIAT_INSTRUCTION_ALREADY_EXISTS.

Only a CRYPTO destination may be created here. Redemption (FIAT) instructions are created by Ripple when your redemption is registered, and are read-only to you.

Put the memo verbatim into the payment's reference field, and nothing else. A RIPxxxxxxx wallet ripId token in the payment's free text takes precedence over a memo during matching, which would credit that wallet and leave this instruction UNUSED.

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

Request

Path parameters

idstring uuid required

The id you are creating the instruction under, as a UUID you choose.

Request body

currencystring required

ISO-4217 fiat currency code of the payment you intend to send.

Example request

{
  "currency": "USD",
  "destination": {
    "walletRipId": "RIP0000001"
  }
}

Response

Instruction created; its memo is in the response

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