Skip to main content

Documentation

List Payout Method Types

Retrieve a list of payout method types that you can use when creating a payout. The response returns one payout method type for each supported beneficiary country with the supported payout currencies.

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 endpoints - GET /v1/payouts/supported_types and GET /v1/payouts/payout_methods.

    Rapyd will continue to support the deprecated endpoints until December 31, 2024.

  • /v1/payout_method_types

  • List Payout Method Types - Payout Currency Specified

  • curl -X get
    https://sandboxapi.rapyd.net/v1/payout_method_types?payout_currency=USD
    -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'
    
  • // Due to the length of the response, a shortened version is displayed.  
    {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "2ea08d45-c91e-4417-874d-6b72c5500445"
        },
        "data": [
            {
                "payout_method_type": "xx_mastercard_card",
                "name": "Push funds to Mastercard Card",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/xx_mastercard_card.png",
                "category": "card",
                "beneficiary_country": "SV",
                "sender_country": "*",
                "payout_currencies": [
                    "USD"
                ],
                "sender_entity_types": [
                    "company",
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "USD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "HKD",
                    "GBP",
                    "EUR",
                    "AUD"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 3 hours."
            },
            {
                "payout_method_type": "xx_mastercard_card",
                "name": "Push funds to Mastercard Card",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/xx_mastercard_card.png",
                "category": "card",
                "beneficiary_country": "US",
                "sender_country": "*",
                "payout_currencies": [
                    "USD"
                ],
                "sender_entity_types": [
                    "company",
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "USD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "HKD",
                    "GBP",
                    "EUR",
                    "AUD"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 3 hours."
            },
            {
                "payout_method_type": "xx_swift_bank",
                "name": "Global SWIFT",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconsli",
                "category": "bank",
                "beneficiary_country": "AM",
                "sender_country": "*",
                "payout_currencies": [
                    "USD"
                ],
                "sender_entity_types": [
                    "company"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "USD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "SEK",
                    "NOK",
                    "ISK",
                    "HKD",
                    "GBP",
                    "EUR",
                    "DKK",
                    "CHF",
                    "CAD",
                    "AUD"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 2 business days."
            },
            {
                "payout_method_type": "xx_swift_bank",
                "name": "Global SWIFT",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconsli",
                "category": "bank",
                "beneficiary_country": "AO",
                "sender_country": "*",
                "payout_currencies": [
                    "USD"
                ],
                "sender_entity_types": [
                    "company"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "USD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "SEK",
                    "NOK",
                    "ISK",
                    "HKD",
                    "GBP",
                    "EUR",
                    "DKK",
                    "CHF",
                    "CAD",
                    "AUD"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 2 business days."
            },
            {
                "payout_method_type": "xx_swift_bank",
                "name": "Global SWIFT",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconslib.rapyd.net/https://deviconsli",
                "category": "bank",
                "beneficiary_country": "AT",
                "sender_country": "*",
                "payout_currencies": [
                    "USD"
                ],
                "sender_entity_types": [
                    "company"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "USD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "SEK",
                    "NOK",
                    "ISK",
                    "HKD",
                    "GBP",
                    "EUR",
                    "DKK",
                    "CHF",
                    "CAD",
                    "AUD"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 2 business days."
            }
        ]
    } 
                       
  • List Payout Method Types - Multiple Query Filters

  • curl -X get
    https://sandboxapi.rapyd.net/v1/payout_method_types?payout_currency=HKD&beneficiary_entity_type=individual&sender_entity_type=individual&category=bank
    -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": "34ff4c8e-584b-4c21-9bd4-9a9628b771ab"
        },
        "data": [
            {
                "payout_method_type": "br_zcscenario2b_bank",
                "name": "br zcscenario2b bank",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": null,
                "category": "bank",
                "beneficiary_country": "*",
                "sender_country": "*",
                "payout_currencies": [
                    "*"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 120000,
                        "minimum_amount": 12,
                        "payout_currency": "*"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "*"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 3 hours."
            },
            {
                "payout_method_type": "hk_chats_bank",
                "name": "HK Bank Disburse via CHATS (RTGS)",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/https://qaiconslib.rapyd.net/checkout/hk_chats_bank.png",
                "category": "bank",
                "beneficiary_country": "HK",
                "sender_country": "*",
                "payout_currencies": [
                    "HKD",
                    "*"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 1000000000,
                        "minimum_amount": 1,
                        "payout_currency": "*"
                    },
                    {
                        "maximum_amount": 1000000000,
                        "minimum_amount": 1,
                        "payout_currency": "HKD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "HKD",
                    "GBP",
                    "EUR",
                    "AUD"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes."
            },
            {
                "payout_method_type": "hk_fps_bank",
                "name": "HK Bank Disburse via FPS (RTP) with bank account details",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/hk_fps_bank.png",
                "category": "bank",
                "beneficiary_country": "hk",
                "sender_country": "*",
                "payout_currencies": [
                    "HKD"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 10000000,
                        "minimum_amount": 1,
                        "payout_currency": "HKD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "HKD",
                    "GBP",
                    "EUR"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes."
            },
            {
                "payout_method_type": "hk_fps_proxy_bank",
                "name": "HK Bank and eWallet Disburse via FPS (RTP) with FPS ID, HKID, mobile number or email address",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/hk_fps_proxy_bank.png",
                "category": "bank",
                "beneficiary_country": "hk",
                "sender_country": "*",
                "payout_currencies": [
                    "HKD"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 10000000,
                        "minimum_amount": 1,
                        "payout_currency": "HKD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "HKD",
                    "GBP",
                    "EUR"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "hk_fps_proxy_rapydgw_bank",
                "name": "HK Bank and eWallet Disburse via FPS (RTP) with FPS ID, HKID, mobile number or email address for RapydGW",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": null,
                "category": "bank",
                "beneficiary_country": "HK",
                "sender_country": "HK",
                "payout_currencies": [
                    "HKD"
                ],
                "sender_entity_types": [
                    "company",
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 10000000,
                        "minimum_amount": 1,
                        "payout_currency": "HKD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "HKD"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "hk_fps_rapydgw_bank",
                "name": "HK Bank Disburse via FPS (RTP) with bank account details for RapydGW",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": null,
                "category": "bank",
                "beneficiary_country": "HK",
                "sender_country": "HK",
                "payout_currencies": [
                    "HKD"
                ],
                "sender_entity_types": [
                    "company",
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 10000000,
                        "minimum_amount": 1,
                        "payout_currency": "HKD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "HKD"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "il_rapyd_test_nft_bank",
                "name": "Bank Payout for NFT",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": null,
                "category": "bank",
                "beneficiary_country": "*",
                "sender_country": "*",
                "payout_currencies": [
                    "*"
                ],
                "sender_entity_types": [
                    "company",
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "*"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "*"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "il_rapyd_test_qa_bank",
                "name": "Rapyd IL bank test",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "",
                "category": "bank",
                "beneficiary_country": "il",
                "sender_country": "IL",
                "payout_currencies": [
                    "*"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "*"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "*"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "il_shaharb444_bank",
                "name": "shahar huge liron",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": null,
                "category": "bank",
                "beneficiary_country": "AF",
                "sender_country": "AF",
                "payout_currencies": [
                    "*"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 3,
                        "minimum_amount": 2,
                        "payout_currency": "*"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "AED"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "qa_regression22_bank",
                "name": "qa regression22 bank",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": null,
                "category": "bank",
                "beneficiary_country": "*",
                "sender_country": "*",
                "payout_currencies": [
                    "*"
                ],
                "sender_entity_types": [
                    "company",
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "*"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "*"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "sg_dbs_bank",
                "name": "DBS Payments",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/sg_dbs_bank.png",
                "category": "bank",
                "beneficiary_country": "SG",
                "sender_country": "*",
                "payout_currencies": [
                    "HKD"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 100000000,
                        "minimum_amount": 1,
                        "payout_currency": "HKD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "GBP",
                    "EUR"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes."
            },
            {
                "payout_method_type": "us_rapyd_test_qa_bank",
                "name": "Rapyd US bank test",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "",
                "category": "bank",
                "beneficiary_country": "us",
                "sender_country": "US",
                "payout_currencies": [
                    "*"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "*"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "*"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "us_test_zc_cash",
                "name": "QA test zc cash",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/us_test_zc_cash.png",
                "category": "bank",
                "beneficiary_country": "*",
                "sender_country": "*",
                "payout_currencies": [
                    "*"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": null,
                        "payout_currency": "*"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "*"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 3 hours."
            },
            {
                "payout_method_type": "xx_crossborder_bank",
                "name": "Global SWIFT",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": null,
                "category": "bank",
                "beneficiary_country": "HK",
                "sender_country": "*",
                "payout_currencies": [
                    "HKD"
                ],
                "sender_entity_types": [
                    "individual"
                ],
                "beneficiary_entity_types": [
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": null,
                        "minimum_amount": 1,
                        "payout_currency": "HKD"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "SGD",
                    "SEK",
                    "NOK",
                    "ISK",
                    "HKD",
                    "GBP",
                    "EUR",
                    "DKK",
                    "CHF",
                    "CAD",
                    "AUD"
                ],
                "estimated_time_of_arrival": "The beneficiary will receive the funds within 2 business days."
            }
        ]
    }
  • List Payout Method Types - Estimated Time of Arrival

  • curl -X get
    https://sandboxapi.rapyd.net/v1/payout_method_types?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."
      }
    }