Receiving Funds to a PayID

Webhooks are used to notify your application of changes to the status of Agreements, Payment Requests, Credits, Debits, etc as they are processed through the system.

By subscribing to our webhook events you can monitor the status of each transaction, and then trigger the appropriate next steps. While making Payments and Payment Requests, webhooks allow you to check the status of the transactions.

This article gives an overview of the webhook events you would expect to receive for the following scenarios.

Receiving Funds through PayID

When you receive funds through a PayId, the webhooks that are fired are as follows:

payment_request.approved
credit.scheduled
creditor_debit.scheduled
creditor_debit.matured
creditor_debit.processing
creditor_debit.clearing
creditor_debit.cleared
credit.matured
credit.processing
credit.clearing
credit.cleared

{
  "data": [
    {
      "ref": "C.34jt",
      "type": "credit",
      "amount": 2500,
      "status": "cleared",
      "bank_ref": "CT.2kee",
      "category": "payout",
      "channels": [
        "direct_entry"
      ],
        "metadata": {
        "npp_alias_type": "/EMAL",
        "npp_alias_value": "[email protected]",
        "npp_debtor_name": "Jack Karlson",
        "npp_debtor_legal_name": "Jack Karlson",
        "npp_payment_reference": "Test Payment",
        "npp_debtor_branch_code": "014209",
        "npp_payment_description": "Test Payment",
        "npp_debtor_account_number": "12345678",
        "npp_payment_transaction_id": "SPPYAU22XXXN20210223000000000534600"
      },
      "cleared_at": "2020-11-20T01:39:52Z",
      "created_at": "2020-11-20T01:34:38Z",
      "matures_at": "2020-11-20T01:37:54Z",
      "parent_ref": "PR.p4n",
      "party_name": "Jack Karlson",
      "description": "PayID Payment received",
      "party_bank_ref": "DT.2wsf",
      "party_nickname": null,
      "bank_account_id": "1d0eac6b-a81d-4bad-ab9e-8006b16aa185",
      "current_channel": "xxx",
      "party_contact_id": "a7565a92-a570-4ad1-b5c9-e6763e8af42e",
      "status_changed_at": "2020-11-20T01:39:52Z"
    }
  ],
  "event": {
    "at": "2020-11-20T01:39:52Z",
    "who": {
      "account_id": "1b1985dc-9a47-410c-bfd7-d987d72a1197",
      "account_type": "Account",
      "bank_account_id": "1d0eac6b-a81d-4bad-ab9e-8006b16aa185",
      "bank_account_type": "BankAccount"
    },
    "type": "credit.cleared"
  }
}