Get exchange transfer by ID

Request

Gets an exchange transfer by ID.

Security

Bearer

Path

idstring, (uuid)required

Unique identifier of the exchange transfer you want to retrieve.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/exchange_transfers/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved exchange transfer.

Bodyapplication/json

exchange_transfer_idstring, (uuid)required

Unique identifier of the exchange transfer.

Example:"e3b20ba4-28ed-4752-990d-e67887bb331e"

statestringrequired

State of the exchange transfer.

Enum:"EXECUTED""COMPLETED""FAILED"

Example:"EXECUTED"

typestringrequired

Indicates the exchange transfer's quoted FX rate type.

Default:"FIRM"

Enum Value	Description
FIRM	A firm exchange rate ensures that the quoted and delivered transfer amounts are equal.
INDICATIVE	An indicative exchange rate allows for movement between quoted rate and transfer execution, such that the quoted amount and delivered amount may differ.

Example:"INDICATIVE"

sender_addressstringrequired

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

Example:"sf@rn.us.ca.san_francisco"

receiver_addressstringrequired

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

Example:"sf_gbp@rn.us.ca.san_francisco"

source_amountnumberrequired

Sending amount of the exchange transfer.

Example:1

destination_amountnumberrequired

Receiving amount of the exchange transfer.

Example:355

source_currencystringrequired

Sending currency of the exchange transfer.

Example:"USD"

destination_currencystringrequired

Receiving currency of the exchange transfer.

Example:"GBP"

fx_transfer_rateobjectrequired

Rate used to make the exchange transfer.

end_to_end_idstringrequired

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

internal_idstringrequired

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

user_infoArray of objectsrequired

Custom information set by a RippleNet address involved in the exchange transfer.

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"
  },
  "end_to_end_id": "string",
  "internal_id": "string",
  "user_info": [
    { … }
  ]
}