Account Api
This is account API page.
Create Account
REQUEST
POST /v1/account/create
Request Headers:
name value required desc Content-Type application/json YES Authorization your access_token YES Request Parameters:
name type required description uid string Y User id currency string Y currency code, ISO 4217 standard. type enum Y debit , securities, crypto sub_type string Y bsb, bic_swift, us_stock status enum Y active , frozen , deleted , pending , closed
RESPONSE
Response body schema: application/json
Response body parameters:
name type required description code integer Y msg string Y data object Y |─id string Y Account id Response body sample:
{ "code": 0, "msg": "", "data": { "id": "1605823332533407744" } }
Get Account
REQUEST
GET /v1/account/{account_id}
Request Headers:
name value required desc Content-Type application/json YES Authorization your access_token YES Request path Parameters:
name type required description account_id string Y Account id
Responses
Response body schema: application/json
Response body parameters:
name type required description code integer Y msg string Y data object Y |─id string Y Account id |─uid string Y User id |─contact_id string Y Contact id |─currency string Y Currency |─type enum Y debit , securities , crypto |─sub_type enum Y bsb , bic_swift , us_stock |─status enum Y active , frozen , deleted , pending , closed |─funding_accounts object N |─key string Account routing type: bic_swift, bsb, ach, wire |─funding_account_id string Funding account id |─routing_type string Routing type |─routing_value string Routing value |─account_name string Account name |─account_no string Account number |─currency string Currency |─iban string IBAN |─bank_name string Bank name |─bank_address string Bank address |─bank_country string Bank country |─updated_at integer Update stamp |─created_at integer Create stamp Response body sample:
{ "code": 0, "msg": "string", "data": { "uid": "string", "status": "string", "currency": "string", "id": "string", "type": "string", "contact_id": "string", "sub_type": "string", "create_at": 0, "update_at": 0, "funding_accounts": { "bic_swift": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "iban": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" }, "bsb": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "currency": "string", "account_no": "string" }, "ach": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "account_no": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" }, "fedwire": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "account_no": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" }, "sepa": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "account_no": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" } } } }
User Account list
REQUEST
GET /v1/accounts/{uid}
Request Headers:
name value required desc Content-Type application/json YES Authorization your access_token YES request path Parameters:
name type required description uid string Y User id
RESPONSE
Response body schema: application/json
Response body parameters:
name type required description code integer Y msg string Y data array Y |─id string Y Account id |─uid string Y User id |─contact_id string Y Contact id |─currency string Y Currency |─type string Y debit , securities , crypto |─sub_type string Y bsb , bic_swift , us_stock |─status string Y active , frozen , deleted , pending , closed |─funding_accounts array N |─funding_account_id string Funding account id |─routing_type string Routing type |─routing_value string Routing value |─account_name string Account name |─account_no string Account number |─currency string Currency |─iban string IBAN |─bank_name string Bank name |─bank_address string Bank address |─bank_country string Bank country |─updated_at integer Update stamp |─created_at integer Create stamp Response body sample:
{ "code": 0, "msg": "string", "data": [ { "uid": "string", "status": "string", "currency": "string", "id": "string", "type": "string", "contact_id": "string", "sub_type": "string", "funding_accounts": { "bic_swift": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "iban": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" }, "bsb": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "currency": "string", "account_no": "string" }, "ach": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "account_no": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" }, "fedwire": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "account_no": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" }, "sepa": { "funding_account_id": "string", "routing_value": "string", "routing_type": "string", "account_name": "string", "account_no": "string", "bank_name": "string", "bank_address": "string", "currency": "string", "bank_country": "string" } } } ] }
Close Account
REQUEST
POST /v1/account/close/{account_id}
Request path parameters:**
name type required description account_id string Y Account id
RESPONSE
Response body schema: application/json
Response body:
name type required description code integer Y msg string Y Response body sample:
{ "code": 0, "msg": "ok" }