List gateway transactions | Modulate Partner API

curl -G https://getmodulate.dev/api/partner/merchants/925700000233734/gateway-transactions \
     -H "X-Partner-API-Key: <apiKey>" \
     -d page=1 \
     -d page_size=2 \
     -d days=30

{
  "data": [
    {
      "gateway_transaction_id": "8734291056",
      "gateway": "nmi",
      "order_id": "ORD-20250115-001",
      "action_type": "sale",
      "status": "complete",
      "amount": "59.99",
      "card_type": "visa",
      "last_four": "4242",
      "timestamp": "2025-01-15T14:32:00+00:00",
      "auth_code": "A12345"
    },
    {
      "gateway_transaction_id": "8734291057",
      "gateway": "nmi",
      "action_type": "refund",
      "status": "complete",
      "amount": "25.00",
      "card_type": "mastercard",
      "last_four": "8910",
      "timestamp": "2025-01-15T15:10:00+00:00"
    }
  ],
  "meta": {
    "request_id": "req_gw01",
    "api_version": "v1",
    "page": 1,
    "page_size": 2,
    "total_count": 85,
    "total_pages": 43,
    "has_next": true,
    "has_prev": false,
    "source": "nmi",
    "as_of": "2025-01-15T15:30:00+00:00"
  },
  "errors": []
}

Paginated NMI gateway transactions for a merchant with action type and status filters.

Authentication

X-Partner-API-Keystring

API Key authentication via header

Path parameters

merchant_idstringRequired1-50 characters

Merchant ID

Query parameters

pageintegerOptional>=1Defaults to 1

Page number

page_sizeintegerOptional1-100Defaults to 25

Items per page

daysintegerOptional1-365Defaults to 30

Lookback period in days

action_typestring or nullOptionalformat: "^(sale|refund|void|auth|capture)$"

Filter by action type

statusstring or nullOptionalformat: "^(complete|pending|failed|pendingsettlement)$"

Filter by status

Response

Successful Response

datalist of objects

metaobject

errorslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

503

Service Unavailable Error