Payment Link Webhook - Singapay Documentation

Money In Operation — This webhook fires when a customer completes a payment via a Payment Link, transferring funds into your SingaPay account.

Information

Method	Path	Format	Authentication
POST	`https://your-webhook-url/callback`	json	HMAC SHA512 Signature

SingaPay sends a POST request to your configured transaction_notif_url when a Payment Link transaction is successfully completed. For optional view and expiry notifications (when someone opens a link), see Payment Link Inquiry.

This webhook may share a callback URL with other event types. See Shared webhook endpoints for routing by event value.

Request Details

Headers

Field	Value	Type	Mandatory	Description
`Content-Type`	`application/json`	Alphabetic	Yes	Specifies JSON format for the request body
`X-PARTNER-ID`	—	Alphanumeric	Yes	Your API Key from the merchant dashboard. Example: `b3ed7d4b-a96c-6c08-b3c7-12c3124242d9`

Body Parameters

status

number

required

HTTP Status Code. Example: 200

success

boolean

required

true for 2xx responses, false for 4xx–5xx.

data

object

required

Container for transaction, customer, and payment details.

Show data fields

transaction

object

required

Transaction details.

Show transaction fields

reff_no

string

required

Unique transaction reference number (26 chars). Example: "18917720251110094037705"

type

string

required

Transaction type. Always "pl" for Payment Link.

status

string

required

Transaction status. See Transaction Status Codes. Example: "paid"

amount

object

required

Transaction amount details.

Show amount fields

value

string

required

Transaction amount. Example: "10000.00"

currency

string

required

ISO 4217 currency code. Example: "IDR"

tip

mixed

Tip amount if any. null if no tip was added.

post_timestamp

string

required

Transaction post time. Example: "10 Nov 2025 09:46:38"

processed_timestamp

string

required

Transaction processed time. Example: "10 Nov 2025 09:46:38"

customer

object

required

Customer details.

Show customer fields

mixed

Customer unique ID. null if the customer is not registered.

name

string

required

Customer full name. Example: "Mohammad Zulkifli Katili"

string

required

Customer email address. Example: "mohzulkilfikatili@gmail.com"

phone

string

required

Customer phone number. Example: "082291501085"

payment

object

required

Payment method details.

Show payment fields

method

string

required

Payment method. Always "payment_link".

additional_info

object

required

Payment Link-specific information.

Show additional_info fields

payment_link

object

required

Payment link metadata.

Show payment_link fields

number

required

Payment link ID. Example: 189

reff_no

string

required

Payment link reference number. Example: "PL20251105160923690b1443a67e9"

title

string

required

Payment link title. Example: "tes"

payment_date

string

required

Payment completion datetime (ISO 8601). Example: "2025-11-05T09:09:49.000000Z"

payment_url

string

required

Full payment link URL.

status

string

required

Payment link status. Example: "open"

required_customer_detail

boolean

required

Whether customer details are required at checkout. Example: true

max_usage

number

required

Maximum number of times the link can be used. Example: 1000

current_usage

number

required

Current number of times the link has been used. Example: 4

expired_at

string

Payment link expiration datetime. null if no expiry is set.

total_amount

string

required

Payment link total amount. Example: "10000.00"

account_id

number

required

Account ID associated with the payment link. Example: 35

created_at

string

required

Creation datetime (ISO 8601). Example: "2025-11-05T09:09:49.000000Z"

updated_at

string

required

Last updated datetime (ISO 8601). Example: "2025-11-10T02:46:38.000000Z"

Payload Examples

{
    "status": 200,
    "success": true,
    "data": {
        "transaction": {
            "reff_no": "18917720251110094037705",
            "type": "pl",
            "status": "paid",
            "amount": {
                "value": "10000.00",
                "currency": "IDR"
            },
            "tip": null,
            "post_timestamp": "10 Nov 2025 09:46:38",
            "processed_timestamp": "10 Nov 2025 09:46:38"
        },
        "customer": {
            "id": null,
            "name": "Mohammad Zulkifli Katili",
            "email": "mohzulkilfikatili@gmail.com",
            "phone": "082291501085"
        },
        "payment": {
            "method": "payment_link",
            "additional_info": {
                "payment_link": {
                    "id": 189,
                    "reff_no": "PL20251105160923690b1443a67e9",
                    "title": "tes",
                    "payment_date": "2025-11-05T09:09:49.000000Z",
                    "payment_url": "https://sandbox-paymentlink.singapay.id/b2b/PL20251105160923690b1443a67e9",
                    "status": "open",
                    "required_customer_detail": true,
                    "max_usage": 1000,
                    "current_usage": 4,
                    "expired_at": null,
                    "total_amount": "10000.00",
                    "account_id": 35,
                    "created_at": "2025-11-05T09:09:49.000000Z",
                    "updated_at": "2025-11-10T02:46:38.000000Z"
                }
            }
        }
    }
}

Transaction Status Codes

Status	Description
`paid`	Payment completed successfully
`pending`	Payment is pending
`expired`	Payment link has expired
`failed`	Payment has failed

Event Description

This webhook fires when a payment is successfully completed through a payment link. The payload covers:

Transaction Details

Reference number, type, status, amount, and timestamps.

Customer Info

Name, email, and phone number of the paying customer.

Payment Link Metadata

Usage count, expiry, status, URL, and creation timestamps.

Payment Method

Method used (payment_link) and all associated additional info.

Security and responses

Return HTTP 200 promptly after validating the request. For retry behavior, see Webhook retry mechanism. Verify every webhook using Security and signature validation. Use your configured callback path when building StringToSign. Handle duplicate deliveries idempotently using stable identifiers from the payload (for example transaction_id or reff_no).

​Information

​Request Details

​Headers

​Body Parameters

​Payload Examples

​Transaction Status Codes

​Event Description

Transaction Details

Customer Info

Payment Link Metadata

Payment Method

​Security and responses

Information

Request Details

Headers

Body Parameters

Payload Examples

Transaction Status Codes

Event Description

Security and responses