2.2 - Withdrawal Transaction

Withdrawal Transaction

API: GenerateWithdrawal

The Withdrawal Transaction functionality within the Arrangement allows end users to withdraw cash from their digital account at any registered store through this payment method. Sometimes, it may be necessary to have cash on hand for situations where digital payment is not accepted or simply due to personal preference. In such cases, users can use the withdrawal option to get cash.

This API is responsible for generating a withdrawal transaction. When triggered, it creates a QR Code or a 6-digit Token that the end user will use to confirm the purchase via their application.

  • JSON REQUEST:

    {
      "Method": "GenerateWithdrawalClosedLoop",
      "BusinessUnitId": 66,
      "PartnerId": 66,
      "ContractIdentifier": "CONf67e004b-e82c-4dd0-ba29-9d63f3cb21ccCON",
      "TotalValue": 2.00,
      "MerchantAccountKey": "378320-014700-0146333-1",
      "Identifier": "identificador do saque432",
      "InitiationType": 0
    }
    
  • JSON RESPONSE:

    {
      "Success": true,
      "Message": "Withdrawal generated successfully",
      "TransactionIdentifier": "TRA4eb415ef-5c63-4996-8957-e1d2e3a95415TRA",
      "TransactionCode": "840846"
    }
    

    or

    {
      "Success": true,
      "Message": "Withdrawal generated successfully",
      "TransactionIdentifier": "TRAbf1eff53-d367-4b2e-b68f-3f1abb68d9d2TRA",
      "Hash": "32d2bc0c-0593-4d48-8f34-561cbf401f9b",
      "Image": "iVBORw0KGgoAAAANSUhEUgAAAMQAAADEAQAAAADo3bPGAAABvklEQVR4nO2XQW4DMQwD+QP+/5f6gSpSxqYB2psJ5BBnUWc9h1gyLarof0bhSz6DAODMnHmm/cIA4TysatRMJLyQINDKBDf7mHdBpsgsTrizE1SUKJkoR41OET8FKkoF/Jbre0SCeBtv2rlHNCaTHIm08vl+F+6RcpDzkU4crnJ7n7RODLpXBtDRZcimVPF5ed4ThN7DLNVofheLAVLO5chcQoc13wky17eldZ6HLhwBogrhgjdK9FtHSPn4yKMQ360OkFkZ/RXWMbyjShBaIs7qUSE7QhRqyQWlxT1GBsh6n6SolOoyNxLEZ6Wap+KndfthgGCDK5U8BYynhtwlW4RUH+q4YEeIKrePj55mF80AgQWoetdWCF5Oe5Ucz2hZoBsV/nLai8QFYpsUdUT1cvTLZIbKd/V2j7beAFlLt9Tp5qGfjF4lPrb9rp2gbE8J0qdGbFNsYSYI3THUUSRsVAnidsFGDmUXr97yKvHqidORrodcJ/5BuItUUYeNNkC4DTE3leW6FCFwu7XFXCeIp+e7T2wcW/fcCIWIPbws/e3AE2Q9w2Xcf/D0FFeJFcL9pwXbpfzWzjXy9/iSjyA/XqjNviKO4HwAAAAASUVORK5CYII="  
      }
    

Parameter Descriptions:

ParameterDescriptionTypeExampleMandatory
MethodMethod namestring"GeneratePurchaseClosedLoop"Yes
PartnerInformation provided by FitBankbigint"847561"Yes
BusinessUnitIdInformation provided by FitBankint"234334"Yes
PurchaseIDNoteID of the transactionbigint"847561"Yes
StatusTransaction statustinyint"Created"Yes
ContractIdentifierContract identifiervarchar"CON965569f9-5c93-4335-b09e-29efe32ba292CON"Yes
MerchantAccountKeyMerchant account identifiervarchar"378320-014700-0146333-1"Yes
IdentifierTransaction description provided by the clientvarchar"PurchaseTESTEcloseLOOP"Yes
TotalValueTotal transaction valuedecimal20.00Yes
InitiationTypeUser initiation type: QRCode or Codetinyint0 - QRCode, 1 - CodeYes
TransactionIdentifierTransaction identifiervarchar"TRA4eb415ef-5c63-4996-8957-e1d2e3a95415TRA"Yes

**WithdrawalClosedLoopStatus:**

```json
{
"Created": 0,
"Canceled": 1,
"Settled": 2,
"PreSettled": 3,
"PreCanceled": 4,
"CanBePreAuthorized": 5,
"CanBeAuthorized": 6,
"Authorized": 7,
"Registered": 8,
"CanBePreCanceled": 9,
"PreAuthorized": 10,
"CanBeSettled": 11,
"CanBeCanceled": 12,
"ErrorBalance": 13
}