Complete transfer

Environment	Domaing Prefix	Domain	Base URL
Test	`aperture.test`	`ripplexcurrent.com`	`https://aperture.test.ripplexcurrent.com`
UAT	`aperture.uat`	`ripplexcurrent.com`	`https://aperture.uat.ripplexcurrent.com`
Production	`aperture.prod`	`ripplexcurrent.com`	`https://aperture.prod.ripplexcurrent.com`

Auditing

Use these operations to audit your accounts.

Operation	Method	Description
Get audits	GET	Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance.
Get event trail for payment	GET	Gets an audit trail of a payment's state changes on a local RippleNet instance.

Operations

Balances and statements

Use these operations to view balances and statements for a ledger.

Operation	Method	Description
Get balances	GET	Get balances for local and remote accounts owned by a RippleNet address.
Get ledger balances	GET	Get balances for ledger owned by a RippleNet address.
Get statement	GET	Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
Get statement by external account ID	GET	Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
Get ledger account statement	GET	Get statement for a specified Ledger Account

Operations

Beneficiary confirmation

Use these operations to perform beneficiary confirmations.

Operation	Method	Description
Get account lookup by status	GET	Get Account Lookup entities by status and other filters.
Initiate account lookup	POST	Creates an Account Lookup request to validate a beneficiary's account details before sending a payment.
Complete account lookup	POST	Posts an Account Lookup response to validate a beneficiary's account details before payment.
Get account lookup by ID	GET	Gets an Account Lookup entity for its `account_lookup_id` value.

Operations

Diagnostics

Use these operations to view RippleNet Server health.

Operation	Method	Description
Check health	GET	Gets the health status of the xCurrent server.
Check heartbeat	GET	Gets the health status of the xCurrent server's peers.

Operations

Exchange transfers

Use these operations to manage exchange transfers.

Operation	Method	Description
Get exchange transfers	GET	List all exchange transfers.
Execute exchange transfer	POST	Execute an exchange transfer to move funds from one of your accounts in one currency, to another one of your accounts in another currency.
Get exchange transfer quote	POST	Requests a quote for an exchange transfer.
Complete exchange transfer	POST	Updates the status of an exchange transfer to `COMPLETED`. Make this request once the exchange transfer has been made on both the ledger and on internal systems.
Get exchange transfer by ID	GET	Gets an exchange transfer by ID.

Operations

Fees

Use these operations to configure fees.

Operation	Method	Description
Get fees	GET	List all fees.
Create fee	POST	Creates a fee.
Get fee by ID	GET	Gets a fee by ID.
Update fee	PUT	Updates an existing fee.
Delete fee	DELETE	Deletes a fee. Once deleted, a fee cannot be accessed.

Operations

Non-orchestration payments

Operations

Orchestration payments

Operations

Payment expiration

Use these operations to manage payment expirations.

Operation	Method	Description
Get payment expiry by ID	GET	Gets the time to live (ttl) of a payment expiry in seconds.
Update payment expiry	PUT	Updates the time to live (ttl) of a payment expiry in seconds.
Delete payment expiry	DELETE	Deletes a payment expiry.
Get payment expiries	GET	Returns all configured payment expiries.
Create payment expiry	POST	Creates a payment expiration window, or time to live (ttl), in seconds.

Operations

Payout method

Payout Method operations let receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods.

Operation	Method	Description
Create payout method	POST	Creates a payout method. For example, `LOCAL_RAILS`.
Get payout methods	GET	Returns a list of payout methods created by a receiving partner.
Get payout method by ID	GET	Returns a payout method by its ID.
Update payout method	PUT	Updates a payout method.
Delete payout method	DELETE	Deletes a payout method.
Get all categories	GET	Returns all the payout method categories.

Operations

Platform accounts

Use these operations to configure your RippleNet platform accounts.

