Aquanow CAMS v1.0 (Updated)
  • Welcome
  • Security
    • OAuth2.0
    • API Limits
  • Pagination
  • Webhooks
    • Onboarding
    • Settlements
    • Reports
    • Order
    • Execution
    • Document
  • Market Data
    • Websocket
    • Rest API
      • OHLC
  • API reference
    • Customers
      • Docs
      • Configuration
    • Trades
      • RFQ
    • Orders
    • Executions
    • Settlements
    • Transactions
    • Accounts
      • Credit
      • Balances
      • Configuration
      • Performance
    • Instruments
      • Pairs
      • Assets
    • Custody
      • Balances
      • Allocation
    • Files
    • Webhook
  • Change Log
  • Specification
  • User Guide
    • View Customers
      • Customer Onboarding
      • Upload Onboarding Docs
      • View Customer Account Balances
      • Customer Risk Groups
    • View Customer Trade Activity
    • Manage Team Members
Powered by GitBook
On this page
  1. API reference
  2. Accounts

Credit

PreviousAccountsNextBalances

Last updated 7 months ago

  • GETReturns the credit limit history of an account
  • PUTSet the credit limit of an account
  • PATCHIncrease or Decrease Credit Limit

Returns the credit limit history of an account

get

Returns the credit limit history of an account filtered by a date range

Authorizations
Path parameters
accountIdstring · uuidRequired

The account ID

Query parameters
startDatestring · dateRequired

The first date to include in the credit limit history

Example: 2024-02-01
endDatestring · dateRequired

The last date to include in the credit limit history

Example: 2024-05-01
afterstringOptional

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integerOptional

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

Responses
200
Successful response
application/json
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
4XX
Client error
5XX
Server error
get
GET /api/v1/accounts/{accountId}/credit-limit/history HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "creditLimitRequested": "10000.00",
      "newCreditLimit": "10000.00",
      "action": "INCREASE",
      "updatedAt": "2024-08-01T18:44:05Z"
    }
  ]
}

Set the credit limit of an account

put

Set the credit limit of an account to the amount specified

Authorizations
Path parameters
accountIdstring · uuidRequired

The account ID

Body
amountstring · numberRequiredExample: 10000
Responses
200
Successful response
application/json
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
4XX
Client error
5XX
Server error
put
PUT /api/v1/accounts/{accountId}/credit-limit HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "amount": "10000"
}
{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "newCreditLimit": "10000"
}

Increase or Decrease Credit Limit

patch

Applies an incremental change to the credit limit of an account

Authorizations
Path parameters
accountIdstring · uuidRequired

The account ID

Body
amountstring · numberOptional

The amount to increase or decrease the credit limit by

Example: 10000
actionstring · enumOptional

The action to either increase or decrease the credit limit by the amount provided.

Example: INCREASEPossible values:
Responses
200
Successful response
application/json
400
Validation Error
401
Unauthorized
403
Insufficient Privileges
4XX
Client error
5XX
Server error
patch
PATCH /api/v1/accounts/{accountId}/credit-limit HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "increaseAmount": "10000"
}
{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "newCreditLimit": "20000"
}