Common
Balance
Institution
Payment
OTC
Convert
Payout
Gift Card
Subscription
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": ""
}Create Bank Account
Create a linked bank account for OTC settlement.
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": ""
}Documentation Index
Fetch the complete documentation index at: https://docs.gate.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This page documents thePOST /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, andpngformats 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
Merchant application client ID used to identify the calling app.
HMAC signature generated from the request according to GatePay signing rules.
Unix timestamp used for replay protection and signature verification.
Random nonce used together with the timestamp to prevent replay attacks.
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
Bank account name.
Bank name.
Country ID.
Bank address.
Account number or IBAN.
SWIFT.
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.
Routing or clearing code.
Agent bank name.
Agent bank SWIFT.