GET

Retrieve a payment

ENDPOINT/v1/payments/{payment_id}

Returns a single originated ACH payment by id, including method, SEC code, type, return reason, and the chronological events log. 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.

Path Parameters

Parameter	Type	Requirement	Description
payment_id	string	REQUIRED	Unique identifier of the PAYMENT transaction (its transaction id).

Response Codes & Schemas

200The requested payment.

application/json

{
  "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
}

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"
  }
}