Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Exchange transfers

Get exchange transfer by ID

Gets an exchange transfer by ID.

get/exchange_transfers/{id}

Path parameters

idstring uuid required

Unique identifier of the exchange transfer you want to retrieve.

Response

Successfully retrieved exchange transfer.

exchange_transfer_idstring uuid required

Unique identifier of the exchange transfer.

state'EXECUTED' | 'COMPLETED' | 'FAILED' required

State of the exchange transfer.

type'FIRM' | 'INDICATIVE' required

Indicates the exchange transfer's quoted FX rate type.

sender_addressstring required

RippleNet account name and address of the sender, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

receiver_addressstring required

RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

source_amountnumber required

Sending amount of the exchange transfer.

destination_amountnumber required

Receiving amount of the exchange transfer.

source_currencystring required

Sending currency of the exchange transfer.

destination_currencystring required

Receiving currency of the exchange transfer.

end_to_end_idstring required

ID set by the sender that is persisted on all fiat node instances that participated in the transfer.

internal_idstring required

Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending fiat node instance stores this ID.

Example response

{
  "exchange_transfer_id": "e3b20ba4-28ed-4752-990d-e67887bb331e",
  "state": "EXECUTED",
  "type": "INDICATIVE",
  "sender_address": "sf@rn.us.ca.san_francisco",
  "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
  "source_amount": 1,
  "destination_amount": 355,
  "source_currency": "USD",
  "destination_currency": "GBP",
  "fx_transfer_rate": {
    "rate": 0.89,
    "base_currency": "USD",
    "counter_currency": "GBP",
    "rate_type": "BUY"
  },
  "user_info": [
    {
      "node_address": "rn.us.ny.new_york",
      "state": "EXECUTED"
    }
  ]
}