| Panel |
|---|
|
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" }
| Panel |
|---|
| panelIconId | atlassian-info |
|---|
| panelIcon | :info: |
|---|
| bgColor | #FFC400 |
|---|
|
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 |
NameCategory | Operation | Description | Sample |
|---|
Event Name | Description | Sample |
|---|
Payment Successful | A successful payment was made | code Collections | Payment Link | This webhook structure shows a typical payment link event. This may return successful/failed | | Code Block |
|---|
| {
"eventEvent": "paymentsuccessfulPaymentSuccessful",
"dataData": {
"environmentEnvironment": test"Live",
"referenceReference": "Links-616626414629LUJSRCKLBR9P5XDDPG",
"leatherbackReferenceAmountPaid": "PeterEkene/FLW270177170"300,
"Amount": 300,
"tenantIdCurrency": "9c0864f6-c963-48fa-9b4e-08da95b2293fNGN",
"amountAppFee": 0,
"Narration": 100"Payment For ",
"currencyPaymentStatus": "NGNSuccessful",
"appFeeChannelType": 100"Card",
"ProcessorResponseRequestSource": "successfulPaymentLink",
"Metadata": {
"narrationalias": "personal expense","y3dumte"
}
}
} |
|
|
Collections | Payment | This is a typical webhook payload for Payments (It may return as success or failed transaction | | Code Block |
|---|
| {
"Event": "PaymentSuccessful",
"Data": {
"processor_responseEnvironment": "Approved by Financial Institution"Live",
"Reference": "LUJSRCKLBR9P5XDDPG",
"channelTypeAmountPaid": 300,
"CardAmount": 300,
"ipCurrency": "197.210.64.96"NGN",
"AppFee": 0,
"narrationNarration": "CARD Transaction Payment For ",
"PaymentStatus": "Successful",
"paymentStatusChannelType": "successfulCard",
"metadata" : {
"key" : "value",
"key1" : {
"childKey" : "childValue"
}
}
}
}
|
|
Payment Failed | Payment initiated failed | |
Account Approved | An Account creation approved | |
Account Rejected | An Account request was rejected | |
...
RequestSource": "API",
"Metadata": null
}
} |
|
|
Disbursements | SendR | This is a typical SendR Webhook Payload. The event may be successful or failed | | Code Block |
|---|
| {
"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. | | Code Block |
|---|
| {
"Event": "<string>",
"Data": {
"AccountName": "John Doe",
"AccountNumber": "123456789",
"AuthorizationStatus": "Processing",
"AuthorizationMessage": "<string>",
"CustomerName": "John Doe",
"CustomerId": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
"TenantReference": "<string>",
"WebhookEventType": "<string>"
}
} |
|
|
Disbursements | Payout | This is a typical webhook payload for Payout operation. | | Code Block |
|---|
| {
"Event": "<string>",
"Data": {
"PaymentReference": "123456789",
"TenantReference": "987654321",
"FundsTransferStatus": "TransactionSettled",
"Amount": 1000.00,
"CurrencyCode": "USD",
"BeneficiaryAccount": "1000.00",
"BeneficiaryName": "John Doe",
"BeneficiaryEmail": "johndoe@example.com",
"BookDate": "2023-08-07T10:16:33Z",
"ValueDate": "2023-08-08T10:16:33Z",
"Service": "Payout",
"EnvironmentType": "Live",
"TenantId": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
"Mode": "<string>"
}
} |
|
\uD83D\uDCCB Related articles
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| spaces | com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@1256f |
|---|
| showSpace | false |
|---|
| sort | modified |
|---|
| showSpacetype | falsepage |
|---|
| reverse | true | type | page
|---|
| labels | kb-how-to-article |
|---|
| cql | label = "kb-how-to-article" and type = "page" and space = "LAD" | labels | kb-how-to-article |
|---|
|