Operation	Method	Description
Create platform	POST	Creates a RippleNet platform that represents a financial entity that holds accounts in the real world. For example, a Bank, Exchange, or Wallet provider.
Get all platforms	GET	Returns a list of all active RippleNet platforms.
Get platform by platform ID	GET	Get a RippleNet platform by its platform ID.
Update platform	PUT	Updates a RippleNet platform.
Delete platform by platform ID	DELETE	Deletes a RippleNet platform by its platform ID.
Create platform account	POST	Creates a RippleNet platform account, which represents a real-world account owned by a financial entity.
Get platform accounts	GET	Returns a paged list of all active RippleNet platform accounts.
Get platform account by platform account ID	GET	Gets a RippleNet platform account by its platform account ID.
Update platform account	PUT	Updates a RippleNet platform account.
Delete platform account by platform account ID	DELETE	Deletes a RippleNet platform account by its platform account ID.
Get platform accounts balances	GET	Get balances for local Platform Accounts
Get platform account statement	GET	Get statement for a specified Platform Account

Operations

Pool accounts

Use these operations to configure your RippleNet pool accounts.

Operation	Method	Description
Get all pool accounts	GET	Returns a list of all pool accounts on a RippleNet node.
Get pool account by pool account ID	GET	Get a pool account by its pool account ID.

Operations

Quote expiration

Use these operations to manage quote expirations.

Operation	Method	Description
List quote expiries	GET	Returns all configured quote expiries.
Create quote expiry	POST	Creates a quote expiration window, or time to live (ttl), in seconds.
Get quote expiry	GET	Gets the configured quote expiration window, or time to live (ttl), in seconds.
Update quote expiry	PUT	Sets a quote expiration window, or time to live (ttl), in seconds.

Operations

Quotes

Use these operations to manage your quotes.

Operation	Method	Description
Accept quote	POST	Accepts a quote ID to start the payment process.
Get quotes	GET	Gets a list of quotes.
Get quote by quote ID	GET	Gets a quote by ID.
Create quote collection	POST	Creates a collection of quotes for a proposed payment.
Get quote collection by ID	GET	Gets a quote collection that was created for a proposed payment.

Operations

Rates

Use these operations to manage your rates.

Operation	Method	Description
Get rates	GET	Gets a list of configured exchange rates.
Create rate	POST	Creates an exchange rate for a specified currency pair.
Get rate by ID	GET	Gets a configured exchange rate by ID.
Update rate	PUT	Updates an existing exchange rate.
Delete rate	DELETE	Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed.

Operations

Request for payment

Use these operations to interact with your payment requests.

Operation	Method	Description
Get requests for payment	GET	Gets requests for payment that match the query parameters.
Send request for payment	POST	Sends a new request for payment.
Get request for payment by ID	GET	Gets a request for payment by request for payment ID.
Accept request for payment	POST	Accepts a request for payment.
Fail request for payment	POST	Fails a request for payment.

Operations

Transfers

Use these operations to manage your transfers.

Operation	Method	Description
Get transfers	GET	Gets a list of transfers.
Get transfer estimate	GET	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).
Get transfer by ID	GET	Gets a transfer by ID.
Execute transfer	POST	Transfers funds between accounts.
Complete transfer	POST	Updates the state of a transfer to `COMPLETED`.
Add transfer labels	PUT	Adds a list of labels to the transfer. To retrieve transfers by label, see Get transfers
Delete transfer labels	DELETE	Deletes one or more existing labels from the transfer.

Operations

Get transfers

Request

Gets a list of transfers.

Security

Bearer

Query

pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page. Set it to 0 to get the first page of results.

Default 0

sizeinteger[ 1 .. 100 ]

Number of objects to return per page.

Default 20

with_labelsArray of strings

Returns transfers that contain any of the specified labels.Example - ?with_labels=LABEL1,LABEL2

without_labelsArray of strings

Returns transfers that do not contain any of the specified labels.

include_labelsboolean

Returns labels added to each Transfer object. By default labels are not returned. Example - ?with_labels=LABEL1&include_labels=true

Default false

statestring

Filter by transfer states.

Enum"PREPARED""EXECUTED""COMPLETED""FAILED""PENDING"

internal_idstring

Optional parameter for filtering with internalId.

sender_end_to_end_idstring

Optional parameter for filtering with sender end to end id.

sort_fieldstring

