- Payment Link
- Show
Payment Link
Show
This feature is used to show the details of a payment link.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/payment-link-manage/{account_id}/{payment_link_id} | json | OAuth 2.0 with Access Token |
Request Details
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 the success of the request. | true |
| data | Object | Mandatory | - | The main object containing the details of a single payment link. | - |
| > id | Numeric | Mandatory | - | Internal ID of the Payment Link. | 103 |
| > reff_no | Alphanumeric | Mandatory | - | Reference number of the Payment Link. | PL2025102113590968f72f3df34e5 |
| > title | Alphanumeric | Mandatory | - | Title of the payment link. | tes |
| > payment_url | String | Mandatory | - | URL to access the payment link. | http://localhost:3000/b2b/PL2025102113590968f72f3df34e5 |
| > status | Alphabetic | Mandatory | - | Status of the payment link. Values are open or closed. | open |
| > status_computed | Alphabetic | Mandatory | - | The computed status of the payment link. Values are open, closed, or expired. | open |
| > required_customer_detail | Boolean | Mandatory | 1 | Indicates if customer details are required. | true |
| > max_usage | Numeric | Mandatory | - | Maximum usage count for the payment link. | 1000 |
| > current_usage | Numeric | Mandatory | - | Current usage count of the payment link. | 2 |
| > expired_at | Datetime/Null | Conditional | - | Expiration date of the payment link (ISO 8601 format). It is null if there is no expiration. | null |
| > is_expired | Boolean | Mandatory | 1 | Indicates if the payment link has expired. | false |
| > total_amount | Numeric | Mandatory | - | Total amount of the payment link. | 20000.00 |
| > items | Array Object/Null | Conditional | - | List of items included in the payment. | - |
| >> name | Alphabetic | Mandatory | - | Name of the item. | tes |
| >> quantity | Numeric | Mandatory | - | Quantity of the item. | 1 |
| >> unit_price | Numeric | Mandatory | - | Price per unit of the item. | 20000 |
| >> subtotal | Numeric | Mandatory | - | Subtotal for the item (quantity * unit_price). | 20000 |
| > whitelisted_payment_method | Array String/Null | Conditional | - | List of allowed (whitelisted) payment method codes. It is null if all methods are allowed. | [ “VA_BRI”, “VA_DANAMON”, “QRIS” ] |
| > redirect_url | String/Null | Conditional | - | URL to redirect the customer after payment success or expiry. It is null if not set. | https://example.com/thank-you |
| > payment_date | Datetime/Null | Conditional | - | Date/time of the last successful payment (ISO 8601 format or null). | 2025-10-21T13:59:40+07:00 |
| > created_at | Datetime | Mandatory | - | Creation date/time of the payment link (ISO 8601 format). | 2025-10-21T13:59:40+07:00 |
| > updated_at | Datetime | Mandatory | - | Last update date/time of the payment link (ISO 8601 format). | 2025-10-21T15:16:05+07:00 |
| > account | Object | Mandatory | - | Account information associated with the payment link. | - |
| >> id | Alphanumeric | Mandatory | - | Account ID. | 01K7P073Q8RE2A9PQT8Q7MXPN4 |
| >> name | Alphabetic | Mandatory | - | Account Name. | Moh. Zulkifli Katili |
| String | Mandatory | - | Account email address. | tes@gmail.com | |
| >> phone | Numeric | Mandatory | - | Account phone number. | 08123993201 |
| >> status | Alphabetic | Mandatory | - | Account Status. | active |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": {
"id": 103,
"reff_no": "PL2025102113590968f72f3df34e5",
"title": "tes",
"payment_url": "http://localhost:3000/b2b/PL2025102113590968f72f3df34e5",
"status": "open",
"status_computed": "open",
"required_customer_detail": true,
"max_usage": 1000,
"current_usage": 2,
"expired_at": null,
"is_expired": false,
"total_amount": "20000.00",
"items": [
{
"name": "tes",
"quantity": "1",
"unit_price": "20000",
"subtotal": 20000
}
],
"whitelisted_payment_method": [
"VA_BRI",
"VA_DANAMON",
"VA_MAYBANK",
"QRIS"
],
"redirect_url": null,
"payment_date": "2025-10-21T13:59:40+07:00",
"created_at": "2025-10-21T13:59:40+07:00",
"updated_at": "2025-10-21T15:16:05+07:00",
"account": {
"id": "01K7P073Q8RE2A9PQT8Q7MXPN4",
"name": "Moh. Zulkifli Katili",
"email": "tes@gmail.com",
"phone": "08123993201",
"status": "active"
}
}
}