Skip to main content
GET
/
v1
/
reports
/
settlement
/
{id}
curl
curl -X GET "https://api.services.payward.com/v1/reports/settlement/00000000-0000-0000-0000-000000000001" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000001",
    "date": "2026-04-25",
    "type": "swaps",
    "size": "18342",
    "name": "settlement-2026-04-25.csv",
    "download_url": "https://reports.payward.com/dl/settlement-2026-04-25.csv",
    "expires_at": "2026-04-26T18:24:11Z"
  }
}

Authorizations

​
API-Key
string
header
required

Your public API key. Identifies the partner making the request.

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Path Parameters

​
id
string<uuid>
required

The unique identifier of the settlement report to retrieve.

Response

Successful response containing the settlement report details and secure download URL.

​
data
object
required