Get account statements

curl --request GET \
  --url https://{host}/bonus/v1/accounts/{externalId}/statements \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/bonus/v1/accounts/{externalId}/statements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/bonus/v1/accounts/{externalId}/statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/bonus/v1/accounts/{externalId}/statements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/bonus/v1/accounts/{externalId}/statements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": 123,
      "amount": 123,
      "type": "<string>",
      "typeDisplayName": "<string>",
      "state": "Waiting",
      "stateDisplayName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "nextCursor": 123
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

GET

accounts

{externalId}

statements

Get account statements

curl --request GET \
  --url https://{host}/bonus/v1/accounts/{externalId}/statements \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://{host}/bonus/v1/accounts/{externalId}/statements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/bonus/v1/accounts/{externalId}/statements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/bonus/v1/accounts/{externalId}/statements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/bonus/v1/accounts/{externalId}/statements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": 123,
      "amount": 123,
      "type": "<string>",
      "typeDisplayName": "<string>",
      "state": "Waiting",
      "stateDisplayName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "nextCursor": 123
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

externalId

string

required

Account externalId

Maximum string length: 60

Query Parameters

limit

integer<int32>

required

Items count to take

Required range: 1 <= x <= 2147483647

cursor

integer<int64>

Pointer to a specific item in the data set received from the previous request

Required range: 1 <= x <= 9223372036854776000

Response

items

object[]

required

Items

Show child attributes

nextCursor

integer<int64> | null

Should be passed as cursor in the subsequent request. If there is no value then there are no more items to be fetched

Last modified on August 10, 2026

⌘I