SettleFlow API
API ReferenceTransactions

List transactions

GET
/transactions

Returns a paginated list of transactions (payment attempts) matching the given filters.

X-Api-Key<token>

Merchant API key for authentication

In: header

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 300
Default20
sortBy?string
order?string
Default"desc"

Value in

  • "asc"
  • "desc"
status?string

Filter by transaction status.

Value in

  • "initiated"
  • "processing"
  • "redirect_required"
  • "redirected"
  • "challenge_required"
  • "challenge_completed"
  • "awaiting_confirmation"
  • "awaiting_webhook"
  • "authorized"
  • "captured"
  • "failed"
  • "rejected"
  • "cancelled"
  • "expired"
method_family?string

Filter by payment method family.

Value in

  • "card"
  • "bank_redirect"
  • "bank_transfer"
  • "direct_debit"
  • "wallet"
  • "buy_now_pay_later"
  • "voucher"
  • "crypto"
from?string

Only transactions created at/after this ISO 8601 time.

Formatdate-time
to?string

Only transactions created at/before this ISO 8601 time.

Formatdate-time
search?string

Free-text search (reference, last4…).

Lengthlength <= 191

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/transactions"
{  "data": [    {      "id": "string",      "payment_id": "string",      "attempt_number": 0,      "amount": 0,      "method_family": "string",      "method_type": "string",      "status": "string",      "failure_reason": "string",      "card": {        "brand": "string",        "last4": "string"      },      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}