Create a notification subscription

Production

https://api.paypaga.com

POST

/v2/notification-subscriptions

Create a subscription to receive notifications for specific events related to transactions with callbacks or email.

Valid notification types

notification_types accepts exactly three values: transaction_approved, transaction_failed,
and transaction_expired.

Error codes for Create a Notification Subscription

HTTP status	Error code	Description
400	BAD_REQUEST	Failed to parse the request body
400	VALIDATION_ERROR	Request validation failed
401	UNAUTHORIZED	Missing or invalid authorization token
403	FORBIDDEN	You do not have permission to access this resource
500	INTERNAL_ERROR	Unexpected server error

Callbacks

transactionApproved

transactionError

transactionExpired

transactionUnderpaid

transactionUnsolicitedPayment

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://api.paypaga.com/oauth2/token

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Notification subscription created successfully.

Bodyapplication/json

🟠400ValidationAndBadRequestError

🟠401Unauthorized

🟠403Forbidden

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

cURL

callback_subscriptionemail_subscription

curl --location 'https://api.paypaga.com/v2/notification-subscriptions' \
--header 'Content-Type: application/json' \
--data '{
    "channel_type": "callback",
    "notification_types": [
        "transaction_approved",
        "transaction_failed"
    ],
    "subscription_id": "20251022-0949-42c7-947d-67f32a1ecf45",
    "targets": [
        "https://example.com/callback-endpoint",
        "https://another-endpoint.com/callback"
    ]
}'

Response Example

201 - Example 1

{
    "channel": "callback",
    "created_on": "2024-08-06T20:15:30Z",
    "notification_types": [
        "transaction_approved",
        "transaction_failed"
    ],
    "product": "pay_in",
    "subscription_id": "20251022-0949-42c7-947d-67f32a1ecf45",
    "targets": [
        "https://example.com/callback-endpoint",
        "https://another-endpoint.com/callback"
    ]
}

Modified at 2026-09-11 10:06:04

List notification subscriptions

Retrieve a notification subscription