Webhook Payload Structure
The basic structure of a typical webhook payload is shown below:
• an Event
field describing the type of event
• a 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 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 Name | Description | Sample |
---|
Event Name | Description | Sample |
---|---|---|
Payment Successful | A successful payment initiated | { "Event": "PaymentSuccessful", "Data": { "Environment": "Test", "Reference": "LB-1389432211", "Amount": 90, "Currency": "GBP", "AppFee": 0, "Narration": "Payment For LB-1389432211", "PaymentStatus": "Successful", "ChannelType": "Card", "Metadata": null } } } } } |
Payment Failed | Payment initiated failed | { "Event": "PaymentSuccessful", "Data": { "Environment": "Test", "Reference": "LB-1389432211", "Amount": 90, "Currency": "GBP", "AppFee": 0, "Narration": "Payment For LB-1389432211", "PaymentStatus": "Failed", "ChannelType": "Card", "Metadata": null } } } } } |
Account Approved | An Account creation approved |
|
Account Rejected | An Account request was rejected |
|
Highlight important information in a panel like this one. To edit this panel's color or style, select one of the options in the menu.
0 Comments