Webhook

PaymentRecalled Webhook

​

Webhook endpoint for receiving recalled payment events.

This endpoint receives webhooks for negative allocation based on funds recalled from payment. A POST request is sent to the specified callback URL.

Body·
required
application/json
  • callback_id
    Type: string
    required

    Unique identifier generated for each callback.

  • callback_timestamp
    Type: stringFormat: date-time
    required

    An ISO 8601 compliant timestamp for the callback.

  • callback_type
    const:  
    PaymentRecalled
    required

    The type of callback. Value is "PaymentRecalled" for payment recall events.

  • payment_recall
    Type: object ·
    required
Responses
  • application/json
Request Example for postPaymentRecalled
{
  "callback_id": "9ec1c43a-0272-46f0-b4c2-9fe53acdb861",
  "callback_timestamp": "2015-12-04T13:28:51.706784Z",
  "callback_type": "PaymentRecalled",
  "payment_recall": {
    "incoming_payment_id": "9d950c80-6457-4e89-ae6b-2be2df876789",
    "executed_on": "2024-02-02",
    "message": "Refund Request By End Customer",
    "payment_schema": {
      "code": "SEPA_DIRECT_DEBIT"
    },
    "total_amount": 25.78,
    "fee": 3.2,
    "payables": [
      {
        "type": "Billogram",
        "billogram": {
          "id": "ttEktsQT",
          "remaining_amount": 12,
          "state": "Overdue",
          "invoice_no": 1001,
          "event": {
            "type": "PaymentRecalled",
            "created_at": "2025-01-28 16:33:59",
            "event_uuid": "0bfec254-d7cc-4775-8fea-ae5c4c2a843b",
            "data": {
              "recalled_amount": 12,
              "related_payment_event_uuids": [
                "a5d17b76-eeb5-483f-9e65-9e245bdff532",
                "18bc4eb0-4d17-4493-aa03-5eb2fe2c7040"
              ]
            }
          }
        }
      },
      {
        "type": "Billogram",
        "billogram": {
          "id": "LrEkgQqa",
          "remaining_amount": 0,
          "state": "Unpaid",
          "invoice_no": 1002,
          "event": {
            "type": "PaymentRecalled",
            "created_at": "2025-01-28 16:33:59",
            "event_uuid": "f691392a-db63-47c7-b5fd-5535e00a3a50",
            "data": {
              "recalled_amount": 13.78,
              "related_payment_event_uuids": [
                "7361432b-887f-467d-9f2e-4f62cab992cb",
                "94276d6a-9aa2-45f6-ab7e-651e70c642af"
              ]
            }
          }
        }
      }
    ],
    "raw_details": {
      "payment_schema": {
        "sepa": {
          "r_transaction": {
            "code": "MD06",
            "message": "Refund Request By End Customer"
          }
        }
      }
    }
  }
}

{
  "status": "OK"
}

Webhook received successfully.

Required: Your endpoint must return HTTP 200 OK for the webhook to be considered successfully delivered. Any other status code will cause the webhook to be marked as failed and retried.