Skip to main content
GET
List Addresses
Auth method: Signed (HMAC) — this endpoint requires the full set of signed headers: x-access-id, x-request-id, x-timestamp, and an HMAC-SHA256 authorization signature. See Authentication.
Returns the addresses in one of your wallets, most recently updated first. data is a plain array; this endpoint returns no pagination metadata. To read every address, request the next page until you get fewer than limit items.

Example

Headers

string
required
Base64-encoded HMAC-SHA256 signature of {"timeStamp":"<x-timestamp>","requestId":"<x-request-id>","accessId":"<x-access-id>"}, signed with your access secret. The request body is not part of the signature.Example: "pV3n0o8kq0lK2mJ8bZ1yq3Yt6hR0cXK9u4mVJ2l9sE0="
string
required
ISO 8601 timestamp; must be within 5 minutes of server timeExample: "2026-10-15T09:45:53.000Z"
string
required
A unique UUID v4 per requestExample: "550e8400-e29b-41d4-a716-446655440000"
string
required
Your API access IDExample: "your-access-id-here"

Path Parameters

string
required
The wallet’s reference.Example: "acme-user-8821"

Query Parameters

integer
Page number, starting at 1. Defaults to 1.Example: 1
integer
Addresses per page, from 1 to 100. Defaults to 20.Example: 20

Response

string
required
Example: "success"
string
required
Example: "success"
array
required
The wallet’s addresses. An unknown wallet reference, or one that belongs to another merchant, returns an empty array.

Authorizations

authorization
string
header
required

Signed (HMAC) authentication. Required headers: x-access-id, x-request-id (UUID v4), x-timestamp (ISO 8601, must be within 5 minutes of server time), and authorization: the Base64 HMAC-SHA256 of the JSON string {"timeStamp":"","requestId":"","accessId":""} (keys in that order, no whitespace) using your access secret. The request body, method and path are not signed. The API key must be linked to an outlet.

Headers

authorization
string
required

Base64-encoded HMAC-SHA256 signature of {"timeStamp":"","requestId":"","accessId":""}, signed with your access secret. The request body is not part of the signature.

x-timestamp
string<date-time>
required

ISO 8601 timestamp; must be within 5 minutes of server time

x-request-id
string<uuid>
required

A unique UUID v4 per request

x-access-id
string
required

Path Parameters

walletReference
string
required

The wallet's reference.

Query Parameters

page
integer
default:1

Page number, starting at 1. Defaults to 1.

Required range: x >= 1
limit
integer
default:20

Items per page, 1-100. Defaults to 20.

Required range: 1 <= x <= 100

Response

Addresses

status
string
required
Example:

"success"

message
string
required
Example:

"success"

data
object[]
required

Plain array; no pagination metadata.