- Payment Link History
- List
Payment Link History
List
This feature is used to find out information regarding list of payment in an accounts.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/payment-link-histories/{account_id} | json | OAuth 2.0 with Access Token |
Request Details
Query Parameters for Filtering
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| reff_no | String | Optional | Filter by reference number (partial match) | 12917720251024134439474 |
| status | String | Optional | Filter by transaction status | paid |
| payment_method_name | String | Optional | Filter by payment method name (partial match) | VA BRI |
| payment_method_value | String | Optional | Filter by payment method value (partial match) | 5588867273870397 |
| amount | Decimal | Optional | Filter by exact amount | 1200000.00 |
| amount_min | Decimal | Optional | Filter by minimum amount | 100000.00 |
| amount_max | Decimal | Optional | Filter by maximum amount | 5000000.00 |
| has_settle | Boolean | Optional | Filter by settlement status | true |
| created_at_from | String | Optional | Filter by minimum creation date (ISO 8601) | 2025-10-24T00:00:00+07:00 |
| created_at_to | String | Optional | Filter by maximum creation date (ISO 8601) | 2025-10-24T23:59:59+07:00 |
| payment_date_from | String | Optional | Filter by minimum payment date (ISO 8601) | 2025-10-24T00:00:00+07:00 |
| payment_date_to | String | Optional | Filter by maximum payment date (ISO 8601) | 2025-10-24T23:59:59+07:00 |
| processed_timestamp_from | String | Optional | Filter by minimum processed timestamp (ISO 8601) | 2025-10-24T00:00:00+07:00 |
| processed_timestamp_to | String | Optional | Filter by maximum processed timestamp (ISO 8601) | 2025-10-24T23:59:59+07:00 |
| settle_at_from | String | Optional | Filter by minimum settlement date (ISO 8601) | 2025-10-24T00:00:00+07:00 |
| settle_at_to | String | Optional | Filter by maximum settlement date (ISO 8601) | 2025-10-24T23:59:59+07:00 |
| sort_by | String | Optional | Sort by field (default: id) | id, created_at, amount |
| sort_order | String | Optional | Sort order (default: desc) | asc, desc |
| per_page | Integer | Optional | Items per page (default: 25) | 25, 50, 100 |
Request Example with Filters
Example 1: Filter by Status and Amount Range
GET /api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?status=paid&amount_min=100000&amount_max=5000000&sort_by=created_at&sort_order=desccURL Example:
curl -X GET "https://api.singapay.id/api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?status=paid&amount_min=100000&amount_max=5000000&sort_by=created_at&sort_order=desc" \
-H "X-PARTNER-ID: b3ed7d4b-a96c-6c08-b3c7-12c3124242d9" \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."Example 2: Filter by Payment Method and Settlement Status
GET /api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?payment_method_name=VA BRI&has_settle=true&per_page=50cURL Example:
curl -X GET "https://api.singapay.id/api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?payment_method_name=VA%20BRI&has_settle=true&per_page=50" \
-H "X-PARTNER-ID: b3ed7d4b-a96c-6c08-b3c7-12c3124242d9" \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."Example 3: Filter by Reference Number and Payment Date Range
GET /api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?reff_no=12917720251024134439474&payment_date_from=2025-10-24T00:00:00+07:00&payment_date_to=2025-10-24T23:59:59+07:00cURL Example:
curl -X GET "https://api.singapay.id/api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?reff_no=12917720251024134439474&payment_date_from=2025-10-24T00:00:00%2B07:00&payment_date_to=2025-10-24T23:59:59%2B07:00" \
-H "X-PARTNER-ID: b3ed7d4b-a96c-6c08-b3c7-12c3124242d9" \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."Example 4: Filter by Settlement Date Range and Pagination
GET /api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?settle_at_from=2025-10-24T00:00:00+07:00&settle_at_to=2025-10-30T23:59:59+07:00&sort_by=settle_at&sort_order=asc&per_page=100&page=1cURL Example:
curl -X GET "https://api.singapay.id/api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?settle_at_from=2025-10-24T00:00:00%2B07:00&settle_at_to=2025-10-30T23:59:59%2B07:00&sort_by=settle_at&sort_order=asc&per_page=100&page=1" \
-H "X-PARTNER-ID: b3ed7d4b-a96c-6c08-b3c7-12c3124242d9" \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."Example 5: Filter by Payment Method Value and Creation Date
GET /api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?payment_method_value=5588867273870397&created_at_from=2025-10-24T00:00:00+07:00&created_at_to=2025-10-24T23:59:59+07:00cURL Example:
curl -X GET "https://api.singapay.id/api/v1.0/payment-link-histories/01K8AESCCKYSD98Z3P9RSDA36W?payment_method_value=5588867273870397&created_at_from=2025-10-24T00:00:00%2B07:00&created_at_to=2025-10-24T23:59:59%2B07:00" \
-H "X-PARTNER-ID: b3ed7d4b-a96c-6c08-b3c7-12c3124242d9" \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."Headers Structure
| Field | Value | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|---|
| X-PARTNER-ID | api_key | Alphanumeric | Mandatory | API key obtained from the merchant dashboard. | b3ed7d4b-a96c-6c08-b3c7-12c3124242d9 | |
| Accept | application/json | Alphabetic | Mandatory | Specifies JSON as the expected response format. | application/json | |
| Authorization | Bearer {bearerToken} | Alphanumeric | Mandatory | Bearer token obtained from the get access token endpoint. | Bearer eyJ0eXAiOiJKV1{…} |
Response Details
Response Structure
| Field | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|
| status | Numeric | Mandatory | 3 | HTTP Status Code. | 200 |
| success | Boolean | Mandatory | 1 | Indicates successful request. | true |
| data | Array Object | Mandatory | - | An array containing a list of transaction details. | - |
| > id | Numeric | Mandatory | - | Internal ID of the Transaction. | 58 |
| > reff_no | Alphanumeric | Mandatory | - | Transaction reference number. | 12917720251024134439474 |
| > payment_method_name | String | Mandatory | - | Human-readable name of the payment method used. | VA BRI |
| > payment_method_value | Alphanumeric | Mandatory | - | The payment value (e.g., Virtual Account number). | 5588867273870397 |
| > payment_method_additional | String/Null | Conditional | - | Additional data specific to the payment method. | null |
| > expired_at | Datetime/Null | Conditional | - | The expiration date/time of the transaction (ISO 8601). | 2025-10-25T13:44:39+07:00 |
| > is_expired | Boolean | Mandatory | 1 | Indicates whether the transaction is expired. | true |
| > amount | String/Numeric | Mandatory | - | The transaction amount. | 1200000.00 |
| > payment_date | Datetime/Null | Conditional | - | Date/time of the successful payment. | 2025-10-24T13:45:07+07:00 |
| > balance_after | String/Numeric/Null | Conditional | - | The balance of the user’s account after the transaction. | 2500000.00 |
| > status | Alphabetic | Mandatory | - | The transaction status (e.g., paid). | paid |
| > status_computed | Alphabetic | Mandatory | - | The calculated status of the transaction. | paid |
| > customer_name | String | Conditional | - | Customer’s name associated with the transaction. | "" |
| > customer_email | String | Conditional | - | Customer’s email associated with the transaction. | "" |
| > customer_phone | String | Conditional | - | Customer’s phone number. | "" |
| > ip_address | String | Conditional | - | The IP address(es) from which the transaction was made. | 103.133.68.7, 103.133.68.7 |
| > locations | String/Null | Conditional | - | Geographical location information. | null |
| > vendor_fee | String/Numeric | Mandatory | - | The fee charged by the payment method vendor. | 1500.00 |
| > our_margin | String/Numeric | Mandatory | - | The platform’s margin/fee from the transaction. | 1000.00 |
| > processed_timestamp | Datetime/Null | Conditional | - | Date/time when the transaction was fully processed. | 2025-10-24T13:45:07+07:00 |
| > has_settle | Boolean | Mandatory | - | Indicates whether the transaction has been settled. | true |
| > settle_at | Datetime/Null | Conditional | - | Date/time when the transaction was settled. | 2025-10-24T15:00:00+07:00 |
| > created_at | Datetime | Mandatory | - | Date/time the transaction was created. | 2025-10-24T13:44:39+07:00 |
| > updated_at | Datetime | Mandatory | - | Date/time the transaction was last updated. | 2025-10-29T11:12:17+07:00 |
| > payment_link | Object | Mandatory | - | Detailed information about the associated Payment Link. | - |
| >> id | Numeric | Mandatory | - | Payment Link ID. | 129 |
| >> reff_no | Alphanumeric | Mandatory | - | Payment Link reference number. | invoice_travelan01 |
| >> title | String | Mandatory | - | Payment Link title. | Pembelian Tiket Pesawat |
| >> payment_url | String | Mandatory | - | Payment Link URL. | https://sandbox-paymentlink.singapay.id/b2b/invoice_travelan01 |
| >> status | Alphabetic | Mandatory | - | Payment Link status (e.g., open). | open |
| >> status_computed | Alphabetic | Mandatory | - | Computed Payment Link status (e.g., expired). | expired |
| >> required_customer_detail | Boolean | Mandatory | 1 | If customer detail is required. | false |
| >> max_usage | Numeric | Mandatory | - | Max usage count. | 1 |
| >> current_usage | Numeric | Mandatory | - | Current usage count. | 1 |
| >> expired_at | Datetime/Null | Conditional | - | Payment Link expiry date. | 2025-10-25T13:41:00+07:00 |
| >> is_expired | Boolean | Mandatory | 1 | If Payment Link is expired. | true |
| >> total_amount | String/Numeric | Mandatory | - | Payment Link total amount. | 1200000.00 |
| >> items | Array Object/Null | Conditional | - | List of items in the Payment Link. | - |
| >>> name | Alphabetic | Mandatory | - | Item name. | Pembelian TIket Pesawat |
| >>> quantity | String/Numeric | Mandatory | - | Item quantity. | 1 |
| >>> unit_price | String/Numeric | Mandatory | - | Item unit price. | 700000 |
| >>> subtotal | Numeric | Mandatory | - | Item subtotal. | 700000 |
| >> whitelisted_payment_method | Array String/Null | Conditional | - | List of whitelisted payment codes. | [ “VA_BRI”, “VA_DANAMON”, “VA_MAYBANK”, “INDOMARET”, “ALFAMART”, “QRIS” ] |
| >> redirect_url | String/Null | Conditional | - | Redirect URL set on the Payment Link. | https://example.com/thank-you |
| >> payment_date | Datetime/Null | Conditional | - | Last payment date for the link. | 2025-10-24T13:42:55+07:00 |
| >> created_at | Datetime | Mandatory | - | Payment Link creation date. | 2025-10-24T13:42:55+07:00 |
| >> updated_at | Datetime | Mandatory | - | Payment Link last updated date. | 2025-10-24T13:45:07+07:00 |
| >> account | Object | Mandatory | - | Associated Account information. | - |
| >>> id | Alphanumeric | Mandatory | - | Account ID. | 01K8AESCCKYSD98Z3P9RSDA36W |
| >>> name | String | Mandatory | - | Account name. | Travelan |
| String | Mandatory | - | Account email. | travelan@gmail.com | |
| >>> phone | String | Mandatory | - | Account phone number. | 085673574337633 |
| >>> status | Alphabetic | Mandatory | - | Account status. | active |
| > payment_method | Object | Mandatory | - | Detailed information about the payment method used for this transaction. | - |
| >> id | Numeric | Mandatory | - | Payment Method ID. | 1 |
| >> code | String | Mandatory | - | Payment Method code. | VA_BRI |
| >> name | String | Mandatory | - | Payment Method name. | VA BRI |
| >> desc | String | Conditional | - | Payment Method description. | Virtual Account BRI |
| >> status | Alphabetic | Mandatory | - | Payment Method status (e.g., active). | active |
| >> group | Alphabetic | Mandatory | - | Payment Method group (e.g., va). | va |
| >> inactive_reason | String/Null | Conditional | - | Reason if the method is inactive. | null |
| >> bank_vendor_id | Numeric/Null | Conditional | - | ID of the bank/vendor. | null |
| >> had_payment_link | Boolean | Mandatory | 1 | If the method supports Payment Link. | true |
| >> kind | Alphabetic | Mandatory | - | Type of the method (e.g., transaction). | transaction |
| >> created_at | Datetime | Mandatory | - | Payment Method creation date. | 2025-08-14T15:39:56+07:00 |
| >> updated_at | Datetime | Mandatory | - | Payment Method last updated date. | 2025-08-14T15:39:56+07:00 |
| pagination | Object | Mandatory | - | Object containing pagination metadata. | - |
| > count | Numeric | Mandatory | - | Number of items in the current page. | 1 |
| > total | Numeric | Mandatory | - | Total number of items across all pages. | 1 |
| > perPage | Numeric | Mandatory | - | Items per page setting. | 25 |
| > currentPage | Numeric | Mandatory | - | The current page number. | 1 |
| > totalPages | Numeric | Mandatory | - | The total number of pages. | 1 |
| > links | Object | Mandatory | - | Object containing pagination links. |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": [
{
"id": 58,
"reff_no": "12917720251024134439474",
"payment_method_name": "VA BRI",
"payment_method_value": "5588867273870397",
"payment_method_additional": null,
"expired_at": "2025-10-25T13:44:39+07:00",
"is_expired": true,
"amount": "1200000.00",
"payment_date": "2025-10-24T13:45:07+07:00",
"balance_after": "2500000.00",
"status": "paid",
"status_computed": "paid",
"customer_name": "",
"customer_email": "",
"customer_phone": "",
"ip_address": "103.133.68.7, 103.133.68.7",
"locations": null,
"vendor_fee": "1500.00",
"our_margin": "1000.00",
"processed_timestamp": "2025-10-24T13:45:07+07:00",
"has_settle": true,
"settle_at": "2025-10-24T15:00:00+07:00",
"created_at": "2025-10-24T13:44:39+07:00",
"updated_at": "2025-10-29T11:12:17+07:00",
"payment_link": {
"id": 129,
"reff_no": "invoice_travelan01",
"title": "Pembelian Tiket Pesawat",
"payment_url": "https://sandbox-paymentlink.singapay.id/b2b/invoice_travelan01",
"status": "open",
"status_computed": "expired",
"required_customer_detail": false,
"max_usage": 1,
"current_usage": 1,
"expired_at": "2025-10-25T13:41:00+07:00",
"is_expired": true,
"total_amount": "1200000.00",
"items": [
{
"name": "Pembelian TIket Pesawat",
"quantity": "1",
"unit_price": "700000",
"subtotal": 700000
},
{
"name": "Pemesanan Hotel",
"quantity": "1",
"unit_price": "500000",
"subtotal": 500000
}
],
"whitelisted_payment_method": [
"VA_BRI",
"VA_DANAMON",
"VA_MAYBANK",
"INDOMARET",
"ALFAMART",
"QRIS"
],
"redirect_url": null,
"payment_date": "2025-10-24T13:42:55+07:00",
"created_at": "2025-10-24T13:42:55+07:00",
"updated_at": "2025-10-24T13:45:07+07:00",
"account": {
"id": "01K8AESCCKYSD98Z3P9RSDA36W",
"name": "Travelan",
"email": "travelan@gmail.com",
"phone": "085673574337633",
"status": "active"
}
},
"payment_method": {
"id": 1,
"code": "VA_BRI",
"name": "VA BRI",
"desc": "Virtual Account BRI",
"status": "active",
"group": "va",
"inactive_reason": null,
"bank_vendor_id": null,
"had_payment_link": true,
"kind": "transaction",
"created_at": "2025-08-14T15:39:56+07:00",
"updated_at": "2025-08-14T15:39:56+07:00"
}
}
],
"pagination": {
"count": 1,
"total": 1,
"perPage": 25,
"currentPage": 1,
"totalPages": 1,
"links": {}
}
}