Get exchange transfer by ID

Requisição

Gets an exchange transfer by ID.

Segurança

Bearer

Caminho

idstring, (uuid)obrigatório

Unique identifier of the exchange transfer you want to retrieve.

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

Respostas

Successfully retrieved exchange transfer.

Corpoapplication/json

exchange_transfer_idstring, (uuid)obrigatório

Unique identifier of the exchange transfer.

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

statestringobrigatório

State of the exchange transfer.

Enum:"EXECUTED""COMPLETED""FAILED"

Exemplo:"EXECUTED"

typestringobrigatório

Indicates the exchange transfer's quoted FX rate type.

Padrão:"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.

Exemplo:"INDICATIVE"

sender_addressstringobrigatório

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

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

receiver_addressstringobrigatório

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

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

source_amountnumberobrigatório

Sending amount of the exchange transfer.

Exemplo:1

destination_amountnumberobrigatório

Receiving amount of the exchange transfer.

Exemplo:355

source_currencystringobrigatório

Sending currency of the exchange transfer.

Exemplo:"USD"

destination_currencystringobrigatório

Receiving currency of the exchange transfer.

Exemplo:"GBP"

fx_transfer_rateobjectobrigatório

Rate used to make the exchange transfer.

end_to_end_idstringobrigatório

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

internal_idstringobrigatório

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 objectsobrigatório

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

Resposta

{
  "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": [
    { … }
  ]
}