Skip to content

Payment Methods API

The Payment Methods API returns available payment methods for a given country, currency, and entity type combination. Use this to determine which transfer methods are available before collecting bank account details.

Endpoints

List Payment Methods

Retrieve available payment methods for a specific country, currency, and entity type. This endpoint does not require a company context.

Endpoint

GET /api/v1/payment_methods

Headers

Authorization: Bearer {jwt_token}
Content-Type: application/json

Query Parameters

Parameter Type Required Description
country_code string Yes ISO 3166-1 alpha-2 country code (e.g., US, GB)
currency_code string Yes ISO 4217 currency code (e.g., USD, EUR)
entity_type string Yes Entity type: COMPANY or PERSONAL

Case Insensitive

All query parameters are case-insensitive. For example, us and US are treated the same.

Example Request

curl -X GET "https://api.treasurypath.com/api/v1/payment_methods?country_code=US&currency_code=USD&entity_type=COMPANY" \
  -H "Authorization: Bearer {jwt_token}" \
  -H "Content-Type: application/json"

Success Response (200 OK)

{
  "data": [
    {
      "transfer_method": "LOCAL",
      "local_clearing_systems": ["ACH", "FEDWIRE"]
    },
    {
      "transfer_method": "SWIFT",
      "local_clearing_systems": []
    }
  ]
}

Response Fields

Field Type Description
transfer_method string Transfer method identifier (e.g., LOCAL, SWIFT)
local_clearing_systems array Available local clearing systems for this method (e.g., ACH, FEDWIRE)

Error Responses

400 Bad Request - Missing Parameter

{
  "errors": [
    {
      "field": "country_code",
      "message": "country_code is required"
    }
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "field": "token",
      "message": "Missing or invalid token"
    }
  ]
}

Usage

Use this endpoint as the first step when building a bank account form:

  1. List payment methods to show available transfer options to the user
  2. Fetch bank account requirements using the selected transfer method to get form fields
  3. Create bank account with the collected form data