3.4 - Webhooks

Payment Order Webhook

This webhook notifies the Payment Order Status.

{
  "PaymentOrder": {
    "PaymentOrderId": 15273,
    "PaymentOrderStatus": "Created",
    "TaxNumber": "43071723024",
    "PaymentDate": "2024-01-18T00:00:00",
    "PartnerId": 1057,
    "ReceiptUrl": "",
    "Identifier": "1a1560db-86af-4d41-9cb6-5a22dc43078c",
    "ReasonCode": null,
    "FileInId": null
  },
  "Method": "UpdatePaymentOrderStatus",
  "BusinessUnitId": 1642
}

{
  "PaymentOrder": {
    "PaymentOrderId": 15273,
    "PaymentOrderStatus": "Registered",
    "TaxNumber": "43071723024",
    "PaymentDate": "2024-01-18T00:00:00",
    "PartnerId": 1057,
    "ReceiptUrl": "",
    "Identifier": "1a1560db-86af-4d41-9cb6-5a22dc43078c",
    "ReasonCode": null,
    "FileInId": null
  },
  "Method": "UpdatePaymentOrderStatus",
  "BusinessUnitId": 1642
}

{
  "PaymentOrder": {
    "PaymentOrderId": 15273,
    "PaymentOrderStatus": "Settled",
    "TaxNumber": "43071723024",
    "PaymentDate": "2024-01-18T00:00:00",
    "PartnerId": 1057,
    "ReceiptUrl": "",
    "Identifier": "1a1560db-86af-4d41-9cb6-5a22dc43078c",
    "ReasonCode": null,
    "FileInId": null
  },
  "Method": "UpdatePaymentOrderStatus",
  "BusinessUnitId": 1642
}

{
  "PaymentOrder": {
    "PaymentOrderId": 15274,
    "PaymentOrderStatus": "Canceled",
    "TaxNumber": "43071723024",
    "PaymentDate": "2024-01-18T00:00:00",
    "PartnerId": 1057,
    "ReceiptUrl": "",
    "Identifier": "ee6439ed-fd80-40d5-915b-106812c9d6bc",
    "ReasonCode": "EXC0026 - Payment Order failed Risk process",
    "FileInId": null
  },
  "Method": "UpdatePaymentOrderStatus",
  "BusinessUnitId": 1642
}

{
  "PaymentOrder": {
    "PaymentOrderId": 277,
    "PaymentOrderStatus": "Error",
    "TaxNumber": "20282702091",
    "PaymentDate": "2022-06-06T00:00:00",
    "PartnerId": 30749,
    "ReceiptUrl": "",
    "Identifier": "7a8b29f5-e73d-4393-b028-62c185e7d9a-00047",
    "ReasonCode": null,
    "FileInId": null
	},
	"Method": "UpdatePaymentOrderStatus",
	"BusinessUnitId": 61799
}

Description:

Parameters	Description	Type	Comments
PaymentOrderId	Payment order identification	LONG (NUMBER)	None
PaymentOrderStatus	Operation status	STRING (TEXT)	None
TaxNumber	Beneficiary's TaxNumber	STRING (TEXT)	None
PaymentDate	Date of operation's payment	STRING (TEXT)	None
ReceiptUrl	Transaction voucher URL	STRING (TEXT)	None
Identifier	External identifier applied by the customer in the emission	STRING (TEXT)	None
Method	API Method	STRING (TEXT)	None
BusinessUnitId	Business Unit ID Provided by Fitbank	LONG (NUMBER)	None
ReasonCode	Reason for canceling the payment order	STRING (TEXT)	If the payment order is not canceled it will appear as null
FileInId	Batch Identifier	STRING (TEXT)

Status

Upon receiving the Payment Order, the customer is then notified as to its status:

Status	Type	Description
0	Created	Payment Order was Created
2	Settled	Payment concluded
3	Canceled	Cancel reason description
4	Registered	Payment order was registered after transaction validations
6	Error	Process failed

