BYbyaccrue
Webhook Topics

PaymentCreated

postWebhookpaymentCreated

Payload

idstring uuid required

Unique identifier for the object.

type'WebhookEvent' required

Example payload

{
  "attributes": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "walletId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "included": [
    {
      "attributes": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "status": "Sent",
        "amount": 9999,
        "channel": "ORG-1",
        "reference": "MERCHANT-GENERATED-TOKEN",
        "disbursement": [
          {
            "counterpartyId": "9f755746-13cb-4d0b-81f2-3b4f1b44f6d8",
            "amount": 800,
            "fee": 10,
            "remit": true
          },
          {
            "counterpartyId": "4cf95060-dd01-42ac-9020-8ca42004920d",
            "amount": 200,
            "fee": 5,
            "remit": true
          }
        ],
        "charges": {
          "fee": {
            "amount": 150,
            "type": "pay_by_wallet"
          },
          "rewards": 1000
        },
        "deductions": {
          "rewards": 1000,
          "fees": 150
        }
      },
      "links": {
        "virtualDebitCard": "https://secure-api.accruesavings.com/api/v1/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08/card"
      }
    }
  ]
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.