Webhook Events

Owned by Leatherback, created
Last updated: Aug 14, 2023
2 min read

Webhook Payload Structure

The basic structure of a typical webhook payload is shown below:

  • Event field describing the type of event
    Data object. The contents of this object will vary depending on the event, but typically it will contain details of the event, including:

  • Reference id: containing the ID of the transaction

  • Amount: describing transaction amount

  • Currency: currency in which transaction was initiated in

  • Fee: describes applicable charges to be deducted from the Transaction Amount

  • Narration: Transaction narration
    Status: describing the status of the transaction

  • Channel Type: describing channel which transaction originated from { "Card", "Transfer", "Account" }

Below shows the list of the events currently raised on the Leatherback platform. We would update as we onboard on more events in the nearest future

 

Event Category

Operation

Description

Sample

Event Category

Operation

Description

Sample

Collections

Payment Link

This webhook structure shows a typical payment link event. This may return successful/failed

{ "Event": "PaymentSuccessful", "Data": { "Environment": "Live", "Reference": "LUJSRCKLBR9P5XDDPG", "AmountPaid": 300, "Amount": 300, "Currency": "NGN", "AppFee": 0, "Narration": "Payment For ", "PaymentStatus": "Successful", "ChannelType": "Card", "RequestSource": "PaymentLink", "Metadata": { "alias": "y3dumte" } } }

 

 

Collections

Payment

This is a typical webhook payload for Payments (It may return as success or failed transaction

{ "Event": "PaymentSuccessful", "Data": { "Environment": "Live", "Reference": "LUJSRCKLBR9P5XDDPG", "AmountPaid": 300, "Amount": 300, "Currency": "NGN", "AppFee": 0, "Narration": "Payment For ", "PaymentStatus": "Successful", "ChannelType": "Card", "RequestSource": "API", "Metadata": null } }

 

Disbursements

SendR

This is a typical SendR Webhook Payload. The event may be successful or failed

{     "Event": "PaymentSuccessful",     "Data": {         "Reference": "P123456789",         "WebhookEventType": "PayOutFundTransferCompleted",         "CreditAccountName": "John Doe",         "CreditAccountNumber": "111111111",         "DebitAccountName": "Jane Doe",         "DebitAccountNumber": "222222222",         "Amount": 1000.00,         "Currency": "USD",         "Mode": "<string>",         "TransactionStatus": "Success",         "Message": "<string>"     } }

 

 

Disbursements

Account

This is a typical webhook payload structure for Account/ Maintenance operations.

 

 

Disbursements

Payout

This is a typical webhook payload for Payout operation.

 

 Related articles

Leatherback 2024