Batch Payment Sent With Failures

Triggered when a BatchPaymentSession has been accepted by the bank and some individual payments have left the account while others have failed.

Webhooks are configured through the Banked console and are the recommended method for obtaining a batch payments status (as opposed to polling the batch payment status via our API).

📘

This signifies that the batch payment has been accepted by the bank and some of the individual payments has successfully left the nominated bank account.

🚧

This webhook is only available for Batch payments created with an account connected to the Banked console.

An example sent webhook payload

{
  "created_at": "2020-04-02 10:11:22 UTC",
  "currency": "GBP",
  "error_url": "https://example.com/failure",
  "id": "1b90e886-142e-4e97-8c20-828ac6ec6b93",
  "live": false,
  "payees": [
    {
      "account_identifier":"01020312345678",
      "identifier_type": "SortCodeAccountNumber",
      "amount": 1,
      "amount_formatted": "£0.01",
      "client_id": "f799a3ed422e",
      "end_to_end_id": "BNKD-o0oBNXkTJtvxu6To",
      "name": "Test 1",
      "reference": "EeqYiL bnkdbAq",
      "state": "sent"
    },
    {
      "account_identifier":"01020312345678",
      "identifier_type": "SortCodeAccountNumber",
      "amount": 1,
      "client_id": "f799a3ed422e",
      "end_to_end_id": "BNKD-o0oBNXkTJtvxu6To",
      "name": "Test 1",
      "reference": "EeqYiL 12345",
      "state": "failed"
    },
  ],
  "provider_id": "36293c8a-b118-472b-bc13-6aa53291134b",
  "state": "sent_with_failures",
  "success_url": "https://example.com/success",
  "url": "https://mockbank.dev/auth",
  "webhook_event": "batch_payment_sent_with_failures",
  "webook_type": "batch_payment_session"
}

Did this page help you?