Skip to main content
POST
/
merchant
/
open
/
institution
/
v1
/
accounts
/
create
Create Sub-Account
curl --request POST \
  --url https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "request_id": "35778162074976257",
  "customer_id": "1234",
  "display_name": "my test",
  "account_holder": {
    "entity_country": "AF",
    "entity_type": "BUSINESS",
    "entity_name": "My Business Ltd",
    "entity_id_type": "BUSINESS_LICENSE",
    "entity_id_number": "abcd1234",
    "entity_id_expiry": {
      "valid_from": 1763538010509
    },
    "address": {
      "line1": "123 Main Street",
      "country": "AF"
    },
    "merchant_category": "GENERAL_RETAIL",
    "user_agreement": true,
    "ubo_list": [
      {
        "country": "AF",
        "full_name": "testName778",
        "dob": {
          "year": 2026,
          "month": 3,
          "day": 3
        },
        "id_type": "DRIVING_LICENSE",
        "id_number": "130",
        "id_expiry": {
          "valid_from": 1773135745000,
          "valid_to": 1873135745000
        },
        "relationship": {
          "is_representative": false,
          "is_owner": false,
          "percent_ownership": "30"
        }
      }
    ]
  }
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "request_id": "35778162074976257",
    "status": "INIT",
    "created": "1764139242707",
    "display_name": "my test",
    "customer_id": "1234",
    "account_holder": {
      "entity_country": "AF",
      "entity_type": "BUSINESS",
      "entity_name": "My Business Ltd",
      "entity_id_type": "BUSINESS_LICENSE",
      "entity_id_number": "abcd1234",
      "entity_id_expiry": {
        "valid_from": 1763538010509,
        "valid_to": null
      },
      "dob": null,
      "business_registration": null,
      "address": {
        "line1": "123 Main Street",
        "country": "AF"
      },
      "merchant_category": "GENERAL_RETAIL",
      "website": null,
      "user_agreement": true
    },
    "metadata": null
  }
}

​
Overview

This page documents the POST /merchant/open/institution/v1/accounts/create endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

The clientId assigned when the merchant registers an application in the Gate merchant console.

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Timestamp
string
required

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Example:

"9578"

​
X-GatePay-Signature
string
required

Request signature. GatePay uses this signature to verify whether the request is valid.

Body

application/json
​
request_id
string
required

Unique request ID from caller.

​
customer_id
string
required

Customer ID on the platform side.

​
display_name
string
required

Display name of the sub-account.

​
account_holder
object
required
​
metadata
object

Additional key–value metadata.

Response

200 - application/json

Success

​
status
string
Example:

"SUCCESS"

​
code
string
Example:

"000000"

​
errorMessage
string
​
data
object