Payments

List Payments

Filter payments using the supported query parameters.

get/v1/aggregators/{raast-aggregator-id}/payments

Request

Base URL: https://api.getsafepay.com/raastwire
URL: https://api.getsafepay.com/raastwire/v1/aggregators/{raast-aggregator-id}/payments
Auth: API key in header X-SFPY-AGGREGATOR-SECRET-KEY

Query parameters

limitstring

Maximum number of payments to return in the result set.

offsetstring

Number of payments to skip before starting the result set.

aggregator_merchant_idstring

Filter by Safepay aggregator merchant identifier.

order_idstring

Filter by the merchant supplied order identifier.

request_idstring

Filter by the client generated idempotent request identifier.

trace_referencestring

Filter by the trace reference assigned during processing.

msg_idstring

Filter by the Raast network message identifier.

pmt_inf_idstring

Filter by the payment information identifier from the Raast message.

uetrstring

Filter by the Unique End-to-end Transaction Reference (UETR).

Filter by the payment status.

type'RTP_NOW' | 'RTP_LATER' | 'STATIC_QR' | 'DYNAMIC_QR'

Filter by the payment type.

payment_idstring

Filter by the payment identifier.

qr_code_idstring

Filter by the QR code identifier associated with the payment.

end_to_end_idstring

Filter by the end-to-end identifier recorded for the payment.

instr_idstring

Filter by the instruction identifier from the Raast message payload.

start_dateinteger

Filter payments created on or after this date (UNIX timestamp).

end_dateinteger

Filter payments created on or before this date (UNIX timestamp).

Response

Paginated list of payments linked to a merchant

api_versionstring

The current version of the API spec

Example response

{
  "api_version": "v1",
  "data": {
    "count": "605",
    "payments": [
      {
        "expires_at": "2025-03-13T09:12:34Z",
        "created_at": "2025-03-13T09:12:34Z",
        "updated_at": "2025-03-13T09:12:34Z",
        "payment_parties": [
          {
            "bank_account": {
              "created_at": "2025-03-13T09:12:34Z",
              "updated_at": "2025-03-13T09:12:34Z"
            },
            "created_at": "2025-03-13T09:12:34Z",
            "updated_at": "2025-03-13T09:12:34Z"
          }
        ],
        "aggregator_merchant": {
          "bank_account": {
            "created_at": "2025-03-13T09:12:34Z",
            "updated_at": "2025-03-13T09:12:34Z"
          },
          "raast_merchant": {
            "created_at": "2025-03-13T09:12:34Z",
            "updated_at": "2025-03-13T09:12:34Z"
          },
          "rate_card": {
            "ratecard_kind": "RateCardKind_fixed",
            "created_at": "2025-03-13T09:12:34Z",
            "updated_at": "2025-03-13T09:12:34Z"
          },
          "created_at": "2025-03-13T09:12:34Z",
          "updated_at": "2025-03-13T09:12:34Z"
        },
        "refunds": [
          {
            "msg_created_at": "2025-03-13T09:12:34Z",
            "created_at": "2025-03-13T09:12:34Z",
            "updated_at": "2025-03-13T09:12:34Z"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.