List Statements

List statements based on the provided filters

GET /statements

Try it

List Statements

cURL

curl --request GET \
  --url https://api.paxos.com/v2/statements \
  --header 'Authorization: Bearer <token>'

200

{
  "statements": [
    {
      "id": "704b4e48-bbb1-4086-b6e4-6e9b2e3e5d7a",
      "ref_id": "USDG_REWARDS-cdcbff8e-cf51-4536-ba6f-92ef6846e48a-2025-02",
      "customer_id": "cdcbff8e-cf51-4536-ba6f-92ef6846e48a",
      "type": "STATEMENT_TYPE_USDG_REWARD",
      "product": "USDG_REWARDS",
      "status": "STATEMENT_STATUS_PAID",
      "metadata": {
        "total_amount": "100.5"
      },
      "statement_balances": [
        {
          "asset": "USDG",
          "amount_paid": "100.5",
          "total_amount_owed": "100.5"
        }
      ],
      "period_start": "2025-02-01T00:00:00Z",
      "period_end": "2025-02-28T23:59:59.999999Z",
      "generated_at": "2025-03-18T23:11:47.840321Z",
      "paid_at": "2025-03-19T19:21:57.172302Z",
      "created_at": "2025-03-18T23:11:47.627302Z"
    },
    {
      "id": "30ed2047-6155-4b75-b235-6600aa7f65dd",
      "ref_id": "USDG_REWARDS-cdcbff8e-cf51-4536-ba6f-92ef6846e48a-2025-03",
      "customer_id": "cdcbff8e-cf51-4536-ba6f-92ef6846e48a",
      "type": "STATEMENT_TYPE_USDG_REWARD",
      "product": "USDG_REWARDS",
      "status": "STATEMENT_STATUS_PAID",
      "metadata": {
        "total_amount": "100.5"
      },
      "statement_balances": [
        {
          "asset": "USDG",
          "amount_paid": "100.5",
          "total_amount_owed": "100.5"
        }
      ],
      "period_start": "2025-02-18T00:00:00Z",
      "period_end": "2025-03-18T00:00:00Z",
      "generated_at": "2025-03-18T19:11:54.606991Z",
      "paid_at": "2025-03-20T14:26:06.649645Z",
      "created_at": "2025-03-18T19:11:54.372336Z"
    }
  ]
}

OAuth Scope

statements:read_statement

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Query Parameters

customer_id · string

customer_id is a required field.

ref_ids · string[]

Optionally filter by the ref_ids of the statements.

statement_ids · string[]

Optionally filter by the ids of the statements.

statuses · enum<string>[]

Optionally filter by the statuses of the statements to be returned. Defaults to all statuses.

Available options: STATEMENT_STATUS_UNSPECIFIED, STATEMENT_STATUS_INITIATED, STATEMENT_STATUS_GENERATED, STATEMENT_STATUS_PAID

limit · integer<int32>

Number of results to return. Defaults to 100.

order · enum<string>

Sort order for the results by period start, defaults to DESC if not provided.

Available options: DESC, ASC

page_cursor · string

Cursor for getting the next page of results.

Response

200 - application/json

Successfully retrieve statements

statements · object[]

Show child attributes

statements. id · string

Unique statement ID.

statements. ref_id · string

Must be unique per customer.

statements. customer_id · string

UUID of the associated customer.

statements. type · enum<string>

Available options: STATEMENT_TYPE_UNSPECIFIED, STATEMENT_TYPE_USDG_REWARD

statements. product · enum<string>

Available options: USDG_REWARDS

statements. status · enum<string>

Available options: STATEMENT_STATUS_UNSPECIFIED, STATEMENT_STATUS_INITIATED, STATEMENT_STATUS_GENERATED, STATEMENT_STATUS_PAID

statements. metadata · object

Custom fields (e.g., total_amount).

Show child attributes

statements.metadata. {key} · string

statements. statement_balances · object[]

Breakdown of owed vs. paid balances.

Show child attributes

statements.statement_balances. asset · string

statements.statement_balances. amount_paid · string

statements.statement_balances. total_amount_owed · string

statements.statement_balances. next_payment_ref_id · string

next_payment_ref_id should be used by clients as the ref_id when processing payments for statements. This is unique to for each payment that should be submitted. If the amount_paid == total_amount_owed, then this field will be empty.

statements. period_start · string<date-time>

The time range this statement covers.

statements. period_end · string<date-time>

The time range this statement covers.

statements. generated_at · string<date-time>

Lifecycle tracking fields.

statements. paid_at · string<date-time>

Lifecycle tracking fields.

statements. created_at · string<date-time>

Lifecycle tracking fields.

statements. statement_group_id · string

statement_group_id is used to group multiple statements together. Multiple versions of a statement may belong to a single statement group.

statements. version · integer<int64>

Version number of the statement.

statements. files · Generated files for the statement · object[]

Show child attributes

statements.files. format · string

statements.files. url · string

statements.files. expires_at · string<date-time>

statements.files. generated_at · string<date-time>

statements. data · object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Show child attributes

statements.data. @type · string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

statements.data. {key} · any

next_page_cursor · string