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 no longer supports the deprecated endpoint.

  • /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",
                    "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",
                    "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",
                    "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?beneficiary_country=mxpayout_currency=mxn' \
    -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": "5161e0bd-8e33-4097-ac4d-6d3e6fd45103"
        },
        "data": [
            {
                "payout_method_type": "mx_abc_capital_bank",
                "name": "UALA",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/mx_abc_capital_bank.png",
                "category": "bank",
                "beneficiary_country": "mx",
                "sender_country": "*",
                "payout_currencies": [
                    "MXN"
                ],
                "sender_entity_types": [
                    "company"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 999999999,
                        "minimum_amount": 1,
                        "payout_currency": "MXN"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "MXN",
                    "GBP",
                    "EUR"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            },
            {
                "payout_method_type": "mx_actinver_bank",
                "name": "Actinver",
                "is_cancelable": 0,
                "is_expirable": 0,
                "is_location_specific": 0,
                "status": 1,
                "image": "/checkout/mx_actinver_bank.png",
                "category": "bank",
                "beneficiary_country": "mx",
                "sender_country": "*",
                "payout_currencies": [
                    "MXN"
                ],
                "sender_entity_types": [
                    "company"
                ],
                "beneficiary_entity_types": [
                    "company",
                    "individual"
                ],
                "amount_range_per_currency": [
                    {
                        "maximum_amount": 999999999,
                        "minimum_amount": 1,
                        "payout_currency": "MXN"
                    }
                ],
                "minimum_expiration_seconds": null,
                "maximum_expiration_seconds": null,
                "sender_currencies": [
                    "USD",
                    "MXN",
                    "GBP",
                    "EUR"
                ],
                "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method."
            }
        ]
    }
  • 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."
      }
    }