Webhook Events

Bulk payment creation is asynchronous. Subscribe to these events to learn when individual items fail and when the bulk run completes.

bulkPayments.failed

Occurs when a payment in a Bulk Payment failed.

Example bulkPayments.failed payload:

{
  "data": [
    {
      "id": "1",
      "type": "bulkPayments.failed",
      "attributes": {
        "createdAt": "2021-01-02T13:38:28.223Z",
        "tags": {
          "tag": "value"
        },
        "index": "2",
        "error": "{\"title\":\"User is not allowed to create a payment\",\"status\":\"403\"}",
        "idempotencyKey": "1 2"
      },
      "relationships": {
        "bulkPayments": {
          "data": {
            "id": "1",
            "type": "bulkPayments"
          }
        }
      }
    }
  ]
}

---

bulkPayments.finished

Occurs when a Bulk Payment is finished.

Example bulkPayments.finished payload:

{
  "data": [
    {
      "id": "1",
      "type": "bulkPayments.finished",
      "attributes": {
        "createdAt": "2021-01-02T13:38:28.223Z"
      },
      "relationships": {
        "bulkPayments": {
          "data": {
            "id": "1",
            "type": "bulkPayments"
          }
        }
      }
    }
  ]
}