Skip to content

Payout service APIs (1.0.0)

Payout service APIs

Overview
E-mail

kjakkula@ripple.com

License

Apache 2.0

Terms of Service

Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/

Forex

Operations

Payout Partner

Operations

Payout Method

Operations

Get Payout Methods

Request

Returns a paginated response of payout methods that match the given criteria

Security
oauth2
Query
countrystring

the destination country represented as two-letter ISO 3166-1 alpha-2 code

partner_namestring

the name of the payout partner

use_casestring

use case, for example: TREASURY

payout_currencystring^[A-Z]{3,4}$

the destination currency code (ISO 4217)

payout_methodstring

the payout method name

payout_categorystring

payout category, for example: BANK

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_methods?country=string&partner_name=string&use_case=string&payout_currency=string&payout_method=string&payout_category=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns all payout methods matching the criteria

Bodyapplication/json
contentArray of objects
payout_method_idstring(uuid)required
payout_partner_idstring(uuid)required
payout_partner_namestringrequired
Example: "Tranglo"
payout_categorystringrequired
Example: "BANK | EWALLET | CASH_PICKUP | ATM"
payout_method_namestringrequired
Example: "tranglo_bank_treasury_AU_AUD_payout"
payout_method_display_namestringrequired
Example: "Tranglo treasury bank AUD payout in AT"
payout_method_descriptionstringrequired
Example: "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case"
payout_method_statusstringrequired
Enum"ACTIVE""DELETED"
payout_countrystring^[A-Z]{2}$required

Payout country as two-letter ISO 3166-1 Alpha-2 code

Example: "AT"
payout_currencystringrequired
Example: "AUR"
supported_usecasestringrequired
Example: "TREASURY | P2P | B2B | B2C"
rounding_rulesobjectrequired

Holds the rules used to calculate fee

payout_amount_fee_calculation_decimal_scaleintegerrequired

When calculating percentage fees for this payout method, this the number of decimal places to round the payout amount by before multiplying by the percentage

Example: 2
fee_calculation_rulestringrequired

fee calculation rule. If set to REGULAR, find the matching range slabs, apply the percentage or fixed fee based on PayoutFeeType. A global/administrative fee can be applied on top of a slab fee.

Value"REGULAR"
payout_feesArray of objectsrequired
currencystringrequired
Example: "AUD"
from_amountstring(double)required
Example: 0
to_amountstring(double)required
Example: 1000
fee_amountstring(double)required

flat value fee

Example: 5
fee_percentstring(double)required

fee as percentage of payment

Example: 2
min_fee_amountstring(double)

minimum fee amount. Default to 0 (no minimum limit)

Example: 25
max_fee_amountstring(double)

maximum fee amount. Default to maximum number (no upper limit)

Example: 100
fee_typestringrequired

the calculation rule of payout fee element. By default, REGULAR. If set to AMINISTRACTIVE/GLOBAL, the fee should be applied to every transaction. If set to Hihger/Lower of Flat or Percentage fee, then the higher/lower amount of flat/pct fee will be applied

Enum"REGULAR""ADMINISTRATIVE""HIGHER_OF_FLAT_OR_PCT_FEE""LOWER_OF_FLAT_OR_PCT_FEE"
descriptionstring

description of the fee rules and other details

Example: "Administrative/global fee, applied for each transaction"
payout_settlement_timesobjectrequired

Holds the amount and unit of time it takes for a settlement to occur

settlement_timeintegerrequired
settlement_time_unitstringrequired
payout_limitsobjectrequired

Defines the limits for payouts min, max size of payment and the maximum amount per beneficiary

currencystringrequired
min_payment_sizestring(double)required
max_payment_sizestring(double)required
max_amount_per_beneficiarystring(double)required
receiver_payout_methodstring
pageobject

Common object for holding page details

sizeintegerrequired
total_elementsinteger(int64)required
total_pagesintegerrequired
numberintegerrequired
Response
application/json
{
  "content": [
    { … }
  ],
  "page": {
    "size": 0,
    "total_elements": 0,
    "total_pages": 0,
    "number": 0
  }
}

Create a new payout method

Request

Returns the single created payout method

