GET

List payments

ENDPOINT/v1/payments

Returns transactions of type PAYMENT — originated payins and payouts over ACH, RTP, or FedNow — in the program, newest first. Equivalent to GET /v1/transactions?type=PAYMENT. Filter by financial account, external bank account, method, payment type, and status. This operation is program-scoped.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.

Query Parameters

Parameter	Type	Requirement	Description
financial_account_id	string(uuid)	OPTIONAL	Return only payments posted to this financial account.
external_bank_account_id	string(uuid)	OPTIONAL	Return only payments whose ACH counterparty is this external bank account.
status	string	OPTIONAL	Return only payments in this lifecycle status. Allowed:`PENDINGSETTLEDDECLINEDVOIDEDEXPIREDRETURNEDREVERSEDRELEASEDCANCELED`
method	string	OPTIONAL	Return only payments originated on this ACH rail. Allowed:`ACH_NEXT_DAYACH_SAME_DAYRTPFEDNOW`
payment_type	string	OPTIONAL	Return only `PAYIN` or `PAYOUT` payments. These values apply to `/v1/payments` only; internal transfers use `subtype` (`COLLECTION` / `PAYMENT`), not this parameter (D-10). Allowed:`PAYINPAYOUT`
page	integer	OPTIONAL	1-based page index. Default 1. Values below 1 are treated as 1.
page_size	integer	OPTIONAL	Number of objects to return in the page. Minimum 1, maximum 100, default 10. Also accepted as `page-size`. Values below 1 fall back to the default; values above 100 are capped at 100.
order_by	string	OPTIONAL	Field to sort by. When omitted, the endpoint uses its default order. Also accepted as `order-by`. Valid fields are endpoint-specific (`created_at`, `updated_at`, …).
ascending	boolean	OPTIONAL	Sort direction. Default true (ascending). Pass `false` for descending. Invalid values are ignored and the default is used.

Response Codes & Schemas

200A page of payments.

application/json

{
  "data": [
    {
      "id": "8f1a4c60-2e7b-4d23-c0f5-7a0d3e9c4576",
      "object": "transaction",
      "type": "PAYMENT",
      "status": "SETTLED",
      "transfer_ids": [
        "6f2d8a41-3c7e-4b95-a1d0-8e5c2f7b9a63"
      ],
      "amount": {
        "amount": 125000,
        "currency": "USD"
      },
      "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
      "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
      "direction": "CREDIT",
      "category": "ACH",
      "memo": "ACH autopay collection",
      "events": [
        {
          "id": "3a6c8d14-5b91-4e24-f7a0-4d2b9c3e6175",
          "type": "CREATED",
          "amount": {
            "amount": 125000,
            "currency": "USD"
          },
          "result": "APPROVED",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "created_at": "2026-08-20T12:00:00Z"
        },
        {
          "id": "4b7d9e25-6c02-4f35-a8b1-5e3c0d4f7286",
          "type": "SETTLED",
          "amount": {
            "amount": 125000,
            "currency": "USD"
          },
          "result": "APPROVED",
          "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
          "created_at": "2026-08-22T16:05:00Z"
        }
      ],
      "created_at": "2026-08-20T12:00:00Z",
      "updated_at": "2026-08-22T16:05:00Z",
      "external_bank_account_id": "1b6d8f20-4c53-4a87-9e2d-0f5a7c8b3914",
      "method": "ACH_NEXT_DAY",
      "sec_code": "PPD",
      "payment_type": "PAYIN",
      "result": "APPROVED",
      "return_reason_code": null
    }
  ],
  "total_count": 1
}

400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}

401Unauthorized: missing, malformed, or unknown API key.

application/json

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}

403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.

application/json

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}

404Not Found: unknown id, or the resource is not visible to this API key.

application/json

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}

429Too Many Requests: the API key exceeded its rate limit.

application/json

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}

500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.

application/json

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}