API references
Search documentation... ⌘K
API references
Merchant API

Set primary bank account

Configure the bank account where you want to receive payouts from your payment transactions. This bank account will be used for:

  • Receiving settlement funds from successful payments
  • Automated payouts based on your payout schedule
  • Manual payout requests

If you already have a primary bank account set up, using this endpoint will:

  • Replace your existing primary bank account with the new one
  • Keep the old bank account record for audit purposes
  • Immediately start using the new account for future payouts

Important: The bank account must be in the same country as your payment provider. For example, if your provider is in Thailand, you must provide a Thai bank account.

The endpoint returns a unique identifier for the bank account that you can use to reference it in other API calls.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/set-primary-bank-account HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
bank_code: string,
number: string,
name: string,
country_code: string,
}
Returns: string
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
bank_code string

Required. The bank's code in your country's banking system. For example, in Thailand this would be the 3-digit bank code assigned by the Bank of Thailand.

number string

Required. Your bank account number, exactly as it appears on your bank statement or online banking.

name string

Required. The account holder's name as registered with the bank. This must match your bank account exactly to avoid payout issues.

country_code string

Required. The two-letter ISO country code where the bank account is located (e.g. TH for Thailand, SG for Singapore). Must match your provider's country.

Errors specific to this endpoint
COUNTRY_MISMATCH

The bank account's country code does not match your payment provider's country. You must provide a bank account in the same country as your provider to receive payouts.

Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/set-primary-bank-account" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{
        "bank_code": "002",
        "number": "1234567890",
        "name": "John Doe",
        "country_code": "TH"
      }'

Learn how to run these code samples in your terminal by reading our guide.