Webhooks Notifications#

Payment Notifications#

To receive a payment status notification (i.e., payment settlement or cancellation confirmation), you need to first configure the webhook URL in your Console.

See below the flow of a notification:

And here is an example of a notification payload:

{
    "id": 104574372,
    "paymentKey": "134D946015A08C9",
    "partnerUniqueId": "668ecbaff060e8001162eef6",
    "statusId": "2",
    "amount": 19.50,
    "operationId": "O005B134D946015E4CF0",
    "methods": [
        {
            "methodType": "D",
            "status": "2",
            "methodId": 0,
            "operationId": "O005B134D946015E4CF000",
            "additionalInfo": {
                "EndToEndId": "E60701190202407101759DY5BQ4HFISM"
            },
            "operationAmount": 19.50
        }
    ],
    "items": [
        {
            "paymentItemId": 0,
            "productID": 1,
            "productDescription": "841",
            "amount": 19.500000,
            "quantity": 1,
            "categoryID": 1,
            "categoryName": "Pedido",
            "data": {
                "ProductID": 1,
                "CategoryID": 1,
                "CategoryName": "Pedido",
                "DetailUniqueID": "668ecbaff060e8001162eef6",
                "ExternalMerchantId": "65677b704f42a50019188852",
                "ProductDescription": "841"
            }
        }
    ]
}

Parameters description:

Property	Description
ID	The ID of the notification
paymentKey	The unique transaction ID generated by Tuna
partnerUniqueId	The ID used by the partner to identify the transaction
statusId	The new status of the transaction
amount	The full amount of the transaction
operationId	The ID of the operation (informed, e.g., in a cancellation request)
methods	The list of payment methods used for this transaction
items	The list of payment items

See more details about the properties in the response object of the endpoint api/Payment/Init/.