Skip to main content
GET
Afriex SDK
Returns a short-lived (5 minute) presigned download URL for the settlement & remittance advice PDF that Afriex auto-generates for a USD withdrawal from your Collection wallet, i.e. a WITHDRAW created with meta.settlement: "request".
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. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a 403 Forbidden response; an unrecognised, malformed or revoked key returns 401 Unauthorized. Manage your keys and their permissions under Developer → API keys in the dashboard.

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 (e.g. 2025-12-28). Defaults to latest stable.

Path Parameters

transactionId
string
required

The unique identifier of the transaction

Response

Settlement advice download URL retrieved successfully.

data
object