v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Orchestration payments

Create orchestration payment

Creates an orchestration payment.

post/v4/orchestration/payment

Request body

sender_end_to_end_idstring required

Unique ID that the sender can specify.

Persisted on all instances that participate in the payment.

internal_idstring

[Sender only]

Internal ID that the sender can optionally specify.

Only visible to the sender. Only the sending RippleNet instance stores this ID.

orchestration_templatestring

Parameter for the orchestration template name.

If you don't specify a template name, a default template will be picked.

sending_addressstring required

RippleNet account name and address of the sender.

Format: accountname@ripplenetaddress

Example: new_york@rn.us.ny.new_york

receiving_addressstring required

RippleNet account name and address of the receiver.

Format: accountname@ripplenetaddress

Example: new_york@rn.us.ny.new_york

amountstring required

Amount to be sent or received, depending on the quote_type.

Use this table to determine what amount to assign.

Example: "1"

Quote type	Amount
SENDER_AMOUNT	Amount to be sent by the payment originator
SENDER_INSTITUTION_AMOUNT	Set to SENDER_INSTITUTION_AMOUNT to calculate the quote based on the amount to be sent, plus any fees collected by the sending institution
RECEIVER_AMOUNT	Amount to be received by the payment beneficiary
RECEIVER_INSTITUTION_AMOUNT	Set to RECEIVER_INSTITUTION_AMOUNT to calculate the quote based on the amount to be received, minus any fees collected by the receiving institution

currencystring required

Currency code of the amount to be sent or received, depending on the quote_type.

Use this table to determine what currency code to assign.

Example: USD

Quote type	Currency code description
SENDER_AMOUNT	Specify the currency code for the sending currency, for example USD
SENDER_INSTITUTION_AMOUNT	Specify the currency code for the sending currency, for example USD
RECEIVER_AMOUNT	Specify the currency code for the receiving currency, for example USD
RECEIVER_INSTITUTION_AMOUNT	Specify the currency code for the receiving currency, for example USD

quote_type'SENDER_AMOUNT' | 'RECEIVER_AMOUNT' | 'SENDER_INSTITUTION_AMOUNT' | 'RECEIVER_INSTITUTION_AMOUNT' required

Specifies how to calculate the quote.

Example: SENDER_AMOUNT

sender_or_receiver_currencystring

Currency code of the sender or receiver based on quote_type.

If provided, you can use this to filter the options for quotes.

Example: USD

custom_feenumber

Custom fee for the sending account.

Setting this field overrides all fees configured on the sender's RippleNet instance.

quote_routestring[]

Custom route that quote must follow.

Provide an array of RippleNet address strings that convey the route the quote must follow.

Example: g.us.ca.san_francisco

payment_methodstring

Use this field, when using ODL, to indicate the type of fees to apply.

When testing, set "payment_method": "none" to ensure funds remain at the destination exchange and are not paid out to a local rail.

enable_quote_per_payout_methodboolean

Enable this flag to generate quotes using payout methods configured by the receiver.

digital_asset_originationboolean

When true, this flag tells RippleNet to provide a full quote as if the payment originates in the specified source fiat currency.

The quote for the source exchange excludes trading fees.

On execution, the source exchange trade is skipped, and XRP is withdrawn from the source exchange as the first step.

force_path_finding_and_liquidity_path_findingboolean

When true, this flag tells RippleNet to ignore cached value for path finding and liquidity path finding.

Force performing new path finding and liquidity path finding.

Category the payout method will be associated with.

user_infoobject required

Provide one or more arbitrary key/value pairs.

sender_segregated_accountstring

RippleNet account name and address of the sender owned account at receiver to be used for failure conversion (in case of payment failure).

Format: accountname@ripplenetaddress

Example: new_york@rn.us.ny.new_york

quote_limitinteger

Flag for truncating the total amount of quotes to a maximum amount after sorting and filters are applied.

quote_filter_typesstring[]

Filter on a type of quote.

Example request

{
  "currency": "USD",
  "quote_type": "SENDER_AMOUNT",
  "sender_or_receiver_currency": "USD",
  "quote_route": [
    "rn.us.ca.san_francisco",
    "rn.us.tx.austin",
    "rn.us.ny.new_york"
  ],
  "enable_quote_per_payout_method": true,
  "payout_method_category": "BOOK_TRANSFER",
  "sender_segregated_account": "conct_php_receiver_coins_sender@receiver"
}

Response

Successfully created orchestration payment.

sender_end_to_end_idstring

Sender end-to-end ID.

Example response

{
  "sender_end_to_end_id": "00310000015"
}