Beneficiary Webhook

This webhook notifies the Beneficiary Status.

{
  "Beneficiary": {
  "Name": "João Victor Montenegro Rocha 00042",
  "Status": "Denied",
  "TaxNumber": "20282702091",
  "Phone": "+5585997784745",
  "Mail": "[email protected]",
  "Description": "Beneficiary failed KYC process",
  "Reason": "Identified that the Beneficiary is on the internal list"   
  	},
  "Method": "UpdateBeneficiaryStatus",
  "BusinessUnitId": 61799
}

{
  "Beneficiary": {
  "Name": "João Victor Montenegro Rocha 00042",
  "Status": "Approved",
  "TaxNumber": "20282702091",
  "Phone": "+5585997784745",
  "Mail": "[email protected]",
  "Description": null,
  "Reason": null
  },
  "Method": "UpdateBeneficiaryStatus",
  "BusinessUnitId": 61799
}

{
  "Beneficiary": {
  "Name": "João Victor Montenegro Rocha 00042",
  "Status": "Pending",
  "TaxNumber": "20282702091",
  "Phone": "+5585997784745",
  "Mail": "[email protected]",
  "Description": null,
  "Reason": null
  },
  "Method": "UpdateBeneficiaryStatus",
  "BusinessUnitId": 61799
}

{
  "Beneficiary": {
  "Name": "João Victor Montenegro Rocha 00042",
  "Status": "Created",
  "TaxNumber": "20282702091",
  "Phone": "+5585997784745",
  "Mail": "[email protected]",
  "Description": null,
  "Reason": null
  },
  "Method": "UpdateBeneficiaryStatus",
  "BusinessUnitId": 61799
}

Parameters	Description	Type	Comments
Method	API Method	STRING (TEXT)	None
BusinessUnitId	Business Unit ID Provided by Fitbank	LONG (NUMBER)	None
Beneficiary	Beneficiary's Information	ENTITY	None
Name	Beneficiary's name	STRING (TEXT)	None
Status	Beneficiary Status Indication	LONG (NUMBER)	Created = 0 Pending = 1 Approved = 2 Denied = 3
TaxNumber	User's Social Security Number	STRING (TEXT)	None
Phone	Beneficiary's phone	STRING (TEXT)	None
Mail	Beneficiary's mail	STRING (TEXT)	None
Description	Beneficiary's reason for denial	STRING (TEXT)	If the Beneficiary is not Denied it will appear as null
Reason	Reason why the beneficiary was denied	STRING	None
Message	Default message asking for Beneficiary Data	STRING (TEXT)	If the Beneficiary is not Qualified it will appear as null
DataRequiredList	Resquested Data List	STRING (TEXT)	If the Beneficiary is not Qualified it will appear as null

Maximum amount for payment reached

This webhook notifies payment orders with amounts above normal

{
  "Message": "There was a payment order exceeding the parameterized value limit of 'R$1000,00'",
  "DocumentNumberId": 79,
  "BeneficiaryName": "joao beneficiary",
  "BeneficiaryTaxNumber": "74311850069",
  "Method": "UpdateLimitPaymentOrder",
  "BusinessUnitId": 61799
}

Parameters	Description	Type	Comments
Message	Notification about any generated payment order that exceeds the configured maximum amount	STRING (TEXT)	None
DocumentNumberId	Operation identifier generated after the successfull emission	LONG (NUMBER)	None
BeneficiaryName	Beneficiary's name	STRING (TEXT)	None
BeneficiaryTaxNumber	Beneficiary's Taxnumber	LONG (NUMBER)	None
Method	API Method	STRING (TEXT)	None
BusinessUnitId	Business Unit ID Provided by Fitbank	LONG (NUMBER)	None

Response Webhook

To confirm receipt of the webhook, return us the following json:

{
"Success": true,
"Message": "Operation successfully completed."
}