Security
oauth2
Bodyapplication/jsonrequired

The payout method to create.

payout_partner_idstring(uuid)required
payout_categorystringrequired
payout_method_namestringrequired
payout_method_display_namestringrequired
payout_method_descriptionstringrequired
payout_countrystringrequired
payout_currencystringrequired
supported_usecasestringrequired
rounding_rulesobjectrequired

Holds the rules used to calculate fee

payout_amount_fee_calculation_decimal_scaleintegerrequired

When calculating percentage fees for this payout method, this the number of decimal places to round the payout amount by before multiplying by the percentage

Example: 2
fee_calculation_rulestringrequired

fee calculation rule. If set to REGULAR, find the matching range slabs, apply the percentage or fixed fee based on PayoutFeeType. A global/administrative fee can be applied on top of a slab fee.

Value"REGULAR"
payout_feesArray of objectsrequired
currencystringrequired
Example: "AUD"
from_amountstring(double)required
Example: 0
to_amountstring(double)required
Example: 1000
fee_amountstring(double)required

flat value fee

Example: 5
fee_percentstring(double)required

fee as percentage of payment

Example: 2
min_fee_amountstring(double)

minimum fee amount. Default to 0 (no minimum limit)

Example: 25
max_fee_amountstring(double)

maximum fee amount. Default to maximum number (no upper limit)

Example: 100
fee_typestringrequired

the calculation rule of payout fee element. By default, REGULAR. If set to AMINISTRACTIVE/GLOBAL, the fee should be applied to every transaction. If set to Hihger/Lower of Flat or Percentage fee, then the higher/lower amount of flat/pct fee will be applied

Enum"REGULAR""ADMINISTRATIVE""HIGHER_OF_FLAT_OR_PCT_FEE""LOWER_OF_FLAT_OR_PCT_FEE"
descriptionstring

description of the fee rules and other details

Example: "Administrative/global fee, applied for each transaction"
payout_settlement_timesobjectrequired

Holds the amount and unit of time it takes for a settlement to occur

settlement_timeintegerrequired
settlement_time_unitstringrequired
payout_limitsobjectrequired

Defines the limits for payouts min, max size of payment and the maximum amount per beneficiary

currencystringrequired
min_payment_sizestring(double)required
max_payment_sizestring(double)required
max_amount_per_beneficiarystring(double)required
receiver_payout_methodstring
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_methods \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
    "payout_category": "string",
    "payout_method_name": "string",
    "payout_method_display_name": "string",
    "payout_method_description": "string",
    "payout_country": "string",
    "payout_currency": "string",
    "supported_usecase": "string",
    "rounding_rules": {
      "payout_amount_fee_calculation_decimal_scale": 2
    },
    "fee_calculation_rule": "REGULAR",
    "payout_fees": [
      {
        "currency": "AUD",
        "from_amount": 0,
        "to_amount": 1000,
        "fee_amount": 5,
        "fee_percent": 2,
        "min_fee_amount": 25,
        "max_fee_amount": 100,
        "fee_type": "REGULAR",
        "description": "Administrative/global fee, applied for each transaction"
      }
    ],
    "payout_settlement_times": {
      "settlement_time": 0,
      "settlement_time_unit": "string"
    },
    "payout_limits": {
      "currency": "string",
      "min_payment_size": "string",
      "max_payment_size": "string",
      "max_amount_per_beneficiary": "string"
    },
    "receiver_payout_method": "string"
  }'

Responses

Returns details about the created payout method

Bodyapplication/json
payout_method_idstring(uuid)required
payout_partner_idstring(uuid)required
payout_partner_namestringrequired
Example: "Tranglo"
payout_categorystringrequired
Example: "BANK | EWALLET | CASH_PICKUP | ATM"
payout_method_namestringrequired
Example: "tranglo_bank_treasury_AU_AUD_payout"
payout_method_display_namestringrequired
Example: "Tranglo treasury bank AUD payout in AT"
payout_method_descriptionstringrequired
Example: "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case"
payout_method_statusstringrequired
Enum"ACTIVE""DELETED"
payout_countrystring^[A-Z]{2}$required

Payout country as two-letter ISO 3166-1 Alpha-2 code

