6 - Webhook

TopUp Webhook

Overview

The TopUp webhook allows clients to receive real-time notifications regarding the status of TopUp transactions. This webhook is designed to streamline communication between the Fitbank platform and its partners, providing critical updates about the transaction process. The webhook will send a JSON payload containing detailed transaction information whenever a significant event occurs.

Webhook URL

The webhook will send an HTTP POST request to the URL specified by the partner during the integration setup.

JSON Payload Structure

Here is an example of the JSON payload that will be sent by the webhook:


{
    "Method": "PurchaseTopUpNote",
    "BusinessUnitId": 66,
    "Partner": 66,
    "Status": "Canceled",
    "DocumentNumber": "588",
    "Identifier": "0000000000",
    "EntryId": 8385725,
    "TotalValue": 0.0,
    "PaymentDate": "2024-08-26T15:08:23.48",
    "FineInterest": 0.0,
    "DiscountValue": 0.0,
    "IofValue": 0.0,
    "PaidValue": 30.00,
    "OtherValues": 0.0,
    "CreditDate": "2024-08-26T15:08:23.48",
    "OccurrenceDate": null,
    "BankCode": null,
    "BankBranch": null,
    "BankAccount": null,
    "BankAccountDigit": null,
    "ReturnCode": "7",
    "ReturnMessage": null,
    "ProductKey": "CLARO11-3000-187000000060",
    "ProductSubType": "11",
    "ProductType": "Phone",
    "URL": "2024-08-26/jxzoth3c.pdf",
    "ErrorMessage": null
}

Parameters Description

PARAMETER	TYPE	DESCRIPTION
`Method`	`string`	Mandatory. Name of the method being invoked.
`BusinessUnitId`	`long`	Mandatory. Business Unit ID provided by Fitbank.
`Partner`	`long`	Mandatory. Identifier assigned by Fitbank.
`Status`	`enum`	Mandatory. Status of the transaction.
`DocumentNumber`	`long`	Mandatory. Unique identifier for the recharge.
`Identifier`	`string`	Mandatory. Unique identifier for the transaction.
`EntryId`	`long`	Mandatory. Unique identifier for the entry.
`TotalValue`	`decimal`	Mandatory. Total amount of the transaction.
`PaymentDate`	`datetime`	Mandatory. Date and time when payment was made.
`FineInterest`	`decimal`	Mandatory. Penalty for late payment.
`DiscountValue`	`decimal`	Mandatory. Applied discount value.
`IofValue`	`decimal`	Mandatory. IOF (Tax on Financial Operations) value.
`PaidValue`	`decimal`	Mandatory. Amount paid by the user.
`OtherValues`	`decimal`	Mandatory. Additional values related to the transaction.
`CreditDate`	`datetime`	Mandatory. Date when the credit was applied.
`OccurrenceDate`	`datetime`	Mandatory. Date of the occurrence, if applicable.
`BankCode`	`string`	Code of the bank involved in the transaction.
`BankBranch`	`string`	Number of the bank branch.
`BankAccount`	`string`	Account number associated with the transaction.
`BankAccountDigit`	`string`	Verifying digit of the bank account.
`ReturnCode`	`string`	Code indicating the return status.
`ReturnMessage`	`string`	Message providing additional information on the return status.
`ProductKey`	`string`	Key identifying the specific product for recharge.
`ProductSubType`	`string`	Sub-type identifier, such as the area code for the region.
`ProductType`	`string`	Type of product (e.g., Phone).
`URL`	`string`	URL pointing to the proof of transaction.
`ErrorMessage`	`string`	Message detailing any error that occurred.

Transaction Status Codes

Status Code	Description
`CanBeRegister = 1`	Transaction can be registered.
`Registered = 3`	Transaction has been registered.
`Settlement = 5`	Transaction has been settled.
`Canceled = 7`	Transaction has been canceled.
`Error = 8`	An error occurred in the transaction.