Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Transfers

Get transfer estimate

Get an estimate of the fee to make an "outbound" transfer from an exchange (connected to xRapid) to an another account outside of RippleNet (such as a bank account). This operation is only available to xCurrent instances enabled as receivers of xRapid payments.

get/transfers/estimate

Query parameters

sender_addressstring

RippleNet address of the xRapid account from which the transfer is funded

receiver_addressstring

RippleNet address representing an account outside of RippleNet to which the transfer amount is sent.

amountnumber

The amount to be transferred

Response

Successfully retrieved estimate of transfer sending fee

transfer_idstring uuid required

Unique identifier of the transfer.

state'PREPARED' | 'EXECUTED' | 'COMPLETED' | 'CANCELLED' | 'FAILED' | 'QUOTED' | 'PENDING' | 'OTHER' required

State of the transfer.<p>QUOTED and PENDING only apply when RippleNet is enabled to receive payments from xRapid. QUOTED represents an outbound transfer fee estimate. PENDING is the state of an outbound transfer executed by RippleNet (via xRapid) but not yet paid out by the digital exchange. If successfully paid out, the state becomes COMPLETED. If not successfully paid out by the digital exchange, the state becomes FAILED. </p>

owner_addressstring required

Owner RippleNet address, if different from the RippleNet address of the sender_address and receiver_address.

sender_addressstring required

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

receiver_addressstring required

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

amountnumber required

Amount transferred, expressed in the account's currency.

internal_idstring

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

end_to_end_idstring

ID that the sender can optionally specify. Persisted on all RippleNet instances that participated in the transfer.

sending_feenumber

Optional sending fee charged by a digital asset exchange for initiating an outbound transfer.

created_atstring date-time

The time when this transfer is created.

labelsstring[]

List of labels associated with this transfer

Example response

{
  "transfer_id": "9eca588f-e89d-4629-82fa-da9c4646310f",
  "state": "EXECUTED",
  "owner_address": "rn.us.ca.san_francisco",
  "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
  "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
  "amount": 15,
  "internal_id": "9cf5aa4b-1e44-436a-ab7c-d399aec905da",
  "end_to_end_id": "fd7559be-aa85-433f-a283-0cd58681cdf0",
  "created_at": "2019-10-01T21:28:28.354Z",
  "user_info": [
    {
      "node_address": "rn.us.ca.san_francisco",
      "state": "EXECUTED",
      "created_at": "2019-10-01T21:28:28.357Z"
    }
  ],
  "labels": [
    "label1",
    "label2",
    "label3"
  ]
}