Field used to sort the results.

Enum"CREATED_AT""MODIFIED_AT"

sort_directionstring

Sort direction.

Enum"ASC""DESC"

accountstring

RippleNet account which is involved in transfer

transfer_account_rolestring

by default account parameter would search both sender and receiver of transfer and bring the results. This is to restrict the account search to sender or receiver of a transfer

Enum"SENDING""RECEIVING"

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers?page=0&size=20&with_labels=string&without_labels=string&include_labels=false&state=PREPARED&internal_id=string&sender_end_to_end_id=string&sort_field=CREATED_AT&sort_direction=ASC&account=string&transfer_account_role=SENDING' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned transfers.

Bodyapplication/json

firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger(int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

directionstring

Direction of the sort

Example: "ASC"

propertystring

ignoreCaseboolean

nullHandlingstring

Example: "NULLS_FIRST"

ascendingboolean

Example: true

descendingboolean

Example: false

contentArray of objects

Provides an array of transfer objects.

transfer_idstring(uuid)required

Unique identifier of the transfer.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"

statestringrequired

State of the transfer.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.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED""PENDING""OTHER"

Example: "EXECUTED"

owner_addressstringrequired

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

Example: "rn.us.ca.san_francisco"

sender_addressstringrequired

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

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

receiver_addressstringrequired

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

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

amountnumberrequired

Amount transferred, expressed in the account's currency.

Example: 15

internal_idstring

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

Example: "9cf5aa4b-1e44-436a-ab7c-d399aec905da"

end_to_end_idstring

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

Example: "fd7559be-aa85-433f-a283-0cd58681cdf0"

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.

Example: "2019-10-01T21:28:28.354Z"

user_infoArray of objectsrequired

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

node_addressstringrequired

RippleNet address of the xCurrent instance that set the user information.

Example: "rn.us.ca.san_francisco"

statestringrequired

State of the transfer set when the RippleNet address set the user information.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED"

Example: "EXECUTED"

jsonobjectrequired

One or more arbitrary key/value pairs.

created_atstring(date-time)

timestamp of when this user info was created

Example: "2019-10-01T21:28:28.357Z"

labelsArray of strings

List of labels associated with this transfer

Example: ["label1","label2","label3"]

Response

application/json

{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}

Get transfer estimate

Request

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.

Security

Bearer

Query

sender_addressstring^[^\s]+@[^\s]+$

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

receiver_addressstring^[^\s]+@[^\s]+$

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

amountnumber>= 0

The amount to be transferred

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/estimate?sender_address=string&receiver_address=string&amount=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved estimate of transfer sending fee

Bodyapplication/json

transfer_idstring(uuid)required

Unique identifier of the transfer.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"

statestringrequired

State of the transfer.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.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED""PENDING""OTHER"

Example: "EXECUTED"

owner_addressstringrequired

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

Example: "rn.us.ca.san_francisco"

sender_addressstringrequired

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

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

receiver_addressstringrequired

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

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

amountnumberrequired

Amount transferred, expressed in the account's currency.

Example: 15

internal_idstring

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

Example: "9cf5aa4b-1e44-436a-ab7c-d399aec905da"

end_to_end_idstring

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

Example: "fd7559be-aa85-433f-a283-0cd58681cdf0"

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.

Example: "2019-10-01T21:28:28.354Z"

user_infoArray of objectsrequired

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

node_addressstringrequired

RippleNet address of the xCurrent instance that set the user information.

Example: "rn.us.ca.san_francisco"

statestringrequired

State of the transfer set when the RippleNet address set the user information.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED"

Example: "EXECUTED"

jsonobjectrequired

One or more arbitrary key/value pairs.

created_atstring(date-time)

timestamp of when this user info was created

Example: "2019-10-01T21:28:28.357Z"

labelsArray of strings

List of labels associated with this transfer

Example: ["label1","label2","label3"]

Response

application/json

{
  "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",
  "sending_fee": 0,
  "created_at": "2019-10-01T21:28:28.354Z",
  "user_info": [
    { … }
  ],
  "labels": [
    "label1",
    "label2",
    "label3"
  ]
}

Get transfer by ID

Request

Gets a transfer by ID.

Security

Bearer

Path

transfer_idstring(uuid)required

Unique identifier of the transfer you want to retrieve.

Query

include_labelsboolean

Returns labels added to each Transfer object. By default labels are not returned.

Default false

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/{transfer_id}?include_labels=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved transfer.

Bodyapplication/json

transfer_idstring(uuid)required

Unique identifier of the transfer.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"

statestringrequired

State of the transfer.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.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED""PENDING""OTHER"

Example: "EXECUTED"

owner_addressstringrequired

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

Example: "rn.us.ca.san_francisco"

sender_addressstringrequired

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

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

receiver_addressstringrequired

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

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

amountnumberrequired

Amount transferred, expressed in the account's currency.

Example: 15

internal_idstring

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

Example: "9cf5aa4b-1e44-436a-ab7c-d399aec905da"

end_to_end_idstring

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

Example: "fd7559be-aa85-433f-a283-0cd58681cdf0"

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.

Example: "2019-10-01T21:28:28.354Z"

user_infoArray of objectsrequired

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

node_addressstringrequired

RippleNet address of the xCurrent instance that set the user information.

Example: "rn.us.ca.san_francisco"

statestringrequired

State of the transfer set when the RippleNet address set the user information.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED"

Example: "EXECUTED"

jsonobjectrequired

One or more arbitrary key/value pairs.

created_atstring(date-time)

timestamp of when this user info was created

Example: "2019-10-01T21:28:28.357Z"

labelsArray of strings

List of labels associated with this transfer

Example: ["label1","label2","label3"]

Response

application/json

{
  "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",
  "sending_fee": 0,
  "created_at": "2019-10-01T21:28:28.354Z",
  "user_info": [
    { … }
  ],
  "labels": [
    "label1",
    "label2",
    "label3"
  ]
}

Execute transfer

Request

Transfers funds between accounts. For example, use this request to fund a connector account by transferring funds from a transactional account to the connector account. You can also use this request to redeem funds to a transactional account by transferring funds from a connector account to the transactional account.

Security

Bearer

Bodyapplication/jsonrequired

See Transfer Request Object.

sender_addressstringrequired

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

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

receiver_addressstringrequired

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

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

amountnumber>= 0required

Amount transferred, expressed in the account's currency.

Example: 15

owner_addressstring

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

Example: "rn.us.ca.san_francisco"

end_to_end_idstring<= 128 characters

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

Example: "b09dd632-660e-48c8-907f-a4f3a7d12c18"

internal_idstring<= 128 characters

ID set by the sender that is persisted on the sending xCurrent instance only.

Example: "9ad3c119-1379-443b-9c0e-fa82c54ae78d"

user_infoobject

Provide one or more arbitrary key/value pairs.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/execute \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
    "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
    "amount": 15,
    "owner_address": "rn.us.ca.san_francisco",
    "end_to_end_id": "b09dd632-660e-48c8-907f-a4f3a7d12c18",
    "internal_id": "9ad3c119-1379-443b-9c0e-fa82c54ae78d",
    "user_info": {}
  }'

