Customer account creation

The customer account creation comprises of two API calls. One API endpoint creates a customer bank account using a minimum data needed. The second API call creates a KYC applicant and extends the amount of personal data stored for the customer. Use the following API requests.

These APIs are required to be used only once. No need to trigger them before each withdrawal request creation.

Create a customer bank account

Creates a bank transfer user profile.

post

Creates a bank transfer user profile for a specified customer.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

Authorizations

api_key

x-api-keystringRequired

Path parameters

idstringRequired

• The external identifier for the customer.

Body

application/json

• Request body containing user details.

currencystring · enumOptionalPossible values:

acceptedTermsOfServiceHashstringOptional

acceptedTermsAndConditionsHashstringOptional

acceptedPrivacyPolicyHashstringOptional

emailstringOptional

countrystringOptional

lastNamestringOptional

firstNamestringOptional

Responses

201

User successfully created

application/json

400

Bad request

application/json

401

Unauthorized

application/json

409

Conflict

application/json

422

Unprocessable content

application/json

500

Internal server error

application/json

post

/customer/{id}/bank-transfer/user

HTTPcURLJavaScriptPython

POST /api/v2/customer/{id}/bank-transfer/user HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "country": "GB",
  "currency": "EUR",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe"
}

Example 1Example 2

{
  "data": "User successfully created",
  "success": true
}

Create a KYC applicant

The response time for this API is 15 seconds in average.

Submits KYC applicant information for a customer to the KYC provider.

post

Submits KYC applicant information for a customer to the KYC provider.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

Authorizations

api_key

x-api-keystringRequired

Path parameters

idstringRequired

• Unique identifier of the customer.

Body

application/json

anyOptional

• The request body containing applicant information.

Responses

201

KYC applicant was created successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

422

Unprocessable content

application/json

500

Internal server error

application/json

post

/customer/{id}/bank-transfer/kyc/applicant

HTTPcURLJavaScriptPython

POST /api/v2/customer/{id}/bank-transfer/kyc/applicant HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "address1": "45 Pitt Street",
  "address2": "Level 2, Suite 3",
  "postCode": "2000",
  "city": "Sydney",
  "country": "AU",
  "dateOfBirth": "1990-12-25",
  "sourceOfFunds": "SALARY"
}

{
  "data": "KYC applicant was created successfully",
  "success": true
}