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:

ParametersDescriptionTypeComments
PaymentOrderIdPayment order identificationLONG (NUMBER)None
PaymentOrderStatusOperation statusSTRING (TEXT)None
TaxNumberTaxnumber of the account issuing the payment orderSTRING (TEXT)None
PaymentDateDate of operation's paymentSTRING (TEXT)None
ReceiptUrlTransaction voucher URLSTRING (TEXT)None
IdentifierExternal identifier applied by the customer in the emissionSTRING (TEXT)None
MethodAPI MethodSTRING (TEXT)None
BusinessUnitIdBusiness Unit ID Provided by FitbankLONG (NUMBER)None
ReasonCodeReason for canceling the payment orderSTRING (TEXT)If the payment order is not canceled it will appear as null
FileInIdBatch IdentifierSTRING (TEXT)

Status

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

StatusTypeDescription
0CreatedPayment Order was Created
2SettledPayment concluded
3CanceledCancel reason description
4RegisteredPayment order was registered after transaction validations
6ErrorProcess 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
}
ParametersDescriptionTypeComments
MethodAPI MethodSTRING (TEXT)None
BusinessUnitIdBusiness Unit ID Provided by FitbankLONG (NUMBER)None
BeneficiaryBeneficiary's InformationENTITYNone
NameBeneficiary's nameSTRING (TEXT)None
StatusBeneficiary Status IndicationLONG (NUMBER)Created = 0
Pending = 1
Approved = 2
Denied = 3
TaxNumberUser's Social Security Number STRING (TEXT)None
PhoneBeneficiary's phoneSTRING (TEXT)None
MailBeneficiary's mailSTRING (TEXT)None
DescriptionBeneficiary's reason for denialSTRING (TEXT)If the Beneficiary is not Denied it will appear as null
ReasonReason why the beneficiary was deniedSTRINGNone
MessageDefault message asking for Beneficiary DataSTRING (TEXT)If the Beneficiary is not Qualified it will appear as null
DataRequiredListResquested Data ListSTRING (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
}
ParametersDescriptionTypeComments
MessageNotification about any generated payment order that exceeds the configured maximum amountSTRING (TEXT)None
DocumentNumberIdOperation identifier generated after the successfull emissionLONG (NUMBER)None
BeneficiaryNameBeneficiary's nameSTRING (TEXT)None
BeneficiaryTaxNumberBeneficiary's TaxnumberLONG (NUMBER)None
MethodAPI MethodSTRING (TEXT)None
BusinessUnitIdBusiness Unit ID Provided by FitbankLONG (NUMBER)None

Response Webhook

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

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