Sign in

v2

latestOpenAPI 3.1.02026-07-267085761.0 MB
Platform Accounts

List Paywint Bank Transactions

Retrieves a paginated list of Paywint bank transactions for a specific user.

This endpoint allows platforms to:

  • View transaction history associated with a user’s Paywint bank account
  • Filter and paginate transactions by account and user
  • Access transaction details such as amount, type, and date

When this endpoint is called for the first time, the system automatically initiates a background sync to fetch the latest Paywint transactions. During this initial sync (which may take up to one minute), the response will contain only previously available transactions.

To view newly synced transactions, call this endpoint again after one minute.

Returns the total number of transactions and a list of transaction records.

post/api/platform/accounts/list-pw-transactions/{user_id}

Path parameters

user_idstring uuid required

Unique identifier (UUID) of the user

Unique identifier (UUID) of the user

Headers

X-Platform-IDstring uuid required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signaturestring required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Request body

rows_per_page10 | 20 | 50 | 100 required
page_nointeger required

Page number to retrieve, starting from 1. For example, page_no=1 returns the first page of results.

account_idstring uuid required

Unique identifier (UUID) of the user's Paywint bank account for which transactions are being retrieved.

Example request

{
  "page_no": 1,
  "account_id": "f47ac10b-****-****-****-0e02b2c3d479"
}

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

status_codeinteger nullable

HTTP status code representing the result of the request.

messagestring nullable

Short, human-readable message describing the outcome of the request.

totalRecordsinteger nullable

Total number of matching records in the database, useful for paginating the full dataset.

queryGeneratedTimeinteger nullable

Unix timestamp (in seconds) indicating when this response was generated.

Example response

{
  "success": true,
  "records": [
    {
      "transaction_id": "cb4cbbdf-a2bd-4c41-98f0-7da1d8657898",
      "amount": 100,
      "transaction_date": "2025-10-06",
      "description": "Invoice #1234 payment",
      "payer_payee": "Robert",
      "is_internal_payment": true
    }
  ]
}