List

curl --request GET \
  --url https://sandbox-payment-b2b.singapay.id/api/v1.0/payment-link-histories/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-PARTNER-ID: <api-key>'

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 85,
      "reff_no": "12917720251024134439474",
      "payment_link_reff_no": "PL-20251024-0001",
      "payment_method_name": "VA BRI",
      "payment_method_value": "5588867273870397",
      "payment_method_additional": "a.n. SINGA PAYMENT",
      "expired_at": "2025-10-25T13:44:39+07:00",
      "amount": "1200000.00",
      "payment_date": "2025-10-24T13:45:07+07:00",
      "balance_after": "2500000.00",
      "status": "paid",
      "status_computed": "paid",
      "is_expired": true,
      "customer_name": "",
      "customer_email": "",
      "customer_phone": "",
      "ip_address": "103.133.68.7, 103.133.68.7",
      "locations": {},
      "processed_timestamp": "2025-10-24T13:45:07+07:00",
      "has_settle": true,
      "settle_at": "2025-10-24T15:00:00+07:00",
      "optional_metadata": {},
      "created_at": "2025-10-24T13:44:39+07:00",
      "updated_at": "2025-10-29T11:12:17+07:00"
    }
  ],
  "pagination": {}
}

Payment Link History

List

Retrieve a paginated list of payment link transactions for an account. Each entry represents a single payment attempt made against one of the account’s payment links.

Results are restricted to transactions created within the last 12 months and are ordered newest-first by default. Use the query parameters to paginate, sort, and filter the result set; pagination details are returned in the response meta object.

The following optional filters are available and may be combined: reff_no, status, payment_method_name, payment_method_value, amount, amount_min, amount_max, has_settle, created_at_from/created_at_to, payment_date_from/payment_date_to, processed_timestamp_from/processed_timestamp_to, and settle_at_from/settle_at_to. Date filters accept ISO 8601 values and define an inclusive range.

GET

api

v1.0

payment-link-histories

{account_id}

List

curl --request GET \
  --url https://sandbox-payment-b2b.singapay.id/api/v1.0/payment-link-histories/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-PARTNER-ID: <api-key>'

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 85,
      "reff_no": "12917720251024134439474",
      "payment_link_reff_no": "PL-20251024-0001",
      "payment_method_name": "VA BRI",
      "payment_method_value": "5588867273870397",
      "payment_method_additional": "a.n. SINGA PAYMENT",
      "expired_at": "2025-10-25T13:44:39+07:00",
      "amount": "1200000.00",
      "payment_date": "2025-10-24T13:45:07+07:00",
      "balance_after": "2500000.00",
      "status": "paid",
      "status_computed": "paid",
      "is_expired": true,
      "customer_name": "",
      "customer_email": "",
      "customer_phone": "",
      "ip_address": "103.133.68.7, 103.133.68.7",
      "locations": {},
      "processed_timestamp": "2025-10-24T13:45:07+07:00",
      "has_settle": true,
      "settle_at": "2025-10-24T15:00:00+07:00",
      "optional_metadata": {},
      "created_at": "2025-10-24T13:44:39+07:00",
      "updated_at": "2025-10-29T11:12:17+07:00"
    }
  ],
  "pagination": {}
}

Authorizations

Authorization

string

header

required

JWT issued by POST /api/v1.1/access-token/b2b. Send Authorization: Bearer <token>.

X-PARTNER-ID

string

header

required

Merchant API key (Credential.api_key). Required on every request.

Path Parameters

account_id

string

required

ULID of the account whose payment link histories are being listed. Must belong to the authenticated merchant.

Example:

"01HZX9K3P2J4M6N8Q0R2T4V6W8"

Query Parameters

per_page

integer

default:25

Number of items per page.

Example:

25

sort_by

string

default:id

Column to sort by (e.g. id, created_at, amount, payment_date).

Example:

"created_at"

sort_order

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

Example:

"desc"

reff_no

string

Filter by attempt reference number (partial/substring match).

Example:

"12917720251024134439474"

status

enum<string>

Filter by exact stored status.

Available options:

pending,

paid,

failed,

expired

Example:

"paid"

payment_method_name

string

Filter by payment channel name (partial/substring match), e.g. VA BRI, QRIS.

Example:

"VA BRI"

payment_method_value

string

Filter by the channel-specific payment value such as a virtual account number (partial/substring match).

Example:

"5588867273870397"

amount

number

Filter by exact gross amount (IDR).

Example:

1200000

amount_min

number

Filter by minimum gross amount (IDR), inclusive.

Example:

100000

amount_max

number

Filter by maximum gross amount (IDR), inclusive.

Example:

5000000

has_settle

boolean

Filter by settlement state — true returns only transactions whose funds have been settled to the merchant.

Example:

true

created_at_from

string<date-time>

Lower bound (inclusive) of the record creation timestamp. ISO 8601.

Example:

"2025-10-01T00:00:00+07:00"

created_at_to

string<date-time>

Upper bound (inclusive) of the record creation timestamp. ISO 8601.

Example:

"2025-10-31T23:59:59+07:00"

payment_date_from

string<date-time>

Lower bound (inclusive) of the paid-at timestamp. ISO 8601.

Example:

"2025-10-01T00:00:00+07:00"

payment_date_to

string<date-time>

Upper bound (inclusive) of the paid-at timestamp. ISO 8601.

Example:

"2025-10-31T23:59:59+07:00"

processed_timestamp_from

string<date-time>

Lower bound (inclusive) of the channel processing timestamp. ISO 8601.

Example:

"2025-10-01T00:00:00+07:00"

processed_timestamp_to

string<date-time>

Upper bound (inclusive) of the channel processing timestamp. ISO 8601.

Example:

"2025-10-31T23:59:59+07:00"

settle_at_from

string<date-time>

Lower bound (inclusive) of the settlement timestamp. ISO 8601.

Example:

"2025-10-01T00:00:00+07:00"

settle_at_to

string<date-time>

Upper bound (inclusive) of the settlement timestamp. ISO 8601.

Example:

"2025-10-31T23:59:59+07:00"

Response

Success

Success envelope returned by the payment link history list endpoint. Wraps the page of history records in data and the paginator metadata in pagination.

status

integer

required

HTTP status code of the response.

Example:

200

success

boolean

required

Indicates whether the request was processed successfully. Always true for a 200 response.

Example:

true

data

object[]

required

The page of payment link history records, newest-first by default.

Show child attributes

pagination

object

Pagination metadata for the collection — includes the current page, per-page size, total item count, and total page count (Laravel paginator output).

Overview

Show