List Payout Method Types

Retrieve a list of payout method types that you can use when creating a payout.

The response contains a list of objects. Each object includes a payout method type and its attributes.

Note

The two-letter prefix of the payout method type matches the beneficiary country code.
This endpoint replaces the deprecated endpoint - GET /v1/payouts/supported_types
Rapyd will continue to support the deprecated endpoint until December 31, 2024.

You can also use the Client Portal.

Parameters

Request Query Parameters

- beneficiary_country
- Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code.
- beneficiary_entity_type
- Filters the type of entity for the beneficiary. One of the following:
  - company
  - individual
- category
- The category of payout method type. One of the following:
  - bank
  - card
  - cash
  - ewallet - Local eWallet (non-Rapyd)
  - rapyd_ewallet - Rapyd wallet.
- ending_before
- The name of the payout method after the last one in the list.
- is_cancelable
- Indicates whether the payout can be canceled.
  Relevant when category is cash.
- is_expirable
- Indicates whether the payout expires if not completed.
  Relevant when category is cash.
- is_location_specific
- Indicates whether the payout must be made at a specific physical location.
  Relevant when category is cash.
- limit
- Maximum number of payout methods to return. Range: 1-1000. Integer.
  10
- payout_currency
- Currency received by the beneficiary. Three-letter ISO 4217 code.
- sender_country
- Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code.
- sender_currency
- Currency that the sender is paying with. Three-letter ISO 4217 code.
- sender_entity_type
- Filters the type of entity for the sender. One of the following:
  - company
  - individual
- starting_after
- The name of the payout method before the first one in the list.

Request Header Parameters

Response Parameters

- amount_range_per_currency
- An array of objects that describe limits on the amount, per currency. Each object contains the following fields:
  - maximum_amount
    Maximum amount supported by this payout method for the indicated currency. Decimal.
  - minimum_amount
    Minimum amount supported by this payout method for the indicated currency. Decimal.
  - payout_currency
    Currency of the payout. Three-letter ISO 4217 code.
- beneficiary_country
- Country of the beneficiary. Two-letter ISO 3166-1 ALPHA-2 code.
- beneficiary_entity_types
- A list of the beneficiary entity types supported by this payout method. Array of strings. One or more of the following:
  - company
  - individual
- category
- The category of payout method type. One of the following:
  - bank
  - card
  - cash
  - ewallet - Local eWallet (non-Rapyd)
  - rapyd_ewallet - Rapyd wallet.
- image
- URL of an image that the merchant can use to represent the payout method.
- is_cancelable
- Indicates whether the payout can be canceled. Relevant when category is cash.
- is_expirable
- Indicates whether the payout expires if not completed. Relevant when category is cash.
- is_location_specific
- Indicates whether the payout must be made at a specific physical location. Relevant when category is cash.
- maximum_expiration_seconds
- The maximum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true.
- minimum_expiration_seconds
- The minimum time (in seconds) that the merchant can set for completing the payout. Relevant when is_expirable is true.
- name
- Payout method name.
- payout_currencies
- A list of the currencies supported by this payout method. Array of strings. Three-letter ISO 4217 code.
- payout_method_type
- The type of payout method. The two-letter prefix must match the beneficiary country code.
- sender_currencies
- List of currencies that the sender is paying with. Array of strings. Three-letter ISO 4217 code.
- sender_entity_types
- A list of the sender entity types supported by this payout method. Array of strings. One or more of the following:
  - company
  - individual
- status
- Indicates whether the payout method is currently available. One of the following values:
  - 0 - Not available.
  - 1 - Available.

Related Information

.NET

using System;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string payoutCurrency = "PHP";
                string limit = "2";

                string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payouts/supported_types?payout_currency={payoutCurrency}&limit={limit}");

                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}

JavaScript

const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;