Example: "AT"
payout_currencystringrequired
Example: "AUR"
supported_usecasestringrequired
Example: "TREASURY | P2P | B2B | B2C"
rounding_rulesobjectrequired

Holds the rules used to calculate fee

payout_amount_fee_calculation_decimal_scaleintegerrequired

When calculating percentage fees for this payout method, this the number of decimal places to round the payout amount by before multiplying by the percentage

Example: 2
fee_calculation_rulestringrequired

fee calculation rule. If set to REGULAR, find the matching range slabs, apply the percentage or fixed fee based on PayoutFeeType. A global/administrative fee can be applied on top of a slab fee.

Value"REGULAR"
payout_feesArray of objectsrequired
currencystringrequired
Example: "AUD"
from_amountstring(double)required
Example: 0
to_amountstring(double)required
Example: 1000
fee_amountstring(double)required

flat value fee

Example: 5
fee_percentstring(double)required

fee as percentage of payment

Example: 2
min_fee_amountstring(double)

minimum fee amount. Default to 0 (no minimum limit)

Example: 25
max_fee_amountstring(double)

maximum fee amount. Default to maximum number (no upper limit)

Example: 100
fee_typestringrequired

the calculation rule of payout fee element. By default, REGULAR. If set to AMINISTRACTIVE/GLOBAL, the fee should be applied to every transaction. If set to Hihger/Lower of Flat or Percentage fee, then the higher/lower amount of flat/pct fee will be applied

Enum"REGULAR""ADMINISTRATIVE""HIGHER_OF_FLAT_OR_PCT_FEE""LOWER_OF_FLAT_OR_PCT_FEE"
descriptionstring

description of the fee rules and other details

Example: "Administrative/global fee, applied for each transaction"
payout_settlement_timesobjectrequired

Holds the amount and unit of time it takes for a settlement to occur

settlement_timeintegerrequired
settlement_time_unitstringrequired
payout_limitsobjectrequired

Defines the limits for payouts min, max size of payment and the maximum amount per beneficiary

currencystringrequired
min_payment_sizestring(double)required
max_payment_sizestring(double)required
max_amount_per_beneficiarystring(double)required
receiver_payout_methodstring
Response
application/json
{
  "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
  "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
  "payout_partner_name": "Tranglo",
  "payout_category": "BANK | EWALLET | CASH_PICKUP | ATM",
  "payout_method_name": "tranglo_bank_treasury_AU_AUD_payout",
  "payout_method_display_name": "Tranglo treasury bank AUD payout in AT",
  "payout_method_description": "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case",
  "payout_method_status": "ACTIVE",
  "payout_country": "AT",
  "payout_currency": "AUR",
  "supported_usecase": "TREASURY | P2P | B2B | B2C",
  "rounding_rules": {
    "payout_amount_fee_calculation_decimal_scale": 2
  },
  "fee_calculation_rule": "REGULAR",
  "payout_fees": [
    { … }
  ],
  "payout_settlement_times": {
    "settlement_time": 0,
    "settlement_time_unit": "string"
  },
  "payout_limits": {
    "currency": "string",
    "min_payment_size": "string",
    "max_payment_size": "string",
    "max_amount_per_beneficiary": "string"
  },
  "receiver_payout_method": "string"
}

Delete an existing payout method

Request

Deletes the payout method from our database

Security
oauth2
Path
payout_method_idstring(uuid)required

