4 - Canceling

Cancelling a collection order

The Collection Order client may, at any time, request the cancellation of an issued Collection Order.

Important: The cancellation request will be refused when the collection order is in the following statuses: Pre-canceled, Cancelled, Error Balance, Error or Settled.

API Method = CancelCollectionOrder

{
  "Method": "CancelCollectionOrder",
  "PartnerId": 30770,
  "BusinessUnitId": 61847,
  "DocumentNumber": 10247
}

Description:

ParameterDescriptionMandatoryTypeComments
MethodName of the method to be usedYESSTRINGNone
PartnerIdPartner identifier provided by FitBankYESBIGINTNone
BusinessUnitIdBusiness unit identifier provided by FitBankYESBIGINTNone
DocumentNumberOperation document numberYESINTEGERNone

Successful Response:

{
  "Success": "true",
  "Message": "ISI0499 - Collection order canceled"
}

Failure Response:

{
  "Success": "false",
  "Message": "EXC0016 - Status not allowed"
}

Collection order status:

StatusTypeDescription
CreatedSTRING (TEXT)The Collection Order was created
PreAuthorizedSTRING (TEXT)The Collection Order was pre-authorized and the collection was generated
AuthorizedSTRING (TEXT)Payer Approved in KYC
RegisteredSTRING (TEXT)The Collection was registered
Awaiting PaymentSTRING (TEXT)Awaiting Payment
SettledSTRING (TEXT)Completed Billing Order (payment settled)
CanceledSTRING (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
Canceled-RefundSTRING (TEXT)Amount refunded. Divergent data between Payer and Settlement
ErrorSTRING (TEXT)EXC0008 - Internal Processing Error