Bulk Transaction Callback

Callbacks sent to the address(es) defined under Payment Settings > Callback in the Paywall panel, based on the conditions you have specified.

Once the bulk transactions are completed by Paywall, a callback is sent to the CallbackAddress provided within the bulk transaction order. This callback allows your system to be informed of the final status of the transaction.

Key
Description
Type

Notification type

See: Review

BulkPaymentId

Bulk payment/transaction ID

ErrorMessage

Descriptive message of the error that occurred during the bulk transaction

DateTime

Final action date of the bulk transaction

FinishedAt

Completion date of the bulk transaction

CreatedAt

Creation date of the bulk transaction

DurationTime

Duration of the bulk transaction until completion (in seconds)

Hash

The Hash parameter used to verify that the request originated from Paywall. This hash is generated using Paywall’s 'System Webhook Hash Key'.

Format:

{key}###{bulkPaymentId}###{merchantUniqueCode}

IsCompressed

Indicates whether the request has been compressed.

The compression is applied only if specified by you at the time the request is sent.

PageNumber

For your large-volume transactions (e.g., 10k, 20k, 50k), you may want to receive partial callbacks. Paywall supports partial callbacks and delivers them in batches of 1,000. In this case, the PageNumber parameter indicates which 1,000-record page is being sent.

TotalPages

Just like PageNumber, the TotalPages parameter indicates the total number of pages in partial callbacks. For example, if the value is 10, it means Paywall will send you a total of 10 callback batches.

HasMorePages

In partial callbacks, if the HasMorePages parameter in the callback content is true, it means there are additional callbacks pending to be sent for that transaction. If the parameter is false, it indicates that the callback process for the bulk transaction has been completed.

Hash

The Hash value used to verify that the notification was sent from Paywall. It is generated using the System Webhook Hash Key activated in the Paywall panel.

The key mentioned above may vary depending on the value of the HashKeyType parameter. A dynamic structure should be implemented.

HashFormat

The format type used to generate the hash value See: Hash Formats

HashKeyType

The type of key used in generating the hash value See: Key Types

Example Json:

{
    "Type": 1,
    "BulkPaymentId": 2881,
    "Payments": [
        {
            "PaymentId": 3705770,
            "Amount": 1.00,
            "UniqueCode": "E86FFB24-CCA4-4F8B-A3B5-BC6A328C0F3B",
            "MerchantUniqueCode": "9f23c7df-f798-4c52-b38a-0d7b52e76f8b",
            "CurrencyId": 1,
            "Installment": 1,
            "ActivityTypeId": 1,
            "ActivityStatusId": 5
        },
        {
            "PaymentId": 3705771,
            "Amount": 1.00,
            "UniqueCode": "56CBA995-1B4B-4B83-BFA1-056715F42B83",
            "MerchantUniqueCode": "d09d5ff2-ba8d-48bc-8a66-9c2ffd47e23b",
            "CurrencyId": 1,
            "Installment": 1,
            "ActivityTypeId": 1,
            "ActivityStatusId": 5
        },
        {
            "PaymentId": 3705772,
            "Amount": 1.00,
            "UniqueCode": "1FBC95B5-F811-4BCE-A216-F9B799F53E97",
            "MerchantUniqueCode": "5b10063c-f715-4644-bf59-dd85b0c59afe",
            "CurrencyId": 1,
            "Installment": 1,
            "ActivityTypeId": 1,
            "ActivityStatusId": 4
        },
        {
            "PaymentId": 3705773,
            "Amount": 1.00,
            "UniqueCode": "0F6B0BAA-FA66-4E62-8EE2-3AFACF3CEABE",
            "MerchantUniqueCode": "56d7bcb0-4434-4584-8586-3b86186d92bb",
            "CurrencyId": 1,
            "Installment": 1,
            "ActivityTypeId": 1,
            "ActivityStatusId": 4
        },
        {
            "PaymentId": 3705774,
            "Amount": 1.00,
            "UniqueCode": "4A6926AD-C340-4283-ADB8-0EDB57123213",
            "MerchantUniqueCode": "d7fdfbda-3173-48d4-8d12-8964867174f7",
            "CurrencyId": 1,
            "Installment": 1,
            "ActivityTypeId": 1,
            "ActivityStatusId": 5
        },
        {
            "PaymentId": 3705775,
            "Amount": 1.00,
            "UniqueCode": "77AC004E-E641-43B7-952B-F932EBCCF5F9",
            "MerchantUniqueCode": "d5ec3bd9-9596-49da-9d6a-519c2d75574c",
            "CurrencyId": 1,
            "Installment": 1,
            "ActivityTypeId": 1,
            "ActivityStatusId": 4
        },
        {
            "PaymentId": 3705776,
            "Amount": 1.00,
            "UniqueCode": "5BE6E448-E675-422D-8D73-1DF025D72660",
            "MerchantUniqueCode": "d3d3ad91-ebea-41b3-80dd-77977ffac2e6",
            "CurrencyId": 1,
            "Installment": 1,
            "ActivityTypeId": 1,
            "ActivityStatusId": 4
        }
    ],
    "ErrorMessage": "",
    "DateTime": "2025-04-03T23:53:33.018504+03:00",
    "CreatedAt": "2025-04-03T22:01:05.357",
    "FinishedAt": "2025-04-03T22:01:12.0185082+03:00",
    "DurationTime": 7.6615086,
    "Hash": "95126cbeba7efabdda705d24568f2f4edc17c986b1022603cff4c99bfc4b9a8b",
    "IsCompressed": true,
    "PageNumber": 1,
    "TotalPages": 1,
    "HasMorePages": false
}

Last updated