Responses

Successfully executed transfer.

Bodyapplication/json

transfer_idstring(uuid)required

Unique identifier of the transfer.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"

statestringrequired

State of the transfer.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.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED""PENDING""OTHER"

Example: "EXECUTED"

owner_addressstringrequired

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

Example: "rn.us.ca.san_francisco"

sender_addressstringrequired

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

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

receiver_addressstringrequired

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

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

amountnumberrequired

Amount transferred, expressed in the account's currency.

Example: 15

internal_idstring

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

Example: "9cf5aa4b-1e44-436a-ab7c-d399aec905da"

end_to_end_idstring

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

Example: "fd7559be-aa85-433f-a283-0cd58681cdf0"

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.

Example: "2019-10-01T21:28:28.354Z"

user_infoArray of objectsrequired

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

node_addressstringrequired

RippleNet address of the xCurrent instance that set the user information.

Example: "rn.us.ca.san_francisco"

statestringrequired

State of the transfer set when the RippleNet address set the user information.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED"

Example: "EXECUTED"

jsonobjectrequired

One or more arbitrary key/value pairs.

created_atstring(date-time)

timestamp of when this user info was created

Example: "2019-10-01T21:28:28.357Z"

labelsArray of strings

List of labels associated with this transfer

Example: ["label1","label2","label3"]

