List payments

Returns a paginated list of payments, newest first.

GET/payments

Authorization

AuthorizationBearer token · headerrequired

Your Apipay secret API key.

Query parameters

limitinteger

Maximum number of payments to return.

min 1 · max 100 · default: 20

starting_afterstring

Cursor for fetching the next page, from a previous response's next_cursor.

statusPaymentStatus

Filter by payment status.

Allowed:pendingsucceededfailedcanceled

Responses

200

A page of payments.

dataPayment[]required

Show properties

Array of Payment

idstringrequired

amountintegerrequired

Amount in the smallest unit of the currency (e.g. Rupiah has no sub-unit, so this is whole Rupiah).

currencystringrequired

methodPaymentMethodrequired

Allowed:qrisvirtual_accountcardewallet

statusPaymentStatusrequired

Allowed:pendingsucceededfailedcanceled

customer_idstring | null

descriptionstring | null

created_atstring<date-time>required

next_cursorstring | null

401

The API key is missing, invalid, or revoked.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

limitqueryMaximum number of payments to return.starting_afterqueryCursor for fetching the next page, from a previous response's `next_cursor`.statusqueryFilter by payment status.

Request

curl -X GET 'https://api.apipay.id/v1/payments' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.apipay.id/v1/payments", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.apipay.id/v1/payments",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "data": [
    {
      "id": "pay_6b2f9d4e",
      "amount": 150000,
      "currency": "IDR",
      "method": "qris",
      "status": "pending",
      "customer_id": "cus_8f3a2b1c",
      "description": "Order",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}

{
  "error": {
    "code": "invalid_request",
    "message": "amount must be a positive integer"
  }
}