JouloDocs

List your accounts

Lists the accounts you created through this API, newest first, with the signatory and the registration and mandate state of each connection. Filter on cpo_external_ref to poll one account.

GET
/v1/accounts
AuthorizationBearer <token>

OAuth 2.0 client credentials for a CPO client bound to one partner. Request a token with grant_type client_credentials and send client_id and client_secret in the body, as JSON or form data. The token endpoint does not accept HTTP Basic client authentication. The token lasts one hour and has no refresh token. Omit scope to get every scope your client holds. The /v1 routes refuse user tokens and personal API tokens.

In: header

Scope: cpo:accounts:read

Query Parameters

limit?integer

Page size. A value above 200 becomes 200, and a negative value becomes 1. A missing, zero or non-numeric value uses 50.

Default50
Range1 <= value <= 200
offset?integer

Number of accounts to skip, newest first. A negative or non-numeric value uses 0.

Default0
Range0 <= value
cpo_external_ref?string

Your own customer number, as sent on POST /v1/accounts. Returns only the account with this value. The server trims it and keeps the first 120 characters.

Response Body

curl -X GET "https://api.joulo.nl/functions/v1/api/v1/accounts?limit=50&offset=0&cpo_external_ref=string"
{
  "accounts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "particulier",
      "display_name": null,
      "payout_handler": "joulo_pays_customer",
      "cpo_external_ref": null,
      "access_channel": "cpo_api",
      "created_at": "2019-08-24T14:15:22Z",
      "signatory": {
        "full_name": "string",
        "email": null
      },
      "connections": [
        {
          "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
          "ean_code": "string",
          "status": "active",
          "registration_status": "string",
          "ean_validation_status": null,
          "mandate_status": "pending",
          "mandate_valid_from": null
        }
      ]
    }
  ],
  "limit": 0,
  "offset": 0,
  "count": 0
}
{
  "error": "Missing or invalid API token"
}
{
  "error": "Insufficient scope",
  "detail": "string",
  "required_scope": "string"
}
{
  "error": "Too many requests",
  "retry_after_seconds": 0
}
{
  "error": "list_failed",
  "detail": "string"
}
{
  "error": "string"
}