Response

application/json

{
  "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",
  "sending_fee": 0,
  "created_at": "2019-10-01T21:28:28.354Z",
  "user_info": [
    { … }
  ],
  "labels": [
    "label1",
    "label2",
    "label3"
  ]
}

Complete transfer

Request

Updates the state of a transfer to COMPLETED. Make this request once the transfer has been made on both the ledger and on internal systems.

Security

Bearer

Path

transfer_idstring(uuid)required

Unique identifier of the transfer you want to complete.

curl -i -X POST \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/{transfer_id}/complete' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully completed transfer.

Bodyapplication/json

transfer_idstring(uuid)required

Unique identifier of the transfer.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"

statestringrequired

State of the transfer.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.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED""PENDING""OTHER"

Example: "EXECUTED"

owner_addressstringrequired

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

Example: "rn.us.ca.san_francisco"

sender_addressstringrequired

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

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

receiver_addressstringrequired

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

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

amountnumberrequired

Amount transferred, expressed in the account's currency.

Example: 15

internal_idstring

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

Example: "9cf5aa4b-1e44-436a-ab7c-d399aec905da"

end_to_end_idstring

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

Example: "fd7559be-aa85-433f-a283-0cd58681cdf0"

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.

Example: "2019-10-01T21:28:28.354Z"

user_infoArray of objectsrequired

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

node_addressstringrequired

RippleNet address of the xCurrent instance that set the user information.

Example: "rn.us.ca.san_francisco"

statestringrequired

State of the transfer set when the RippleNet address set the user information.

Enum"PREPARED""EXECUTED""COMPLETED""CANCELLED""FAILED""QUOTED"

Example: "EXECUTED"

jsonobjectrequired

One or more arbitrary key/value pairs.

created_atstring(date-time)

timestamp of when this user info was created

Example: "2019-10-01T21:28:28.357Z"

labelsArray of strings

List of labels associated with this transfer

Example: ["label1","label2","label3"]

Response

application/json

{
  "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",
  "sending_fee": 0,
  "created_at": "2019-10-01T21:28:28.354Z",
  "user_info": [
    { … }
  ],
  "labels": [
    "label1",
    "label2",
    "label3"
  ]
}

Add transfer labels

Request

Adds a list of labels to the transfer. To retrieve transfers by label, see [Get transfers][get-transfers].

Security

Bearer

Path

transfer_idstring(uuid)required

Transfer ID for the label being added.

Query

labelArray of stringsrequired

Text of the label you want to add to the payment.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/{transfer_id}/labels?label=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully added one or more labels to the transfer.

Response

No content

Delete transfer labels

Request

Deletes one or more existing labels from the transfer.

Security

Bearer

Path

transfer_idstring(uuid)required

Transfer ID for the label being removed.

Query

labelArray of stringsrequired

Labels to be removed.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers/{transfer_id}/labels?label=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully deleted one or more labels of the transfer.

Response

No content

RippleNet Server API (4.0.0)

Authentication

API environments

Auditing

Balances and statements

Beneficiary confirmation

Diagnostics

Exchange transfers

Fees

Non-orchestration payments

Orchestration payments

Payment expiration

Payout method

Platform accounts

Pool accounts

Quote expiration

Quotes

Rates

Request for payment

Transfers

Get transfers

Request

Responses

Was this page helpful?

Get transfer estimate

Request

Responses

Was this page helpful?

Get transfer by ID

Request

Responses

Was this page helpful?

Execute transfer

Request

Responses

Was this page helpful?

Complete transfer

Request

Responses

Was this page helpful?

Add transfer labels

Request

Responses

Was this page helpful?

Delete transfer labels

Request

Responses

Was this page helpful?