Skip to main content
GET
Get settlement & remittance advice
The download URL is valid for 5 minutes.
Advices are only generated for USD withdrawals with meta.settlement: "request". Requesting an advice for any other transaction returns 404.

Lifecycle

The advice is issued twice for the same transaction:
1

On creation (PENDING)

When the withdrawal is created, an advice is generated with status: "PENDING" and version: 1.
2

On completion (COMPLETED)

Once the withdrawal succeeds, the advice is regenerated as status: "COMPLETED" with an incremented version. The reference stays the same across regenerations.

The document

This is a settlement and remittance advice, not a tax invoice. Use it to reconcile the settlement leg of a collection-wallet USD withdrawal.

Scope and access

Advices are scoped to your business: you can only fetch advices for transactions you created. The download url is a presigned S3 URL valid for 5 minutes. Fetch a fresh URL by calling this endpoint again when the current one expires.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

Headers

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

Path Parameters

transactionId
string
required

The unique identifier of the transaction

Response

Settlement advice download URL retrieved successfully.

data
object