Search for Collection Order

Searching

API Method = GetCollectionOrder

Through this method, the customer can check the billing requests through the Document Number we will inform the user after the success of the billing requests (Document Number) or by the Identifier applied by the customer (Identifier).

{
  "method": "GetCollectionOrder",
  "partnerId": 147,
  "businessUnitId": 205,
  "documentNumber": null,
  "identifier": null
}

Description:

Parameter	Description	Mandatory	Type	Comments
Method	Name of the method to be used	YES	STRING	None
PartnerId	Partner identifier provided by FitBank	YES	BIGINT	None
BusinessUnitId	Business unit identifier provided by FitBank	YES	BIGINT	None
DocumentNumber	Operation document number	NO	INTEGER	None
Identifier	ID reference	NO	STRING	None

Json return from GetCollectionOrder, for Collection Orders generated with CollectionOrderType: PixQrCodeDinamicDueDate = 0 or PixQrCodeDinamic=3:

{
    "Success": "true",
    "CollectionOrder": {
        "QrCode": {
            "HashCode":"null",
            "Image": "null",
            "EndToEndPixIn": "b5f90bc6-c7f4-4457-900b-526cd388edb0",
            "EndToEndRefundPixIn": "null",
          	"ReceiptUrl": null,
        },
        "CollectionOrderType": 0,
        "DocumentNumber": 635,
        "Identifier": "co-c37b5c00-05f2-4119-b368-6f775cd2fbbb",
        "Reason": null,
        "Status": "11",
        "StatusDescription": "AwaitingPayment",
        "PrincipalValue": 2.50,
        "PaymentValue": null,
        "PaymentDate": null,
        "RefundDate": null,
        "RefundValue": 0.05,
        "ChargeDate":{
           "DueDate" : 2024-08-25,
           "ExpirationDate" : 2024-08-30" 
        },
	"Payer": {
	   	"Name":"Alan Martins",
       "AccountInfo": {
        "TaxNumber": "84933904700",
        "Bank": "237",
        "BankBranch": "0011",
        "BankAccount": "6066452",
        "BankAccountDigit": "2"
                }
         },
         "Customer": {
            "CustomerName": "Reinaldo Soares",
            "CustomerTaxNumber": "73510906020"
        },
        "Receivers": [
            {
                "ReceiverName": "Name",
                "ReceiverTaxNumber": "09807047072",
                "SplitValue": 1.0,
            },
            {
                "ReceiverName": "Namele",
                "ReceiverTaxNumber": "05838788305",
                "SplitValue": 1.0,
            }
        ]
    }
}

Description:

Parameter	Description	Type	Comments
QrCode	Object concerning QRCode's info	OBJECT	None
HashCode	Identification code (copy and paste)	STRING	Base64 format
Image	QR Code image	STRING	Base64 format
EndToEndPixIn	PIX credit identifier provided by the Central Bank	STRING	None
EndToEndRefundPixIn	PIX refund identifier provided by the Central Bank	STRING	None
ReceiptUrl	Receipt template	STRING	It will only be sent when the operation is in "Settled" or "Canceled-Refund" Status
CollectionOrderType	Collection order’s type	INT	PixQrCodeDinamicDueDate = 0 Boleto = 1 BoletoPixQRCode = 2 PixQRCodeDinamic = 3
DocumentNumber	Operation document number	STRING	None
Identifier	ID reference	STRING	None
Reason	Cancellation reason	STRING	It will only be sent when the operation is in Canceled status
Status	Operation Status	STRING	None
StatusDescription	Operation status description	STRING	Status of the Collection Order
PrincipalValue	Collection order's amount	STRING	None
PaymentValue	Payment Value	STRING	None
PaymentDate	Payment date	STRING	None
RefundDate	Refund Date	STRING	None
RefundValue	Refund Value	STRING	None
ChargeDate	Interest charge date	OBJECT
DueDate	Payment due date	STRING	YYYY-MM-DD
ExpirationDate	Collection Order expiration date	STRING	YYYY-MM-DD
Payer	Object concerning Payer's data	-	None
Name	Payer Name	STRING	None
TaxNumber	Payer's CPF/CNPJ	STRING	None
Bank	Payer's Bank Code	STRING	None
BankBranch	Payer's Bank Agency Code	STRING	None
BankAccount	Payer's Bank Account	STRING	None
BankAccountDigit	Payer's Bank Account Digit	STRING	None
Customer	Object concerning customer's data	OBJECT	None
CustomerName	Beneficiary's name	STRING	None
CustomerTaxNumber	Beneficiary's CPF/CNPJ	STRING	None
Receiver	Object concerning receiver's data	OBJECT	None
ReceiverName	Receiver's name	STRING	None
ReceiverTaxNumber	Receiver's CPF/CNPJ	STRING	None
SplitValue	Amount received by the receivers	DECIMAL	None

Collection order status:

Status	Status Description	Type	Description
0	Created	STRING (TEXT)	The Collection Order was created
1	PreAuthorized	STRING (TEXT)	The Collection Order was pre-authorized and the collection was generated
2	Analysing	STRING (TEXT)	Payer under review in KYC process
3	Authorized	STRING (TEXT)	Payer Approved in KYC
6	Registered	STRING (TEXT)	The Collection was registered
8	Canceled	STRING (TEXT)	EXC0004 - Payer failed during the KYC process EXC0005 - Invalid billing email address EXC0006 - Collection has expired and payment has not been made EXC0007 - Divergent data between Payer and Settlement EXC0011 - Balance insufficient for fee collection EXC0012 - Payer failed in the validation process EXC0013 - Manual Cancellation INF0008- Is a qualified person, you must send a Collection Order again, with the data { Name, Email, Phone, Country, Nationality, Occupation, ...}
9	Settled	STRING (TEXT)	Completed Billing Order (payment settled)
11	Awaiting Payment	STRING (TEXT)	Awaiting Payment
12	Error	STRING (TEXT)	EXC0008 - Internal Processing Error
15	Canceled-Refund	STRING (TEXT)	INF0010 - Amount refunded. Divergent data between Payer and Settlement INF0014 - Receiver Account Validation Failed INF0016 - Amount refunded. Payer is a qualified person. INF0017 - Amount refunded. Payer screening has failed during the KYC process