Bank account validator

Validate a bank account

post

Validates the correctness of beneficiary details, checks if the account exists in the bank, and confirms if it can receive funds. The validations performed are:

1. The bank account, branch and type are valid.

2. The account exists in the bank.

3. The bank account belongs to the beneficiary details indicated (Document, name, etc).

4. The amount specified is within the minimum and maximum limits (optional, only performed if amount is sent).

5. The account can receive funds (it's not blocked, closed, etc).

Header parameters

X-Datestring · date-timeRequired

ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ)

X-LoginstringRequired

Merchant X-Login Cashouts API Key

AuthorizationstringRequired

Authorization control hash

Body

application/json

countrystring · max: 2Required

Country of the bank account to validate (ISO 3166-1 alpha-2).

documentstring · max: 30Required

Document of identity of the beneficiary.

document_typestring · max: 10Required

Type of the document specified.

first_namestring · max: 255Optional

First name of the beneficiary.

last_namestring · max: 255Optional

Last name of the beneficiary.

amountnumber · decimalOptional

Amount of the withdrawal.

currencystring · max: 3Optional

Currency of the amount (ISO 4217).

Responses

204

No Content. The bank account is valid and passed all validations.

400

Bad Request. A validation error occurred.

application/json

401

Unauthorized. Invalid credentials were provided.

application/json

post

/account/validate

HTTPcURLJavaScriptPython

POST /v5/account/validate HTTP/1.1
Host: api-stg.onekeypayments.com
X-Date: 2026-03-03T03:20:08.873Z
X-Login: text
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "country": "BR",
  "document": "84932568207",
  "document_type": "CPF",
  "first_name": "Ricardo",
  "last_name": "Carlos",
  "amount": 100,
  "currency": "BRL",
  "bank_account": {
    "bank_code": 100,
    "account": "123456-7",
    "branch": "6789-X",
    "account_type": "S"
  }
}

No content