Skip to main content
POST
/
withdraw
/
open
/
institution
/
otc
/
api
/
bank
/
create
Create Bank Account
curl --request POST \
  --url https://openplatform.gateapi.io/withdraw/open/institution/otc/api/bank/create \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --form 'bankAccountName=<string>' \
  --form 'bankName=<string>' \
  --form countryId=123 \
  --form 'address=<string>' \
  --form 'iban=<string>' \
  --form 'swift=<string>' \
  --form file='@example-file'
{
  "code": "000000",
  "data": {
    "bankAccountId": "2897434",
    "needSupplementMaterial": false
  },
  "status": "SUCCESS",
  "errorMessage": ""
}

​
Overview

This page documents the POST /withdraw/open/institution/otc/api/bank/create endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

  • Authentication uses the standard GatePay signed headers.
  • This page documents the institution-path version of the same endpoint.
  • Except for create sub-account, query sub-account detail, and list sub-accounts, institution requests must include X-GatePay-On-Behalf-Of.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

​
Supplemental Field Notes

​
Request Format

  • Content-Type: multipart/form-data
  • Use this endpoint to add a bank account before OTC fiat withdrawal. A bank statement file must be uploaded together with the bank account details.

​
file Upload Requirements

  • Type: file
  • Required: Yes
  • Description: The file must not exceed 4 MB and only jpg, jpeg, and png formats are accepted. Upload a bank statement issued within the last 3 months. The bank account name must exactly match the verified identity name. If there is any difference due to language or similar reasons, also provide supporting documents such as a bank certification letter, passport, or an official name-change receipt.

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant application client ID used to identify the calling app.

​
X-GatePay-Signature
string
required

HMAC signature generated from the request according to GatePay signing rules.

​
X-GatePay-Timestamp
string
required

Unix timestamp used for replay protection and signature verification.

​
X-GatePay-Nonce
string
required

Random nonce used together with the timestamp to prevent replay attacks.

​
X-GatePay-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Body

multipart/form-data
​
bankAccountName
string
required

Bank account name.

​
bankName
string
required

Bank name.

​
countryId
integer
required

Country ID.

​
address
string
required

Bank address.

​
iban
string
required

Account number or IBAN.

​
swift
string
required

SWIFT.

​
file
file
required

Bank statement file. The file must not exceed 4 MB and only jpg, jpeg, and png formats are accepted. Upload a bank statement issued within the last 3 months. The bank account name must exactly match the verified identity name. If there is any difference due to language or similar reasons, also provide supporting documents such as a bank certification letter, passport, or an official name-change receipt.

​
remittanceLineNumber
string

Routing or clearing code.

​
agentBankName
string

Agent bank name.

​
agentBankSwift
string

Agent bank SWIFT.

Response

200 - application/json

Success

​
code
string

Business response code.

​
status
string

Top-level request status.

​
errorMessage
string

Error message returned when the request fails.

​
data
object

Created bank account information.