PaymentLink Notification

Webhook

POST

paymentLinkStatusUpdate

Webhook Status Flow

One-Time Payments

Follows the standard lifecycle: init -> active -> completed | expired.

Permanent Payment Links

Creation: When a permanent payment link is created, the status directly transitions to active, skipping the init state. Only one webhook notification is sent at this stage.

Payment: When a payment is made via a Permanent Link, a new sub-order is generated with its status directly set to completed. This sub-order can be linked back to the original Permanent Payment Link using the referencePaymentId field.

Request

Header Params

Body Params application/json

Example

{
    "eventId": "string",
    "eventType": "PAYMENT_LINK_UPDATED",
    "timestamp": 0,
    "data": {
        "paymentId": "string",
        "referencePaymentId": "string",
        "productRemark": "string",
        "userOrderNo": "string",
        "recipientName": "string",
        "recipientAccountId": "string",
        "fiatCurrency": "string",
        "fiatAmount": "string",
        "cryptoCurrency": "string",
        "cryptoAmount": "string",
        "quotePrice": "string",
        "supportCurrency": "string",
        "supportNetwork": "string",
        "payerInfo": {
            "payerNameUnavailable": true
        },
        "returnUrl": "http://example.com",
        "status": "init",
        "paymentLinkType": "permanent",
        "paymentValidTime": 1,
        "paymentLink": "http://example.com",
        "effectiveTime": 0,
        "expiresTime": 0,
        "createTime": 0
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://your-api-server.com' \
--header 'API-KEY: apikey ' \
--header 'API-TIMESTAMP: 1765454475759' \
--header 'API-SIGNATURE: d110004016a3cf2bfa06d57eaf850618c143f8aeb6e528882bd3811b2b988160' \
--header 'X-BPN-API-KEY: <api-key>' \
--header 'X-BPN-SIGNATURE: <api-key>' \
--header 'X-BPN-TIMESTAMP: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "eventId": "string",
    "eventType": "PAYMENT_LINK_UPDATED",
    "timestamp": 0,
    "data": {
        "paymentId": "string",
        "referencePaymentId": "string",
        "productRemark": "string",
        "userOrderNo": "string",
        "recipientName": "string",
        "recipientAccountId": "string",
        "fiatCurrency": "string",
        "fiatAmount": "string",
        "cryptoCurrency": "string",
        "cryptoAmount": "string",
        "quotePrice": "string",
        "supportCurrency": "string",
        "supportNetwork": "string",
        "payerInfo": {
            "payerNameUnavailable": true
        },
        "returnUrl": "http://example.com",
        "status": "init",
        "paymentLinkType": "permanent",
        "paymentValidTime": 1,
        "paymentLink": "http://example.com",
        "effectiveTime": 0,
        "expiresTime": 0,
        "createTime": 0
    }
}'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{}

partner order status

inquiry supported currency