PaaS API Docs
  • Getting Started
  • Authentication
  • Use cases
    • Remittance
      • Bonus/Discount on Remittance
    • Business Payments
    • Individual Wallet
    • Business Wallet
    • Payout
  • API References
    • Data Population
      • Spec Sheet
      • Country
      • States
      • Settlement Rates
    • User
      • User Object
        • User Verification
        • Identification Documents
        • User Verification Status
        • CIP Information Status
      • Receive User Object
      • Register a User
      • Update User
      • Business Representatives
        • Business Representatives Object
        • Add Business Representatives
        • Update Business Representatives
        • Get Business Representatives
      • Declaration
        • Declaration Object
        • Declaration
      • Initiate Verification
      • Get User by ID
      • Get Verification Status
      • Add a Receive User
      • Update a Receive User
      • Get Receive User List
    • Funds
      • User Funding Account Object
      • Funding Account Widget
        • OAuth Integration
        • Bank Verification Status
      • Wallet Object
      • Create a Wallet
      • Get Wallet Details
      • Get User Funding Account
      • Delete User Funding Account
      • Add a Receive Account
      • Update a Receive Account
      • Get Receive Accounts
    • Payout
      • Get Banks
      • Get Payers
    • Transaction (External)
      • Transaction Object
      • Create Transaction
      • Get Transaction by ID
      • Cancel Transaction
      • Transaction Delivery
      • Get Transaction Limits
    • Transaction (Wallet)
      • Wallet Transfer Object
      • Create Transfers
        • Load Wallet
        • Unload Wallet
        • Wallet to Wallet Transfer
      • Get Wallet Transfer Details
      • Get Limits
    • Transaction (Payout)
      • Payout Transaction Object
      • Create Payout Transaction
    • Webhooks
      • Subscribe
      • Integration
      • Events
    • Error Codes
  • Sandbox
    • User: Test Values
    • Funds: Test Values
    • Transaction: Test Values
  • Changelog
    • 2023
      • February 14, 2023
      • January 06, 2023
    • 2022
      • December 28, 2022
      • December 26, 2022
      • December 23, 2022
      • December 2, 2022
      • November 21, 2022
      • November 11, 2022
      • October 31, 2022
      • October 17, 2022
      • August 31, 2022
      • August 1, 2022
      • July 25, 2022
      • May 23, 2022
      • April 7, 2022
      • March 30, 2022
      • March 23, 2022
      • Feb 21, 2022
      • Feb 15, 2022
      • Jan 24, 2022
      • Jan 19, 2022
      • March 10, 2022
Powered by GitBook
On this page
  • Get bank list
  • Get bank by ID

Was this helpful?

  1. API References
  2. Payout

Get Banks

Read on populating banks available for payout

PreviousPayoutNextGet Payers

Last updated 2 years ago

Was this helpful?

The bank and branch APIs provide the list of banks and their respective branches that are available in the destination country.

Get bank list

GET /banks?country={{country}}

Name

Type

Required

Description

country

String

No

curl --location --request GET '{{url}}/banks' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
{
        "branches": [
            {
                "id": 169,
                "name": "Default Branch"
            }
        ],
        "country": "CO",
        "id": 126,
        "name": "Banco Santander De Negocios",
        "txn_supported_types": [
            "C2C",
            "B2B",
            "B2C"
        ]
    },
    {
        "branches": [
            {
                "id": 101,
                "name": "Default Branch"
            }
        ],
        "country": "MX",
        "id": 58,
        "name": "All Banks / Payment Type: Clabe",
        "txn_supported_types": [
            "C2C"
        ]
    }

Get bank by ID

GET /banks/{{bankId}}

curl --location --request GET '{{url}}/banks/{bank_id}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
{
    "branches": [
        {
            "id": 169,
            "name": "Default Branch"
        }
    ],
    "country": "CO",
    "id": 126,
    "name": "Banco Santander De Negocios",
    "receiving_currency": [
        "COP"
    ],
    "txn_supported_types": [
        "C2C",
        "B2B",
        "B2C"
    ]
}
2-letter ISO code of the user’s country.