conomy_hq
  1. Accounts
conomy_hq
  • Quickstart
    • Introduction
    • Obtain an Access Token
    • Create an Organization
    • Create users
    • Create accounts
    • Create your first top-up
    • Create your first withdrawal
    • Create your first purchase
    • Create your first p2p payment
    • Create your first collect payment
    • Supported Identity Document Types
  • Payments
    • Transaction types
    • Transaction status
    • Origins and Destinations
    • Creating a payment
    • Add & remove Fees
  • API reference
    • Auth
      • Auth
    • Identities
      • Create Identity
      • Get Identity
      • Update Identity
      • Delete Identity
      • Get Identities List
      • Add Child to Identity Children
      • Remove Child from Children
      • Add Rule to Identity
      • Remove Rule to Identity
    • Accounts
      • Create Account
        POST
      • Get Account
        GET
      • Update Account
        PATCH
      • Delete Account
        DELETE
      • Get multiple accounts
        GET
    • Payment-methods
      • Get payment-origins
      • Get payment-destinations
    • Payment-attempts
      • Create Attempt
      • Get payment-attempts list
      • Get payment-attempt
    • Payments
      • Create Payment
      • Authorize Payment
      • Capture Payment
      • Get Payment List
      • Get Payment List paginated
      • Get Payment
      • Receive Payment Provider Notification
      • Client Transaction's Notification Webhook
  1. Accounts

Create Account

POST
/accounts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/accounts' \
--header 'x-api-key: {{x-api-key}}' \
--header 'User-Agent: ConomyApp/2.1.1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identityId": "069b63ba-a8cd-4b0e-bb2f-ffc7d71f2dac",
    "externalId": "1",
    "type": "real",
    "currency": "PKR",
    "name": "Auto Loan Account",
    "parentId": "a3f87719-1dd7-46c7-9953-e0f3a71542a3"
}'
Response Response Example
201 - Example 1
{
  "id": "string",
  "identityId": "string",
  "externalId": "string",
  "type": "string",
  "custody": "string",
  "balance": "string",
  "availableFunds": "string",
  "currency": "string",
  "name": "string",
  "accountNumber": "string",
  "accountHolder": "string",
  "status": "string",
  "parentId": "string",
  "subAccounts": {
    "balance": "string",
    "availableFunds": "string"
  },
  "custodyBankAccount": {
    "accountNumber": "string",
    "bank": "string",
    "currency": "string",
    "typeAccount": "string",
    "country": "string"
  }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}
User-Agent
string 
required
Example:
ConomyApp/2.1.1
Body Params application/json
identityId
string 
required
Identifier linking the internal account to an organization or user.
externalId
string 
optional
External reference identifier for integrations.
type
string 
required
The type of internal account (e.g., CHECKING, ASSET, SAVINGS).
custody
string 
required
Indicates the custody provider managing the internal account.
currency
string 
required
The currency in which the internal account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
name
string 
required
A friendly name assigned to the internal account.
parentId
string 
optional
Identifier of the parent account if this is a sub-account.
custodyBankAccount
object 
optional
Details of the custody bank account linked to this internal account.
accountNumber
string 
required
The bank account number.
bank
string 
required
The name of the bank where the account is held.
currency
string 
required
The currency in which the account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
typeAccount
string 
optional
The type of bank account. CHECKING_ACOUNT, SAVINGS, ASSET
country
string 
optional
The country where the bank account is registered. CHL, PER, COL, ARG, MEX, USA, CAD
Examples

Responses

🟢201Created
application/json
Body
Schema representing an internal account used for handling financial operations within the system.
id
string 
required
Unique identifier for the internal account.
identityId
string 
required
Identifier linking the internal account to an organization or user.
externalId
string 
required
External reference identifier for integrations.
type
string 
required
The type of internal account (e.g., CHECKING, ASSET, SAVINGS).
custody
string 
required
Indicates the custody provider managing the internal account.
balance
string 
required
Total balance available in the internal account.
Match pattern:
^\d+(\.\d+)?$
availableFunds
string 
required
Amount of funds available for transactions.
Match pattern:
^\d+(\.\d+)?$
currency
string 
required
The currency in which the internal account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
name
string 
required
A friendly name assigned to the internal account.
accountNumber
string 
required
Internal reference number for the account.
accountHolder
string 
required
Name of the entity or user owning the internal account.
status
string 
required
The current status of the account (e.g., PENDING, ACTIVE, BLOCKED).
parentId
string 
required
Identifier of the parent account if this is a sub-account.
subAccounts
object 
optional
Details of sub-accounts associated with this internal account.
balance
string 
required
Total balance of the sub-account.
Match pattern:
^\d+(\.\d+)?$
availableFunds
string 
required
Funds available for use within the sub-account.
Match pattern:
^\d+(\.\d+)?$
custodyBankAccount
object 
optional
Details of the custody bank account linked to this internal account.
accountNumber
string 
required
The bank account number.
bank
string 
required
The name of the bank where the account is held.
currency
string 
required
The currency in which the account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
typeAccount
string 
optional
The type of bank account. CHECKING_ACOUNT, SAVINGS, ASSET
country
string 
optional
The country where the bank account is registered. CHL, PER, COL, ARG, MEX, USA, CAD
🟠400Bad request
🔴500Internal server error
Modified at 2025-01-31 18:03:59
Previous
Remove Rule to Identity
Next
Get Account
Built with