Journey 1

Notification with Confirmation via Webhook

Suggest Edits

In this journey, the receiver requests that FitBank notify the payer about a pending recurrence response.

How it works: The receiver creates the recurrence, and FitBank sends a notification to the payer.
API Integration: GeneratePixAutomatic (to create the recurrence and initiate the notification process), NotifySuccess (endpoint when the recurrence is approved) or NotifyFailure (endpoint when the recurrence is rejected).

More details:

GeneratePixAutomatic: Generates a notification directed to the payer to inform about Automatic Pix.

NotifySucess: This webhook notifies that the recurrence has been approved.

NotifyFailure: This webhook notifies that the recurrence has been rejected.

GeneratePixAutomatic

{
  "Method": "GeneratePixAutomatic",
  "BusinessUnitId": 2002,
  "PartnerId": 1001,
  "Identifier": "ac1e955d-905d-436f-9881-f8dbdda58c73",
  "Retry": true,
  "Values": {
    "FinalValue": "100.00",
    "MaximumValue": "200.00"
  },
  "Receiver": {
        "TaxNumber": "84.925.787/0001-76",
        "Name": "Empresa S.A",
        "ISPB": "84925787",
        "Bank": "450",
        "BankBranch": "0001",
        "BankAccount": "440246",
        "BankAccountDigit": "3"
  },
  "Payer": {
    "TaxNumber": "12345678900",
    "Name": "João da Silva",
    "ISPB": "12345678",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "440246",
    "BankAccountDigit": "3"
  },
  "Contract": {
    "Identifier": "string",
    "Description": "string"
  },
  "Date": {
    "Frequency": 0,
    "InitialDate": "2025-08-25",
    "EndDate": "2025-08-25"
  },
  "SearchProtocol": 5489665,
  "PixKey": "[email protected]",
  "PixKeyType": 2
}

{
    "Success": "true",
    "Message": "Automatic Pix recurrence request sent successfully",
    "RecurrenceId": "12345678901234567890123456789"
}

Parameter	Description	Mandatory	Type	Comments
Method	Method or action to be executed in the request	Yes	String
BusinessUnitId	Identifier of the business unit	Yes	Integer
PartnerId	Partner identifier	Yes	Integer
Identifier	Unique Internal Identifier of the Recurrence	Yes	String
Retry	Indicates if the recurrence can have retries	Yes	Boolean
Values	Object containing value-related information	Yes	Object
Values.FinalValue	Transaction value	Conditional	String	Must be filled in case of a fixed value
Values.MaximumValue	Maximum allowed value for the transaction	Conditional	String	Must be filled in case of a variable value
Receive	Object containing receiver information	Yes	Object
Receive.TaxNumber	CNPJ of the receiver	Yes	String
Receive.Name	Receiver's name	Yes	String
Receive.ISPB	ISPB code of the receiver's institution	Yes	String
Receive.Bank	Receiver's bank code	Yes	String
Receive.BankBranch	Receiver's bank branch code	Yes	String
Receive.BankAccount	Receiver's bank account number	Yes	String
Receive.BankAccountDigit	Receiver's bank account digit	Yes	String
Payer	Object containing payer information	Yes	Object
Payer.TaxNumber	CPF/CNPJ of the payer	Yes	String
Payer.Name	Payer's name	Yes	String
Payer.ISPB	ISPB code of the payer's institution	Yes	String
Payer.Bank	Payer's bank code	Conditional	String
Payer.BankBranch	Payer's bank branch code	Conditional	String
Payer.BankAccount	Payer's bank account number	Conditional	String
Payer.BankAccountDigit	Payer's bank account digit	Conditional	String
Contract	Object containing contract information	Yes	Object
Contract.Identifier	Contract identifier	Yes	String
Contract.Description	Contract or transaction description	Yes	String
Date	Object containing date-related information	Yes	Object
Date.Frequency	Transaction frequency	Yes	Integer	WEEKLY = 0, MONTHLY = 1, QUARTERLY = 2, SEMIANNUAL = 3, ANNUAL = 4
Date.InitialDate	Transaction start date	Yes	String
Date.EndDate	Transaction end date	Yes	String
SearchProtocol	Unique protocol generated after querying a Pix key.	Conditional	Integer
PixKey	Pix key related to the query made to obtain the SearchProtocol.	Conditional	Integer
PixKeyType	Type of PIX key related to the query made to obtain the SearchProtocol.	Conditional	Integer	SOCIALSECURITY = 0, TAXNUMBER = 1, EMAIL = 2, PHONENUMBER = 3, RAMDOMKEYCODE = 4

Updated about 5 hours ago