Skip to content

RippleNet Server API (4.0.0)

The RippleNet Server API provides you the ability to develop custom applications to manage or interact with your RippleNet instance.

Check out the best practices and tutorials.

Authentication

All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.

API environments

The RippleNet Server API creates a dynamic [domainPrefix] that consists of {tenant}.{environment}.

Note: This example uses aperture as the tenant. Your tenant ID is different.

EnvironmentDomaing PrefixDomainBase URL
Testaperture.testripplexcurrent.comhttps://aperture.test.ripplexcurrent.com
UATaperture.uatripplexcurrent.comhttps://aperture.uat.ripplexcurrent.com
Productionaperture.prodripplexcurrent.comhttps://aperture.prod.ripplexcurrent.com
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/

https://[domainPrefix].ripplexcurrent.com/v4/

Account configuration

Operations

Auditing

Operations

Balances and statements

Operations

Beneficiary confirmation

Operations

Diagnostics

Operations

Exchange transfers

Operations

Fees

Operations

Liquidation configuration

Operations

Non-orchestration payments

Operations

Notifications

Operations

ODL flags configuration

Operations

Orchestration payments

Operations

Payment expiration

Operations

Payout method

Operations

Platform accounts

Operations

Pool accounts

Operations

Quote expiration

Operations

Quotes

Operations

Rates

Operations

Request for payment

Operations

Sender segregated account configuration

Operations

Transfers

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.<br/> 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.<p>Example - ?with_labels=LABEL1,LABEL2</p>

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. <p>Example - ?with_labels=LABEL1&include_labels=true</p>

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/ripplenet/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.<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>

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/ripplenet/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.<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>

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/ripplenet/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.<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>

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/ripplenet/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.<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>

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/ripplenet/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.<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>

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/ripplenet/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/ripplenet/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

schema

Operations

activity

Operations

Orchestration Template

Operations

diagnostics

Operations

payment

Operations

Get application info

Request

Gets application information.

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/info \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched application info.

Bodyapplication/json
namestring

Application name.

Example: "Integration Module"
versionstring

Application version.

Example: "1.2.0"
Response
application/json
{
  "name": "Integration Module",
  "version": "1.2.0"
}

tenant

Operations

Orchestration internal action

Operations

Orchestration internal payments

Operations

Orchestration internal notifications

Operations