Skip to main content

Search Client Accounts

This endpoint allows a user to search for Client Accounts.

Search Payloads and Paginated Lists

Search endpoints are not self-explanatory. Before using this endpoint please read-up on search payloads and response pagination lists in Making a Request.

Request​

URL​

/client-accounts/search

Best practice is to always include the pagination query string.

Method​

POST

Headers​

Content-Type: application/json
Authorization: Bearer eyy...

Body​

The search payload.

queryTarget and basic search fields are:

  • id
  • clientId
  • type
  • productCode
  • currency
  • lastTransactionDate

Response​

  • Status code 200
  • Body a list of results (paginated) of client_account objects
  • Headers pagination headers, including link to next page
Response Body

The response is a list of client_account objects. The client account object has the below data.

{
  "id": {
    "type": "String",
    "description": null
  },
  "clientId": {
    "type": "String",
    "description": null
  },
  "clientName": {
    "type": "String",
    "description": null
  },
  "type": {
    "type": "String",
    "description": null
  },
  "productCode": {
    "type": "String",
    "description": null
  },
"currency": {
     "type": "ChoiceString",
     "description": null,
     "choice_list": [
       "SEK",
       "EUR",
       "USD",
       "NOK",
       "DKK"
     ]
   },
  "balance": {
    "type": "Float",
    "description": null
  },
  "balanceLocale": {
    "type": "Float",
    "description": null
  },
  "reservedAmount": {
    "type": "Float",
    "description": null
  },
  "disposablePayoutAmount": {
    "type": "Float",
    "description": null
  },
  "disposablePayoutAmountLocale": {
    "type": "Float",
    "description": null
  },
  "pendingTriggeredPayout": {
    "type": "Boolean",
    "description": null
  },
  "lastTransactionDate": {
    "type": "Date",
    "description": null
  },
  "paymentReference": {
    "type": "String",
    "description": null
  }
}