New payment form

The New payment form allows you to initiate remittance payments and treasury transactions in Ripple Payments UI.

New Payment button

Note

Clicking the Use Previous Quote Configuration link at the top right of the New payment form will use the same field values from your previous quote request.

Payment fields

Field Definition
Sender RippleNet Account The sender RippleNet account where the payment originates.
Quote Type The stage in the payment chain where the amount specified in the Amount field applies. Amounts in stages before and after the specified stage may differ after fees are applied.
The options include:
  • Sending Amount: the amount to be sent prior to factoring in the FX and cost.
  • Receiving Amount: the amount to be received after FX and fees have been applied.
Amount The amount of payment in the stage and in the currency specified by the Amount Type and Sending Currency Code fields.
Payment Currency The type of currency used to define the payment amount set in the Amount field. The value must be a three-letter standard international currency code.
Receiver RippleNet Host The RippleNet address of the receiving partner’s RippleNet instance.
Payout Method The payout method your receiving partner will use to pay the beneficiary. The options include:
  • No method: the payment method is the end customer’s default payment method.
  • All methods: any payment method the receiving partner cares to use
  • Specific method: the payout method you’d like the receiving partner to use. Choosing this value adds the Outlet ID or Payout Method field.
  • Destination exchange: an exchange institution where the beneficiary can retrieve funds.
Payout Method Category The category of your payout method. The dropdown offers these values:
  • Book Transfer: transfers between two accounts held by the same party and used to perform a funding action.
  • Cash Payout: the beneficiary receives cash payment.
  • Mass Net Payment System: a system for processing high-volume payments, both recurring and one-time payments.
  • Real-Time Gross Settlement System: fund transfer system where the transfer of money occurs between two banks in real-time on a one-to-one basis.
  • Real-Time Net Settlement System: fund transfer system where inter-institutional transactions during the day are accumulated, and at the end of the day, the central bank adjusts the accounts of the institutions by the net amounts of these transactions.
  • Wallet Payment: funds received at the beneficiary wallet account.
  • Other: a non-specified category.

Get Quote button

The Get Quote button submits the payment quote request defined by the fields in the New Payment form. RippleNet returns a set of one or more quotes that show available payment options that include applicable fees and exchange rates.

Advanced options

Advanced options are optional fields that can define a quote request beyond the basic payment parameters.

Advanced options fields

Field Description
Receiver RippleNet Account The RippleNet account name of your receiving partner’s account used to receive this payment. You can get this account name from your receiving partner.
Sender Segregated Account The RippleNet account name of a receiving partner account that belongs to you (a nostro account). This account is used to send the payment.
Sender or Receiver Currency (Fiat only) Filter all returned quotes to show only quotes that use the type of currency specified in the basic “Payment Currency” field. The filter is applied to the party specified in the “Quote Type” field.
Custom Rate The ratio of the base currency to the counter currency.
Rate Type Determines which currency is the base currency and which is the counter currency when specifying the Rate value. The dropdown offers two choices:
  • Buyer: the sent currency is the base currency; the received currency is the counter currency.
  • Seller: the receiver currency is the base currency; the sent currency is the counter currency.
Base Currency The type of currency used as the base currency. The value must be a three-letter standard international currency code.
Counter Currency The type of currency used as the counter currency. The value must be a three-letter standard international currency code.
Custom Fee The fee that you’d like applied at the first stage of the payment’s progress through intermediate instances. The fee value is the amount of fee you want to apply using the currency defined for the sender institution. This value overrides sending fees configured in your institution’s instance.
Force path finding & liquidity path finding When checked, Ripple Payments UI disregards cached paths for this quote request so that RippleNet will find one or more new possible paths for payment.
Quote Route Filter returned quotes to show only those that use at least one of the intermediary institutions listed here. Accepts a set of one or more RippleNet addresses separated by commas.

Quote review form

Ripple Payments UI displays the payment quote from the receiver to review and accept.

Tip

If you don't see the intended beneficiary for this payment in the Beneficiary field, send an email to payops@ripple.com and request the beneficiary to be added. For more information, click Add a new beneficiary in the Ripple Payments UI UI.

New payment quote review

Optional sender information

The bottom half of the quote review form provides optional fields that you can fill in to include with your quote acceptance.

Field Definition
Additional Payout Info Any additional information that you and your payment partner find useful to exchange, provided as key:value pairs in JSON format.
Internal ID A unique, user-assigned ID assigned to a transaction for internal communication and tracking.
End-to-End ID A unique, user-assigned ID assigned to a transaction and shared between sender, receiver, and any intermediaries, which persists even if the payment ID for a transaction changes due to failures.

Accept quote and Back buttons

Click the Accept quote button to accept the quote.

Click the Back button to go back to your filled-in New payment quote details page.