async function main() {
  try {
    const result = await makeRequest(
      'GET',
      '/v1/payouts/supported_types?payout_currency=PHP&limit=2'
    );

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

PHP

<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/utilities.php";
include($path);

try {
    $object = make_request('get', '/v1/payouts/supported_types?payout_currency=PHP&limit=2');
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>

Python

from pprint import pprint

from utilities import make_request

payout_currency = 'PHP'

path = f'/v1/payouts/supported_types?&payout_currency={payout_currency}&limit=2'

results = make_request(method='get', path=path)
pprint(results)

/v1/payout_methods

List Payout Method Types

curl -X get
https://sandboxapi.rapyd.net/v1/payout_methods?payout_currency=php&limit=2
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "2c0d728e-a405-4827-a8b7-61d2235043ce"
    },
    "data": [
        {
            "payout_method_type": "ph_alamanahislamicinvestmentbank_bank",
            "name": "Bank Transfer to Al Amanah Islamic Investment Bank in the Philippines",
            "is_cancelable": 0,
            "is_expirable": 0,
            "is_location_specific": 0,
            "status": 1,
            "image": "/checkout/ph_alamanahislamicinvestmentbank_bank.png",
            "category": "bank",
            "beneficiary_country": "ph",
            "payout_currencies": [
                "PHP"
            ],
            "sender_entity_types": [
                "company"
            ],
            "beneficiary_entity_types": [
                "company",
                "individual"
            ],
            "amount_range_per_currency": [
                {
                    "maximum_amount": 500000,
                    "minimum_amount": 10,
                    "payout_currency": "PHP"
                }
            ],
            "minimum_expiration_seconds": null,
            "maximum_expiration_seconds": null,
            "sender_currencies": [
                "USD",
                "SGD",
                "GBP",
                "EUR"
            ]
        },
        {
            "payout_method_type": "ph_allied_bank",
            "name": "Bank Transfer to Allied Bank in the Philippines",
            "is_cancelable": 0,
            "is_expirable": 0,
            "is_location_specific": 0,
            "status": 1,
            "image": "/checkout/ph_allied_bank.png",
            "category": "bank",
            "beneficiary_country": "ph",
            "payout_currencies": [
                "PHP"
            ],
            "sender_entity_types": [
                "company",
                "individual"
            ],
            "beneficiary_entity_types": [
                "company",
                "individual"
            ],
            "amount_range_per_currency": [
                {
                    "maximum_amount": 500000,
                    "minimum_amount": null,
                    "payout_currency": "PHP"
                }
            ],
            "minimum_expiration_seconds": null,
            "maximum_expiration_seconds": null,
            "sender_currencies": [
                "USD",
                "SGD",
                "PHP",
                "GBP",
                "EUR"
            ]
        }
    ]
}

List Payout Method Types - Estimated Time of Arrival

curl -X get
https://sandboxapi.rapyd.net/v1/payout_methods?payout_currency=NZD&limit=1
-H 'access_key: your-access-key-here'
-H 'Content-Type: application/json'
-H 'salt: your-random-string-here'
-H 'signature: your-calculated-signature-here'
-H 'timestamp: your-unix-timestamp-here'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "80dd735b-291e-49d9-ba87-bdc2fe94d97d"
    },
    "data": [
        {
            "payout_method_type": "nz_ach_bank",
            "name": "NZ Bank Disbursements",
            "is_cancelable": 0,
            "is_expirable": 0,
            "is_location_specific": 0,
            "status": 1,
            "image": "/checkout/nz_ach_bank.png",
            "category": "bank",
            "beneficiary_country": "nz",
            "sender_country": "*",
            "payout_currencies": [
                "NZD"
            ],
            "sender_entity_types": [
                "company"
            ],
            "beneficiary_entity_types": [
                "company",
                "individual"
            ],
            "amount_range_per_currency": [
                {
                    "maximum_amount": null,
                    "minimum_amount": null,
                    "payout_currency": "NZD"
                }
            ],
            "minimum_expiration_seconds": null,
            "maximum_expiration_seconds": null,
            "sender_currencies": [
                "USD",
                "NZD"
            ],
            "estimated_time_of_arrival": "The beneficiary will receive the funds in about 1-2 business days."
  }
}

In this section:

Documentation