This section describes how to create transaction webhooks for the transactional notifications to be captured at their end. This callback is to be used to capture the transaction notifications made via the APIs like load and unload.
Type POST
API / webhooks headers
Parameter | Type | Parameter Requirement | Description |
|---|---|---|---|
X-Consumer-Custom-ID | string (15) | Mandatory | This is the unique key to be shared with the client by Wibmo for the API environment exposure. |
clientId | string (15) | Mandatory | This is the Unique ID for the client to be shared by Wibmo. |
bankId | Numeric (4) | Mandatory | Unique ID to identify the issuer bank. Wibmo to share. |
entityId | Numeric (4) | Optional | Child corporate/branch entity ID under the client. If not passed, it will default to the client's parent branch. |
Request Parameters
Parameter | Type | Parameter Requirement | Description | Sample value |
|---|---|---|---|---|
customerId | string (50) | Mandatory | Unique customer ID for the customer in the Prepaid and client system. | HRM0054454 |
urn | string (20) | Mandatory | Unique reference number for the customer. | 10000333 |
prepaidTransactionId | string (50) | Mandatory | Unique transaction ID at Prepaid. | 128989999921 |
transactionType | string (10) | Mandatory | Type of transaction. | CR/DR |
transactionNarration | string (100) | Optional | Transaction narration, if any. | Test Transaction |
transactionAmount | Long | Mandatory | Amount in implied decimals. E.g. INR100 will be 10000 | 10000 |
transactionDateTime | string (15) | Mandatory | Timestamps in YYYYMMDDHHMMSS with time in 24-hour format. | 20240629215049 |
transactionStatus | string (10) | Mandatory | Status of the transaction. | Success |
additionalInfo | string (100) | Optional | Additional info, if any. | Demo transaction |
transactionClosingBalance | Long | Optional | Closing balance of the wallet. | 2693300 |
implId | string (20) | Optional | IMPL ID that is applicable to the transaction. | O|70161 |
implType | string (20) | Optional | IMPL ID type | P2M1_W2A_O_UPI |
Sample request
{
"customerId": "000000000169",
"urn": "10000333",
"prepaidTransactionId": "1596725",
"transactionType": "DR",
"transactionNarration": "Test transaction",
"transactionAmount": 5000,
"transactionDateTime": "20240629215049",
"transactionStatus": "SUCCESS",
"additionalInfo": "Demo transaction",
"transactionClosingBalance": 2693300,
"implId": "O|70161",
"implType": "P2M1_W2A_O_UPI"
}Response codes
Response Only API acknowledgement will be required for this webhook notification.
| HTTP Status Code | HTTP Status Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
| 503 | Service Unavailable |