List payments - Equals Documentation

GET

roqqett

payments

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/payments?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

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

fetch('https://api.equalsmoney.com/v2/roqqett/payments', 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://api.equalsmoney.com/v2/roqqett/payments",
  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://api.equalsmoney.com/v2/roqqett/payments"

	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://api.equalsmoney.com/v2/roqqett/payments")

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

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
      "type": "PAYMENT",
      "status": "COMPLETED",
      "amount": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      },
      "checkoutType": "SHOPPING",
      "checkoutSessionId": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
      "refundedPaymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
      "refundId": "4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45",
      "orderId": "7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78",
      "merchantReference": "ORDER-10421",
      "payer": {
        "bankName": "Example Bank"
      },
      "isRefundable": true,
      "initiatedAt": "2026-10-02T12:00:00Z",
      "completedAt": "2026-10-02T12:00:05Z",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

Authorizations

Authorization

string

header

required

Query Parameters

limit

integer

default:100

The maximum number of results to return.

Required range: 1 <= x <= 1000

Example:

200

offset

integer

default:0

The number of items to skip before returning results.

Required range: x >= 0

Example:

100

accountId

string

required

The ID of the account to work with.

Example:

"F50091"

startDate

string

Only records created on or after this date.

Example:

"2026-09-01"

endDate

string

Only records created on or before this date.

Example:

"2026-09-30"

type

enum<string>

PAYMENT moves money from the payer; REFUND moves it back.

Available options:

PAYMENT,

REFUND

Example:

"PAYMENT"

checkoutType

enum<string>

SHOPPING pays for a basket into the merchant's settlement account. TOP_UP pays into a payee the merchant supplies.

Available options:

SHOPPING,

TOP_UP

Example:

"SHOPPING"

status

enum<string>

PENDING from initiation until the bank confirms the outcome.

Available options:

PENDING,

COMPLETED,

FAILED,

CANCELLED

Example:

"COMPLETED"

checkoutSessionId

string<uuid>

The ID of a checkout session: one payment journey.

Maximum string length: 36

Example:

"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"

merchantReference

string

The merchant's own reference for this checkout session, such as its order or basket ID. Shown to the merchant, never to the payer's bank.

Required string length: 1 - 128

Example:

"ORDER-10421"

refundedPaymentId

string<uuid>

Only the refunds of this payment.

Maximum string length: 36

Example:

"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"

sort

enum<string>

default:desc

Order by createdAt: desc is newest first.

Available options:

asc,

desc

Response

count

integer

required

The total amount of records matching the querying when "limit" is ignored.

Example:

67

rows

object[]

required

Show child attributes

limit

integer

default:100

The maximum number of results to return.

Required range: 1 <= x <= 1000

Example:

200

offset

integer

default:0

The number of items to skip before returning results.

Required range: x >= 0

Example:

100

⌘I

cURL

curl --request GET \
  --url 'https://api.equalsmoney.com/v2/roqqett/payments?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'

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

fetch('https://api.equalsmoney.com/v2/roqqett/payments', 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://api.equalsmoney.com/v2/roqqett/payments",
  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://api.equalsmoney.com/v2/roqqett/payments"

	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://api.equalsmoney.com/v2/roqqett/payments")

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

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
      "type": "PAYMENT",
      "status": "COMPLETED",
      "amount": {
        "amount": "10000.00",
        "currencyCode": "GBP"
      },
      "checkoutType": "SHOPPING",
      "checkoutSessionId": "0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93",
      "refundedPaymentId": "9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34",
      "refundId": "4a7d2c9e-1b5f-4e3a-9c8d-6b0f1e2a7c45",
      "orderId": "7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78",
      "merchantReference": "ORDER-10421",
      "payer": {
        "bankName": "Example Bank"
      },
      "isRefundable": true,
      "initiatedAt": "2026-10-02T12:00:00Z",
      "completedAt": "2026-10-02T12:00:05Z",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}

{
  "message": "Checkout session not found.",
  "errors": [
    {
      "path": "string",
      "message": "string",
      "errorCode": "string"
    }
  ]
}