---
title: "Get settlement & remittance advice"
method: GET
path: "/api/v1/transaction/{transactionId}/advice"
tags: ["Transactions"]
---

# Get settlement & remittance advice

`GET /api/v1/transaction/{transactionId}/advice`

## Request

- Base URL: `https://sandbox.api.afriex.com`
- URL: `https://sandbox.api.afriex.com/api/v1/transaction/{transactionId}/advice`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/transaction/:transactionId/advice/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a short-lived presigned download URL for the settlement & remittance advice PDF auto-generated for a USD withdrawal from your collection wallet (a withdrawal created with `settlement: "request"`). The advice is issued with status `PENDING` when the withdrawal is created and regenerated with status `COMPLETED` (same reference, incremented version) once the withdrawal succeeds. Scoped to your business: you can only fetch advices for your own transactions. This document is a settlement and remittance advice, not a tax invoice.

## Path parameters

- `transactionId` string, required

## Response `200`

Settlement advice download URL retrieved successfully.

- object
  - `data` object
    - `url` string: Short-lived (5 minute) presigned S3 URL for the advice PDF.
    - `reference` string: Stable advice reference number. Generated once per transaction and reused across regenerations.
    - `status` 'PENDING' | 'COMPLETED': PENDING until the withdrawal succeeds, COMPLETED afterwards.
    - `version` integer: Regeneration counter. Starts at 1 at creation and increments when the advice is regenerated on completion.
    - `generatedAt` string, date-time

## Other responses

- `400`: Invalid transaction ID format.
- `401`: Unauthorized.
- `404`: Transaction not found, or no settlement advice exists for this transaction (only USD withdrawals from the collection wallet qualify).
- `500`: Server error.
- `503`: Temporarily unavailable: an upstream service failed or timed out, or the API is momentarily offline. Retry with backoff and honour the Retry-After header when present.

---

[API](https://skmtc.dev/afriex/apis/afriex-business-api.md) - [All operations](https://skmtc.dev/afriex/apis/afriex-business-api/llms.txt) - [OpenAPI document](https://skmtc.dev/afriex/apis/afriex-business-api/revisions/d94198b6c256?raw)