Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Fees

Create fee

Creates a fee.

post/config/fees

Request body

valuenumber required

Value of the fee to apply.

Set the value of this parameter according to the fee type you are using:

fee_typeCorresponding value to use
PERCENTAGEvalue must be >0 and <100.
FLAT_RATEvalue can be negative.

Note: The final amount of the fee is applied either as a percentage or a flat rate depending on the value you specify for the fee_type parameter.

currency_codestring required

Currency the fee is applied in. Ripple recommends using ISO-4217 currency codes, although no formal constraint is enforced.

role_type'SENDING' | 'RECEIVING' | 'INSTITUTION_SENDING' | 'INSTITUTION_RECEIVING' required

Role of the party to which the fee applies.

payment_type'REGULAR' | 'RETURN' required

Type of payment to which the fee applies.</p>

node_type'INITIAL' | 'INTERMEDIATE' | 'TERMINAL' required

Fiat instance to which the fee applies.

fee_type'PERCENTAGE' | 'FLAT_RATE' required

Type of fee to apply. This is used with fee value to calculate the fee.

partner_namestring

Owner of the account involved in the payment, in RippleNet Address format. For example, rn.us.ca.san_francisco.

account_namestring

Account to apply the fee to. Specify the account name. For example, conct_usd_sf. If specified, you must also specify a partner_name value.

upper_limitnumber

Maximum amount for the range of a slab-based fee. If specified, you must also specify a lower_limit value.

lower_limitnumber

Minimum amount for the range of a slab-based fee. If specified, you must also specify an upper_limit value.

payout_methodstring

The payout method by which the receiving institution delivers the funds to the end customer.

fee_category'NONE' | 'OVERSEAS_DELIVERY_CHARGES' | 'BENEFICIARY_BANK_CHARGE' | 'PROCESSING_HANDLING_CHARGE' | 'LOCAL_GOVERNMENT_CHARGE' | 'OTHER'

Category that describes the purpose of the fee.

fee_descriptionstring

Optional free-form description for the fee.

Example request

{
  "value": 0.025,
  "currency_code": "USD",
  "role_type": "SENDING",
  "payment_type": "REGULAR",
  "node_type": "INITIAL",
  "fee_type": "FLAT_RATE",
  "partner_name": "rn.us.ca.san_francisco",
  "account_name": "conct_usd_sf",
  "upper_limit": 1000,
  "payout_method": "LOCAL_RAILS",
  "fee_category": "BENEFICIARY_BANK_CHARGE"
}

Response

Successfully created fee.

valuenumber required

Value of the fee to be applied. fiat node uses this value and fee_type to calculate the fee.

currency_codestring required

Currency this fee applies to.

role_type'SENDING' | 'RECEIVING' | 'INSTITUTION_SENDING' | 'INSTITUTION_RECEIVING' required

Role of the party to which the fee applies.<p>If set to SENDING, the fee is charged to the originator of the payment.</p> <p>If set to RECEIVING, the fee is charged to the beneficiary of the payment.</p> <p>If set to INSTITUTION_SENDING, the fee is charged to the financial institution that is sending the payment.</p> <p>If set to INSTITUTION_RECEIVING, the fee is charged to the financial institution that is receiving the payment.</p>

payment_type'REGULAR' | 'RETURN' required

Payment type the fee applies to.

node_type'INITIAL' | 'INTERMEDIATE' | 'TERMINAL' required

Fiat node to which the fee applies.<p>If set to INITIAL, the fee is charged to the first fiat instance in the payment chain.</p> <p>If set to INTERMEDIATE, the fee is charged to each fiat instance in the payment chain that is not the first or last fiat instance.</p> <p>If set to TERMINAL, the fee is charged to the last fiat instance in the payment chain.</p>

fee_type'PERCENTAGE' | 'FLAT_RATE' required

Method used to calculate the fee.

partner_namestring

Owner of the account involved in the payment, in RippleNet Address format. For example, rn.us.ca.san_francisco.

account_namestring

For a fee that applies to a specific account, provides the account name. Used in combination with the partner_name value.

upper_limitnumber

For a slab-based fee, provides the upper limit of the slab. Used in combination with the lower_limit value.

lower_limitnumber

For a slab-based fee, provides the lower limit of the slab. Used in combination wtih the upper_limit value.

feeIdstring uuid required

Unique identifier of the fee.

payout_methodstring

The payout method for this fee.

fee_category'NONE' | 'OVERSEAS_DELIVERY_CHARGES' | 'BENEFICIARY_BANK_CHARGE' | 'PROCESSING_HANDLING_CHARGE' | 'LOCAL_GOVERNMENT_CHARGE' | 'OTHER'

Category that describes the purpose of the fee.

fee_descriptionstring

Optional free-form description for the fee.

Example response

{
  "value": 2,
  "currency_code": "USD",
  "role_type": "SENDING",
  "payment_type": "REGULAR",
  "node_type": "INITIAL",
  "fee_type": "FLAT_RATE",
  "partner_name": "rn.us.ca.san_francisco",
  "account_name": "conct_usd_sf",
  "upper_limit": 1000,
  "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
  "payout_method": "LOCAL_RAILS",
  "fee_category": "BENEFICIARY_BANK_CHARGE"
}