HomeAPI Reference
Guides
DashboardBlogTalk to Us

Payment Webhook Events

Suggest Edits

📘

To receive real-time payment updates, configure and listen to webhooks in your organization settings.

Once payment is made to any account in your organization on Anchor, we will send you two events: a payment.received and a payment.settled event.

EventDescription
payment.receivedThis event is generated when payment is received into a Virtual Account.
payment.settledThis is generated when payment received into a virtual account is settled into a deposit account. Your customer receives no value until the payment is settled. It's good to listen to both events as it helps audit and investigation.

Below are sample payloads for payment.received and payment.settled events

{
  "data": {
    "id": "1699009058767266-anc_et",
    "type": "payment.received",
    "attributes": {
      "createdAt": "2023-11-03T10:57:39",
      "payment": {
        "paymentId": "169900905874731-anc_py",
        "type": "BankTransfer",
        "paymentReference": "1d7e18f2-0632-4c97-8397-697fba3f6465",
        "currency": "NGN",
        "amount": 1000000,
        "fee": 0,
        "createdAt": "2023-11-03T10:57:38.748582",
        "paidAt": "2023-11-03T10:57:38.746161",
        "narration": "Test transaction",
        "counterParty": {
          "accountNumber": "1234567890",
          "accountName": "Precious",
          "bank": {
            "name": "STANBIC IBTC BANK"
          }
        },
        "virtualNuban": {
          "accountNumber": "8939661438",
          "accountId": "169792321695657-anc_va",
          "accountName": "Great Business",
          "default": false
        },
        "settlementAccount": {
          "accountId": "16922123768364-anc_acc",
          "accountName": null,
          "accountNumber": null,
          "currency": null,
          "type": null,
          "status": null,
          "bank": null,
          "customer": null,
          "createdAt": null,
          "metadata": null,
          "bankName": null,
          "virtualNubans": null,
          "frozen": false,
          "freezeReason": null,
          "freezeDescription": null,
          "subAccounts": null,
          "provider": null
        }
      }
    }
  }
}

{
  "data": {
    "id": "1699009061424267-anc_et",
    "type": "payment.settled",
    "attributes": {
      "createdAt": "2023-11-03T10:57:41",
      "payment": {
        "paymentId": "169900905874731-anc_py",
        "type": "BankTransfer",
        "paymentReference": "1d7e18f2-0632-4c97-8397-697fba3f6465",
        "currency": "NGN",
        "amount": 1000000,
        "fee": 0,
        "createdAt": "2023-11-03T10:57:39",
        "paidAt": "2023-11-03T10:57:39",
        "narration": "Test transaction",
        "counterParty": {
          "accountNumber": "1234567890",
          "accountName": "Precious",
          "bank": {
            "name": "STANBIC IBTC BANK"
          }
        },
        "virtualNuban": {
          "accountNumber": "8939661438",
          "accountId": "169792321695657-anc_va",
          "accountName": "Great Business",
          "default": false
        },
        "settlementAccount": {
          "accountId": "16922123768364-anc_acc",
          "accountName": null,
          "accountNumber": null,
          "currency": null,
          "type": null,
          "status": null,
          "bank": null,
          "customer": null,
          "createdAt": null,
          "metadata": null,
          "bankName": null,
          "virtualNubans": null,
          "frozen": false,
          "freezeReason": null,
          "freezeDescription": null,
          "subAccounts": null,
          "provider": null
        },
        "settlements": [
          {
            "settlementId": "169900906038363-anc_set",
            "amount": 0,
            "settledAmount": 0,
            "status": null,
            "payment": null,
            "anchorCollectionFee": null,
            "customerFee": null
          }
        ]
      }
    }
  }
}

Updated 22 days ago