Create fee

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`

Account configuration

Operations

Auditing

Operations

Balances and statements

Operations

Beneficiary confirmation

Operations

Diagnostics

Operations

Exchange transfers

Operations

Fees

Operations

Get fees

Request

Gets a list of fees.

Security

Bearer

Query

pageinteger

Number of pages returned. Returns one page of results when set to 0.

Default 0

sizeinteger

Number of objects returned per page.

Default 10

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/fees?page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returns list of fees.

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 fee objects.

valuenumberrequired

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

Example: 2

currency_codestringrequired

Currency this fee applies to.

Example: "USD"

role_typestringrequired

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

Enum"SENDING""RECEIVING""INSTITUTION_SENDING""INSTITUTION_RECEIVING"

Example: "SENDING"

payment_typestringrequired

Payment type the fee applies to.

Enum"REGULAR""RETURN"

Example: "REGULAR"

node_typestringrequired

Fiat node to which the fee applies.If set to INITIAL, the fee is charged to the first fiat instance in the payment chain. 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. If set to TERMINAL, the fee is charged to the last fiat instance in the payment chain.

Enum"INITIAL""INTERMEDIATE""TERMINAL"

Example: "INITIAL"

fee_typestringrequired

Method used to calculate the fee.

Enum"PERCENTAGE""FLAT_RATE"

Example: "FLAT_RATE"

partner_namestring

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

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.

Example: "conct_usd_sf"

upper_limitnumber

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

Example: 1000

lower_limitnumber

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

Example: 0

feeIdstring(uuid)required

Unique identifier of the fee.

Example: "7740f31c-ca03-4414-b491-b285aef71eb1"

payout_methodstring

The payout method for this fee.

Example: "LOCAL_RAILS"

fee_categorystring

Category that describes the purpose of the fee.

Default "NONE"

Enum"NONE""OVERSEAS_DELIVERY_CHARGES""BENEFICIARY_BANK_CHARGE""PROCESSING_HANDLING_CHARGE""LOCAL_GOVERNMENT_CHARGE""OTHER"

Example: "BENEFICIARY_BANK_CHARGE"

fee_descriptionstring

Optional free-form description for the fee.

Response

application/json

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

Create fee

Request

Creates a fee.

Security

Bearer

Bodyapplication/jsonrequired

valuenumberrequired

Value of the fee to apply.

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

fee_type	Corresponding value to use
PERCENTAGE	`value` must be >`0` and <`100`.
FLAT_RATE	`value` 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.

Example: 0.025

currency_codestringrequired

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

Example: "USD"

role_typestringrequired

Role of the party to which the fee applies.

Enum Value	Description
SENDING	Charge the originator of the payment.
RECEIVING	Charge the beneficiary of the payment.
INSTITUTION_SENDING	Charge the financial institution sending the payment.
INSTITUTION_RECEIVING	Charge the financial institution receiving the payment.

Example: "SENDING"

payment_typestringrequired

Type of payment to which the fee applies.

Enum Value	Description
REGULAR	Apply the fee to a regular payment.
RETURN	Apply the fee to a return payment.

Example: "REGULAR"

node_typestringrequired

Fiat instance to which the fee applies.

Enum Value	Description
INITIAL	Apply the fee to the first fiat instance in the payment chain.
INTERMEDIATE	Apply the fee to each fiat instance in the payment chain that is not the first or last.
TERMINAL	Apply the fee to the last fiat instance in the payment chain.

Example: "INITIAL"

fee_typestringrequired

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

Enum Value	Description
PERCENTAGE	Apply the fee `value` as a percentage.
FLAT_RATE	Apply the fee `value` as a flat rate.

Example: "FLAT_RATE"

partner_namestring

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

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.

Example: "conct_usd_sf"

upper_limitnumber

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

Example: 1000

lower_limitnumber

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

Example: 0

payout_methodstring

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

Example: "LOCAL_RAILS"

fee_categorystring

Category that describes the purpose of the fee.

Default "NONE"

Enum Value	Description
NONE	None
OVERSEAS_DELIVERY_CHARGES	Overseas delivery charges.
BENEFICIARY_BANK_CHARGE	Charge from beneficiary bank.
PROCESSING_HANDLING_CHARGE	Processing and handling charge.
LOCAL_GOVERNMENT_CHARGE	Local government charge.
OTHER	Other charges.

Example: "BENEFICIARY_BANK_CHARGE"

fee_descriptionstring

Optional free-form description for the fee.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/fees \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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,
    "lower_limit": 0,
    "payout_method": "LOCAL_RAILS",
    "fee_category": "BENEFICIARY_BANK_CHARGE",
    "fee_description": "string"
  }'

Responses

Successfully created fee.

Bodyapplication/json

valuenumberrequired

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

Example: 2

currency_codestringrequired

Currency this fee applies to.

Example: "USD"

role_typestringrequired

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

Enum"SENDING""RECEIVING""INSTITUTION_SENDING""INSTITUTION_RECEIVING"

Example: "SENDING"

payment_typestringrequired

Payment type the fee applies to.

Enum"REGULAR""RETURN"

Example: "REGULAR"

node_typestringrequired

Fiat node to which the fee applies.If set to INITIAL, the fee is charged to the first fiat instance in the payment chain. 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. If set to TERMINAL, the fee is charged to the last fiat instance in the payment chain.

Enum"INITIAL""INTERMEDIATE""TERMINAL"

Example: "INITIAL"

fee_typestringrequired

Method used to calculate the fee.

Enum"PERCENTAGE""FLAT_RATE"

Example: "FLAT_RATE"

partner_namestring

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

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.

Example: "conct_usd_sf"

upper_limitnumber

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

Example: 1000

lower_limitnumber

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

Example: 0

feeIdstring(uuid)required

Unique identifier of the fee.

Example: "7740f31c-ca03-4414-b491-b285aef71eb1"

payout_methodstring

The payout method for this fee.

Example: "LOCAL_RAILS"

fee_categorystring

Category that describes the purpose of the fee.

Default "NONE"

Enum"NONE""OVERSEAS_DELIVERY_CHARGES""BENEFICIARY_BANK_CHARGE""PROCESSING_HANDLING_CHARGE""LOCAL_GOVERNMENT_CHARGE""OTHER"

Example: "BENEFICIARY_BANK_CHARGE"

fee_descriptionstring

Optional free-form description for the fee.

Response

application/json

{
  "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,
  "lower_limit": 0,
  "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
  "payout_method": "LOCAL_RAILS",
  "fee_category": "BENEFICIARY_BANK_CHARGE",
  "fee_description": "string"
}

Get fee by ID

Request

Gets a fee by ID.

Security

Bearer

Path

idstring(uuid)required

Provide the feeId of the fee you want to retrieve.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/fees/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved fee.

Bodyapplication/json

valuenumberrequired

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

Example: 2

currency_codestringrequired

Currency this fee applies to.

Example: "USD"

role_typestringrequired

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

Enum"SENDING""RECEIVING""INSTITUTION_SENDING""INSTITUTION_RECEIVING"

Example: "SENDING"

payment_typestringrequired

Payment type the fee applies to.

Enum"REGULAR""RETURN"

Example: "REGULAR"

node_typestringrequired

Fiat node to which the fee applies.If set to INITIAL, the fee is charged to the first fiat instance in the payment chain. 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. If set to TERMINAL, the fee is charged to the last fiat instance in the payment chain.

Enum"INITIAL""INTERMEDIATE""TERMINAL"

Example: "INITIAL"

fee_typestringrequired

Method used to calculate the fee.

Enum"PERCENTAGE""FLAT_RATE"

Example: "FLAT_RATE"

partner_namestring

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

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.

Example: "conct_usd_sf"

upper_limitnumber

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

Example: 1000

lower_limitnumber

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

Example: 0

feeIdstring(uuid)required

Unique identifier of the fee.

Example: "7740f31c-ca03-4414-b491-b285aef71eb1"

payout_methodstring

The payout method for this fee.

Example: "LOCAL_RAILS"

fee_categorystring

Category that describes the purpose of the fee.

Default "NONE"

Enum"NONE""OVERSEAS_DELIVERY_CHARGES""BENEFICIARY_BANK_CHARGE""PROCESSING_HANDLING_CHARGE""LOCAL_GOVERNMENT_CHARGE""OTHER"

Example: "BENEFICIARY_BANK_CHARGE"

fee_descriptionstring

Optional free-form description for the fee.

Response

application/json

{
  "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,
  "lower_limit": 0,
  "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
  "payout_method": "LOCAL_RAILS",
  "fee_category": "BENEFICIARY_BANK_CHARGE",
  "fee_description": "string"
}

Update fee

Request

Updates an existing fee.

Security

Bearer

Path

idstring(uuid)required

Provide the feeId of the fee you want to update.

Bodyapplication/jsonrequired

valuenumberrequired

Value of the fee to apply.

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

fee_type	Corresponding value to use
PERCENTAGE	`value` must be >`0` and <`100`.
FLAT_RATE	`value` 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.

Example: 0.025

currency_codestringrequired

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

Example: "USD"

role_typestringrequired

Role of the party to which the fee applies.

Enum Value	Description
SENDING	Charge the originator of the payment.
RECEIVING	Charge the beneficiary of the payment.
INSTITUTION_SENDING	Charge the financial institution sending the payment.
INSTITUTION_RECEIVING	Charge the financial institution receiving the payment.

Example: "SENDING"

payment_typestringrequired

Type of payment to which the fee applies.

Enum Value	Description
REGULAR	Apply the fee to a regular payment.
RETURN	Apply the fee to a return payment.

Example: "REGULAR"

node_typestringrequired

Fiat instance to which the fee applies.

Enum Value	Description
INITIAL	Apply the fee to the first fiat instance in the payment chain.
INTERMEDIATE	Apply the fee to each fiat instance in the payment chain that is not the first or last.
TERMINAL	Apply the fee to the last fiat instance in the payment chain.

Example: "INITIAL"

fee_typestringrequired

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

Enum Value	Description
PERCENTAGE	Apply the fee `value` as a percentage.
FLAT_RATE	Apply the fee `value` as a flat rate.

Example: "FLAT_RATE"

partner_namestring

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

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.

Example: "conct_usd_sf"

upper_limitnumber

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

Example: 1000

lower_limitnumber

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

Example: 0

payout_methodstring

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

Example: "LOCAL_RAILS"

fee_categorystring

Category that describes the purpose of the fee.

Default "NONE"

Enum Value	Description
NONE	None
OVERSEAS_DELIVERY_CHARGES	Overseas delivery charges.
BENEFICIARY_BANK_CHARGE	Charge from beneficiary bank.
PROCESSING_HANDLING_CHARGE	Processing and handling charge.
LOCAL_GOVERNMENT_CHARGE	Local government charge.
OTHER	Other charges.

Example: "BENEFICIARY_BANK_CHARGE"

fee_descriptionstring

Optional free-form description for the fee.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/fees/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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,
    "lower_limit": 0,
    "payout_method": "LOCAL_RAILS",
    "fee_category": "BENEFICIARY_BANK_CHARGE",
    "fee_description": "string"
  }'

Responses

Successfully updated fee.

Bodyapplication/json

valuenumberrequired

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

Example: 2

currency_codestringrequired

Currency this fee applies to.

Example: "USD"

role_typestringrequired

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

Enum"SENDING""RECEIVING""INSTITUTION_SENDING""INSTITUTION_RECEIVING"

Example: "SENDING"

payment_typestringrequired

Payment type the fee applies to.

Enum"REGULAR""RETURN"

Example: "REGULAR"

node_typestringrequired

Fiat node to which the fee applies.If set to INITIAL, the fee is charged to the first fiat instance in the payment chain. 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. If set to TERMINAL, the fee is charged to the last fiat instance in the payment chain.

Enum"INITIAL""INTERMEDIATE""TERMINAL"

Example: "INITIAL"

fee_typestringrequired

Method used to calculate the fee.

Enum"PERCENTAGE""FLAT_RATE"

Example: "FLAT_RATE"

partner_namestring

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

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.

Example: "conct_usd_sf"

upper_limitnumber

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

Example: 1000

lower_limitnumber

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

Example: 0

feeIdstring(uuid)required

Unique identifier of the fee.

Example: "7740f31c-ca03-4414-b491-b285aef71eb1"

payout_methodstring

The payout method for this fee.

Example: "LOCAL_RAILS"

fee_categorystring

Category that describes the purpose of the fee.

Default "NONE"

Enum"NONE""OVERSEAS_DELIVERY_CHARGES""BENEFICIARY_BANK_CHARGE""PROCESSING_HANDLING_CHARGE""LOCAL_GOVERNMENT_CHARGE""OTHER"

Example: "BENEFICIARY_BANK_CHARGE"

fee_descriptionstring

Optional free-form description for the fee.

Response

application/json

{
  "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,
  "lower_limit": 0,
  "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
  "payout_method": "LOCAL_RAILS",
  "fee_category": "BENEFICIARY_BANK_CHARGE",
  "fee_description": "string"
}

Delete fee

Request

Deletes a fee. Once deleted, a fee cannot be accessed.

Security

Bearer

Path

idstring(uuid)required

Provide the feeId of the fee you want to delete.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/fees/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully deleted fee.

Response

No content

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

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

RippleNet Server API (4.0.0)

Authentication

API environments

Account configuration

Auditing

Balances and statements

Beneficiary confirmation

Diagnostics

Exchange transfers

Fees

Get fees

Request

Responses

Was this page helpful?

Create fee

Request

Responses

Was this page helpful?

Get fee by ID

Request

Responses

Was this page helpful?

Update fee

Request

Responses

Was this page helpful?

Delete fee

Request

Responses

Was this page helpful?

Liquidation configuration

Non-orchestration payments

Notifications

ODL flags configuration

Orchestration payments

Payment expiration

Payout method

Platform accounts

Pool accounts

Quote expiration

Quotes

Rates

Request for payment

Sender segregated account configuration

Transfers

schema

activity

Orchestration Template

diagnostics

payment

Get application info

Request

Responses

Was this page helpful?

tenant

Orchestration internal action

Orchestration internal payments

Orchestration internal notifications