Accounts

Get multiple accounts

get
Authorizations
Query parameters
parentIdstringOptional

account id

limitstringOptional

Specifies the maximum number of items to return in a single request.

nextstringOptional

A cursor indicating the position of the last retrieved item.

Header parameters
x-api-keystringOptional
User-AgentstringOptional
Responses
200Success
application/json
get
GET /accounts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "data": [
    {
      "id": "text",
      "identityId": "text",
      "externalId": "text",
      "type": "text",
      "custody": "text",
      "balance": "text",
      "availableFunds": "text",
      "currency": "text",
      "name": "text",
      "accountNumber": "text",
      "accountHolder": "text",
      "status": "text",
      "parentId": "text",
      "subAccounts": {
        "balance": "text",
        "availableFunds": "text"
      },
      "custodyBankAccount": {
        "accountNumber": "text",
        "bank": "text",
        "currency": "text",
        "typeAccount": "text",
        "country": "text"
      }
    }
  ],
  "pagination": {
    "pagination": {
      "count": null,
      "next": null,
      "previous": null,
      "total": null
    },
    "results": [
      {}
    ]
  }
}

Create Account

post
Authorizations
Header parameters
x-api-keystringRequiredExample: {{x-api-key}}
User-AgentstringRequiredExample: ConomyApp/2.1.1
Body
objectOptional
Responses
201Success
application/json
post
POST /accounts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "identityId": "069b63ba-a8cd-4b0e-bb2f-ffc7d71f2dac",
  "externalId": "1",
  "type": "real",
  "currency": "PKR",
  "name": "Auto Loan Account",
  "parentId": "a3f87719-1dd7-46c7-9953-e0f3a71542a3"
}
{
  "id": "text",
  "identityId": "text",
  "externalId": "text",
  "type": "text",
  "custody": "text",
  "balance": "text",
  "availableFunds": "text",
  "currency": "text",
  "name": "text",
  "accountNumber": "text",
  "accountHolder": "text",
  "status": "text",
  "parentId": "text",
  "subAccounts": {
    "balance": "text",
    "availableFunds": "text"
  },
  "custodyBankAccount": {
    "accountNumber": "text",
    "bank": "text",
    "currency": "text",
    "typeAccount": "text",
    "country": "text"
  }
}

Delete Account

delete
Authorizations
Path parameters
idstringRequired
Header parameters
x-api-keystringRequiredExample: {{x-api-key}}
User-AgentstringRequiredExample: ConomyApp
Responses
204Success
application/json
Responseobject
delete
DELETE /accounts/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{}

Update Account

patch
Authorizations
Path parameters
idstringRequired
Header parameters
x-api-keystringRequiredExample: {{x-api-key}}
Body
objectOptional
Responses
200Success
application/json
patch
PATCH /accounts/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "BLOCKED"
}
{
  "id": "text",
  "identityId": "text",
  "externalId": "text",
  "type": "text",
  "custody": "text",
  "balance": "text",
  "availableFunds": "text",
  "currency": "text",
  "name": "text",
  "accountNumber": "text",
  "accountHolder": "text",
  "status": "text",
  "parentId": "text",
  "subAccounts": {
    "balance": "text",
    "availableFunds": "text"
  },
  "custodyBankAccount": {
    "accountNumber": "text",
    "bank": "text",
    "currency": "text",
    "typeAccount": "text",
    "country": "text"
  }
}
PreviousPaymentsNextPayment Methods