The id of the payout method to delete.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_methods/{payout_method_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successfully deleted the payout method

Body
Response
No content

Get details about an existing payout method

Request

Returns the details about the payout method

Security
oauth2
Path
payout_method_idstring(uuid)required

The id of the payout method to retrieve.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_methods/{payout_method_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns details about the payout method

Bodyapplication/json
payout_method_idstring(uuid)required
payout_partner_idstring(uuid)required
payout_partner_namestringrequired
Example: "Tranglo"
payout_categorystringrequired
Example: "BANK | EWALLET | CASH_PICKUP | ATM"
payout_method_namestringrequired
Example: "tranglo_bank_treasury_AU_AUD_payout"
payout_method_display_namestringrequired
Example: "Tranglo treasury bank AUD payout in AT"
payout_method_descriptionstringrequired
Example: "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case"
payout_method_statusstringrequired
Enum"ACTIVE""DELETED"
payout_countrystring^[A-Z]{2}$required

Payout country as two-letter ISO 3166-1 Alpha-2 code

Example: "AT"
payout_currencystringrequired
Example: "AUR"
supported_usecasestringrequired
Example: "TREASURY | P2P | B2B | B2C"
rounding_rulesobjectrequired

Holds the rules used to calculate fee

payout_amount_fee_calculation_decimal_scaleintegerrequired

When calculating percentage fees for this payout method, this the number of decimal places to round the payout amount by before multiplying by the percentage

Example: 2
fee_calculation_rulestringrequired

fee calculation rule. If set to REGULAR, find the matching range slabs, apply the percentage or fixed fee based on PayoutFeeType. A global/administrative fee can be applied on top of a slab fee.

Value"REGULAR"
payout_feesArray of objectsrequired
currencystringrequired
Example: "AUD"
from_amountstring(double)required
Example: 0
to_amountstring(double)required
Example: 1000
fee_amountstring(double)required

flat value fee

Example: 5
fee_percentstring(double)required

fee as percentage of payment

Example: 2
min_fee_amountstring(double)

minimum fee amount. Default to 0 (no minimum limit)

Example: 25
max_fee_amountstring(double)

maximum fee amount. Default to maximum number (no upper limit)

Example: 100
fee_typestringrequired

the calculation rule of payout fee element. By default, REGULAR. If set to AMINISTRACTIVE/GLOBAL, the fee should be applied to every transaction. If set to Hihger/Lower of Flat or Percentage fee, then the higher/lower amount of flat/pct fee will be applied

Enum"REGULAR""ADMINISTRATIVE""HIGHER_OF_FLAT_OR_PCT_FEE""LOWER_OF_FLAT_OR_PCT_FEE"
descriptionstring

description of the fee rules and other details

Example: "Administrative/global fee, applied for each transaction"
payout_settlement_timesobjectrequired

Holds the amount and unit of time it takes for a settlement to occur

settlement_timeintegerrequired
settlement_time_unitstringrequired
payout_limitsobjectrequired

Defines the limits for payouts min, max size of payment and the maximum amount per beneficiary

currencystringrequired
min_payment_sizestring(double)required
max_payment_sizestring(double)required
max_amount_per_beneficiarystring(double)required
receiver_payout_methodstring
Response
application/json
{
  "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
  "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
  "payout_partner_name": "Tranglo",
  "payout_category": "BANK | EWALLET | CASH_PICKUP | ATM",
  "payout_method_name": "tranglo_bank_treasury_AU_AUD_payout",
  "payout_method_display_name": "Tranglo treasury bank AUD payout in AT",
  "payout_method_description": "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case",
  "payout_method_status": "ACTIVE",
  "payout_country": "AT",
  "payout_currency": "AUR",
  "supported_usecase": "TREASURY | P2P | B2B | B2C",
  "rounding_rules": {
    "payout_amount_fee_calculation_decimal_scale": 2
  },
  "fee_calculation_rule": "REGULAR",
  "payout_fees": [
    { … }
  ],
  "payout_settlement_times": {
    "settlement_time": 0,
    "settlement_time_unit": "string"
  },
  "payout_limits": {
    "currency": "string",
    "min_payment_size": "string",
    "max_payment_size": "string",
    "max_amount_per_beneficiary": "string"
  },
  "receiver_payout_method": "string"
}

Update an existing payout method

Request

Returns the updated details about the payout method

Security
oauth2
Path
payout_method_idstring(uuid)required

The id of the payout method to update.

Bodyapplication/jsonrequired

The payout method to update.

payout_method_idstring(uuid)required
payout_partner_idstring(uuid)required
payout_partner_namestringrequired
Example: "Tranglo"
payout_categorystringrequired
Example: "BANK | EWALLET | CASH_PICKUP | ATM"
payout_method_namestringrequired
Example: "tranglo_bank_treasury_AU_AUD_payout"
payout_method_display_namestringrequired
Example: "Tranglo treasury bank AUD payout in AT"
payout_method_descriptionstringrequired
Example: "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case"
payout_method_statusstringrequired
Enum"ACTIVE""DELETED"
payout_countrystring^[A-Z]{2}$required

Payout country as two-letter ISO 3166-1 Alpha-2 code

Example: "AT"
payout_currencystringrequired
Example: "AUR"
supported_usecasestringrequired
Example: "TREASURY | P2P | B2B | B2C"
rounding_rulesobjectrequired

Holds the rules used to calculate fee

payout_amount_fee_calculation_decimal_scaleintegerrequired

When calculating percentage fees for this payout method, this the number of decimal places to round the payout amount by before multiplying by the percentage

Example: 2
fee_calculation_rulestringrequired

fee calculation rule. If set to REGULAR, find the matching range slabs, apply the percentage or fixed fee based on PayoutFeeType. A global/administrative fee can be applied on top of a slab fee.

Value"REGULAR"
payout_feesArray of objectsrequired
currencystringrequired
Example: "AUD"
from_amountstring(double)required
Example: 0
to_amountstring(double)required
Example: 1000
fee_amountstring(double)required

flat value fee

Example: 5
fee_percentstring(double)required

fee as percentage of payment

Example: 2
min_fee_amountstring(double)

minimum fee amount. Default to 0 (no minimum limit)

Example: 25
max_fee_amountstring(double)

maximum fee amount. Default to maximum number (no upper limit)

Example: 100
fee_typestringrequired

the calculation rule of payout fee element. By default, REGULAR. If set to AMINISTRACTIVE/GLOBAL, the fee should be applied to every transaction. If set to Hihger/Lower of Flat or Percentage fee, then the higher/lower amount of flat/pct fee will be applied

Enum"REGULAR""ADMINISTRATIVE""HIGHER_OF_FLAT_OR_PCT_FEE""LOWER_OF_FLAT_OR_PCT_FEE"
descriptionstring

description of the fee rules and other details

Example: "Administrative/global fee, applied for each transaction"
payout_settlement_timesobjectrequired

Holds the amount and unit of time it takes for a settlement to occur

settlement_timeintegerrequired
settlement_time_unitstringrequired
payout_limitsobjectrequired

Defines the limits for payouts min, max size of payment and the maximum amount per beneficiary

currencystringrequired
min_payment_sizestring(double)required
max_payment_sizestring(double)required
max_amount_per_beneficiarystring(double)required
receiver_payout_methodstring
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/payout_methods/{payout_method_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
    "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
    "payout_partner_name": "Tranglo",
    "payout_category": "BANK | EWALLET | CASH_PICKUP | ATM",
    "payout_method_name": "tranglo_bank_treasury_AU_AUD_payout",
    "payout_method_display_name": "Tranglo treasury bank AUD payout in AT",
    "payout_method_description": "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case",
    "payout_method_status": "ACTIVE",
    "payout_country": "AT",
    "payout_currency": "AUR",
    "supported_usecase": "TREASURY | P2P | B2B | B2C",
    "rounding_rules": {
      "payout_amount_fee_calculation_decimal_scale": 2
    },
    "fee_calculation_rule": "REGULAR",
    "payout_fees": [
      {
        "currency": "AUD",
        "from_amount": 0,
        "to_amount": 1000,
        "fee_amount": 5,
        "fee_percent": 2,
        "min_fee_amount": 25,
        "max_fee_amount": 100,
        "fee_type": "REGULAR",
        "description": "Administrative/global fee, applied for each transaction"
      }
    ],
    "payout_settlement_times": {
      "settlement_time": 0,
      "settlement_time_unit": "string"
    },
    "payout_limits": {
      "currency": "string",
      "min_payment_size": "string",
      "max_payment_size": "string",
      "max_amount_per_beneficiary": "string"
    },
    "receiver_payout_method": "string"
  }'

Responses

Returns updated details about the payout method

Bodyapplication/json
payout_method_idstring(uuid)required
payout_partner_idstring(uuid)required
payout_partner_namestringrequired
Example: "Tranglo"
payout_categorystringrequired
Example: "BANK | EWALLET | CASH_PICKUP | ATM"
payout_method_namestringrequired
Example: "tranglo_bank_treasury_AU_AUD_payout"
payout_method_display_namestringrequired
Example: "Tranglo treasury bank AUD payout in AT"
payout_method_descriptionstringrequired
Example: "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case"
payout_method_statusstringrequired
Enum"ACTIVE""DELETED"
payout_countrystring^[A-Z]{2}$required

Payout country as two-letter ISO 3166-1 Alpha-2 code

Example: "AT"
payout_currencystringrequired
Example: "AUR"
supported_usecasestringrequired
Example: "TREASURY | P2P | B2B | B2C"
rounding_rulesobjectrequired

Holds the rules used to calculate fee

payout_amount_fee_calculation_decimal_scaleintegerrequired

When calculating percentage fees for this payout method, this the number of decimal places to round the payout amount by before multiplying by the percentage

Example: 2
fee_calculation_rulestringrequired

fee calculation rule. If set to REGULAR, find the matching range slabs, apply the percentage or fixed fee based on PayoutFeeType. A global/administrative fee can be applied on top of a slab fee.

Value"REGULAR"
payout_feesArray of objectsrequired
currencystringrequired
Example: "AUD"
from_amountstring(double)required
Example: 0
to_amountstring(double)required
Example: 1000
fee_amountstring(double)required

flat value fee

Example: 5
fee_percentstring(double)required

fee as percentage of payment

Example: 2
min_fee_amountstring(double)

minimum fee amount. Default to 0 (no minimum limit)

Example: 25
max_fee_amountstring(double)

maximum fee amount. Default to maximum number (no upper limit)

Example: 100
fee_typestringrequired

the calculation rule of payout fee element. By default, REGULAR. If set to AMINISTRACTIVE/GLOBAL, the fee should be applied to every transaction. If set to Hihger/Lower of Flat or Percentage fee, then the higher/lower amount of flat/pct fee will be applied

Enum"REGULAR""ADMINISTRATIVE""HIGHER_OF_FLAT_OR_PCT_FEE""LOWER_OF_FLAT_OR_PCT_FEE"
descriptionstring

description of the fee rules and other details

Example: "Administrative/global fee, applied for each transaction"
payout_settlement_timesobjectrequired

Holds the amount and unit of time it takes for a settlement to occur

settlement_timeintegerrequired
settlement_time_unitstringrequired
payout_limitsobjectrequired

Defines the limits for payouts min, max size of payment and the maximum amount per beneficiary

currencystringrequired
min_payment_sizestring(double)required
max_payment_sizestring(double)required
max_amount_per_beneficiarystring(double)required
receiver_payout_methodstring
Response
application/json
{
  "payout_method_id": "ec4c9578-6718-4d77-b850-74b3ea0bf0cd",
  "payout_partner_id": "65606de6-d86e-468e-8e69-55184fddf40c",
  "payout_partner_name": "Tranglo",
  "payout_category": "BANK | EWALLET | CASH_PICKUP | ATM",
  "payout_method_name": "tranglo_bank_treasury_AU_AUD_payout",
  "payout_method_display_name": "Tranglo treasury bank AUD payout in AT",
  "payout_method_description": "Tranglo bank (payout category) AUD payout in Australia (AT) for treasury use case",
  "payout_method_status": "ACTIVE",
  "payout_country": "AT",
  "payout_currency": "AUR",
  "supported_usecase": "TREASURY | P2P | B2B | B2C",
  "rounding_rules": {
    "payout_amount_fee_calculation_decimal_scale": 2
  },
  "fee_calculation_rule": "REGULAR",
  "payout_fees": [
    { … }
  ],
  "payout_settlement_times": {
    "settlement_time": 0,
    "settlement_time_unit": "string"
  },
  "payout_limits": {
    "currency": "string",
    "min_payment_size": "string",
    "max_payment_size": "string",
    "max_amount_per_beneficiary": "string"
  },
  "receiver_payout_method": "string"
}

Data requirements

Operations

Payouts

Operations

PayoutsV2

Operations

Quotes

Operations

Webhooks

Operations

Tranglo

Operations

Routing

Operations

Data Requirement

Operations