Skip to content
Raïs

Payments

List payments

Returns the payments of your store in the environment of the key, newest first, 20 at a time by default.

GET/v1/payments

Requires the payments:read scope.

Filter by status, by your own reference, or by creation time (Unix seconds); page with starting_after.

curl 'https://api.rais.app/v1/payments?status=paid&limit=3' \
  -H "Authorization: Bearer rais_sk_test_..."
Response200
{
  "object": "list",
  "data": [
    {
      "id": "5b1c2f4e-9d3a-4c61-8a7e-0f2d6b9e1a33",
      "object": "payment",
      "status": "pending",
      "amount": 500000,
      "currency": "DZD",
      "description": "Order #1042",
      "reference": "order-1042",
      "customer": {
        "id": null,
        "name": "Amina Benali",
        "email": "amina@example.dz",
        "phone": "+213550000000"
      },
      "items": [
        {
          "name": "Running shoes",
          "description": null,
          "quantity": 2,
          "unit_amount": 250000
        }
      ],
      "metadata": {
        "cart_id": "c_8812"
      },
      "livemode": false,
      "payment_page": "rais",
      "checkout_url": "https://pay.rais.app/pay/5b1c2f4e-9d3a-4c61-8a7e-0f2d6b9e1a33",
      "success_url": "https://shop.example/thanks",
      "cancel_url": "https://shop.example/cart",
      "expires_at": 1793003600,
      "created": 1793000000,
      "paid_at": null,
      "amount_refunded": 0,
      "refunded": false,
      "fees": null,
      "net": null,
      "receipt_url": null,
      "failure": null,
      "payment_method": null,
      "processor": {
        "name": "satim",
        "order_id": "V721uPPfNNofVQAAABL3",
        "approval_code": null,
        "response_code": null
      }
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Request

Query parameters

statusstring

Only payments with this status.

One of pending, paid, failed, cancelled, expired, refunded, partially_refunded, reversed.

referencestring

Only payments with exactly this reference.

At most 64 characters.

created_gteinteger

Only payments created at or after this Unix time (seconds).

Between 0 and 253402300799.

created_lteinteger

Only payments created at or before this Unix time (seconds).

Between 0 and 253402300799.

limitinteger

How many objects to return: 1 to 100 (default 20).

Between 1 and 100. Default 20.

starting_afterstring

The cursor of the page to return: pass the next_cursor of the previous page (the id of its last object).

At most 100 characters.

Response

200A page of payments.

objectstring

Always list.

Always list.

dataarray of Payment

The payments of this page, newest first.

See the Payment object

has_moreboolean

True when there are older payments: pass next_cursor as starting_after.

next_cursorstringnullable

The value to pass as starting_after to get the next page; null on the last page.

Errors

StatusCodeExample message
400invalid_parameterInvalid value.
400invalid_cursorNo such payment: the starting_after cursor is unknown.
401invalid_api_keyInvalid API key provided.
403insufficient_scopeThis API key does not have the 'payments:write' permission.
403account_disabledThis store is suspended or disabled.
403live_mode_not_enabledComplete business verification to take live payments.
429rate_limit_exceededToo many requests. Slow down and retry after the delay in the Retry-After header.
500internal_errorSomething went wrong on our side. Quote the request id to support.

Every error has the same envelope. See Errors.

Related guides