On every payment confirmation we get from the payment provider, we send the following to your webhook with us. First lets define the fields
Field | Description |
---|---|
status | This is the status of the payment. this can be success or failed or refunded in the case of payment refunds |
clientId | This is your clientId |
amount | This is the amount of the transaction in kobo |
customerBearsCharge | This defines if the provider charge was added to the amount the user was to pay |
charge | This is the charge the customer paid |
reference | This is the 6thbridge generated reference for this transaction |
externalReference | This is the reference sent to us by you when initializing the transaction |
provider | This is the provider used for this transaction |
channel | This is the channel for this transaction. This can be card or virtual-bank-account |
user | This is a user object containing at least one of email, phone number or name |
{
"event": "payment.completed",
"clientId": "{{client-id}}",
"data": {
"status": "success",
"charge": false,
"reference": "amstel_14b70c33-1fc1-4c84-8ed6-01ef06d72aa7_1643938124",
"provider": "flutterwave",
"amount": 20000,
"user": {
"email": "[email protected]",
"phoneNumber": "234703xxxxxxx",
"name": "Customer name"
},
"webhook": "https://webhook.site/a8477a0b-43fd-445a-a8ed-78add3145827",
"clientId": "amstel",
"userId": "61f594039578835b1a235643",
"externalReference": "14b70c33-1fc1-4c84-8ed6-01ef06d72aa7",
"integrationId": "61fc800f93a2fb93e2c03eed",
"integrationLogId": "61fc814c93a2fb93e2c03efb",
"paymentCard": {
"authorizationCode": "AUTH_rw1fald4ah",
"last4Pan": "4081",
"cardType": "visa ",
"bank": "TEST BANK",
"countryCode": "NG",
"provider": "flutterwave",
"userId": "61ff6a10f1e2492aab125bed",
"createdAt": "2022-02-06T07:16:12.084Z",
"updatedAt": "2022-02-06T07:16:12.084Z",
"id": "61ff75bcc78e902f83319251"
},
"channel": "virtual-bank-account",
"createdAt": "2022-02-04T01:28:44.879Z",
"updatedAt": "2022-02-04T01:38:03.030Z",
"providersReference": "574848733",
"id": "61fc814c1c44d195827ea4d0"
}
}