Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
bgColor#79E2F2

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" }

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#79E2F2

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 was madeinitiated

Code Block
{
  "eventEvent": "paymentsuccessfulPaymentSuccessful",
  "dataData": {
    "environmentEnvironment": test"Test",
    "referenceReference": "LinksLB-6166264146291389432211",
    "leatherbackReferenceAmount": "PeterEkene/FLW270177170"90,
    "tenantIdCurrency": "9c0864f6-c963-48fa-9b4e-08da95b2293fGBP",
    "amountAppFee": 1000,
    "currencyNarration": "NGNPayment For LB-1389432211",
    "appFeePaymentStatus": 100"Successful",
    "ProcessorResponseChannelType": "successfulCard",
    "narrationMetadata": "personal expense",
    "processor_response": "Approved by Financial Institution", null
  }
}
	}
  }
} 

Payment Failed

Payment initiated failed

Code Block
{
  "Event": "PaymentSuccessful",
  "Data": {
    "channelTypeEnvironment": "CardTest",
    "ipReference": "LB-1389432211",
"197.210.64.96"    "Amount": 90,
    "narrationCurrency": "CARD TransactionGBP",
    "AppFee": 0,
    "paymentStatusNarration": "successfulPayment For LB-1389432211",
    "metadataPaymentStatus" : {
	"keyFailed",
:    "valueChannelType",: 	"key1Card",
: { 	  "childKeyMetadata": null
:  "childValue"}
	}
	}
  }
} 

Payment Failed

Payment initiated failed

 

Account Approved

An Account creation approved

 

Account Rejected

An Account request was rejected

 

...

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@1256f
sortmodified
showSpacefalse
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "LAD"
labelskb-how-to-article