2 - Purchase Transaction
Purchase Transaction
API: GeneratePurchase
The Purchase Transaction functionality within the Arrangement allows end users to pay for their purchases using their digital account application at any registered store through this payment method. Imagine an end user wants to buy something at a physical or online store. Instead of using cash or a traditional credit/debit card, they can choose to pay using their digital account in the app.
This API is responsible for generating a purchase 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": "GeneratePurchaseClosedLoop", "BusinessUnitId": 30420, "PartnerId": 10409, "ContractIdentifier": "CON965569f9-5c93-4335-b09e-29efe32ba292CON", "TotalValue": 2, "MerchantAccountKey": "378320-014700-0146333-1", "Identifier": "PurchaseTesteVini1106new4", "InitiationType": 0 }
-
JSON RESPONSE:
{ "Success": true, "Message": "Purchase generated successfully", "TransactionIdentifier": "TRA3625e252-3a1a-459c-87ca-74134b3ee471TRA", "TransactionCode": "220337" }
or
{ "Success": true, "Message": "Purchase generated successfully", "TransactionIdentifier": "TRAc8bf0cf1-8b95-4030-8c69-8db61c6900b5TRA", "Hash": "2407cd25-01a5-4578-9f51-e538ea143435", "Image": "iVBORw0KGgoAAAANSUhEUgAAAMQAAADEAQAAAADo3bPGAAABvklEQVR4nO2XQW4DMQwD+QP+/5f6gSpSxqYB2psJ5BBnUWc9h1gyLarof0bhSz6DAODMnHmm/cIA4TysatRMJLyQINDKBDf7mHdBpsgsTrizE1SUKJkoR41OET8FKkoF/Jbre0SCeBtv2rlHNCaTHIm08vl+F+6RcpDzkU4crnJ7n7RODLpXBtDRZcimVPF5ed4ThN7DLNVofheLAVLO5chcQoc13wky17eldZ6HLhwBogrhgjdK9FtHSPn4yKMQ360OkFkZ/RXWMbyjShBaIs7qUSE7QhRqyQWlxT1GBsh6n6SolOoyNxLEZ6Wap+KndfthgGCDK5U8BYynhtwlW4RUH+q4YEeIKrePj55mF80AgQWoetdWCF5Oe5Ucz2hZoBsV/nLai8QFYpsUdUT1cvTLZIbKd/V2j7beAFlLt9Tp5qGfjF4lPrb9rp2gbE8J0qdGbFNsYSYI3THUUSRsVAnidsFGDmUXr97yKvHqidORrodcJ/5BuItUUYeNNkC4DTE3leW6FCFwu7XFXCeIp+e7T2wcW/fcCIWIPbws/e3AE2Q9w2Xcf/D0FFeJFcL9pwXbpfzWzjXy9/iSjyA/XqjNviKO4HwAAAAASUVORK5CYII=" }
API: CancelPurchase
This API allows for the cancellation of a previously created purchase transaction. It invalidates the transaction, preventing it from being processed or settled.
-
JSON REQUEST:
{ "Method": "CancelPurchaseClosedLoop", "PartnerId": 10409, "BusinessUnitId": 30472, "TransactionIdentifier": "TRA3625e252-3a1a-459c-87ca-74134b3ee471TRA" }
-
JSON RESPONSE:
{ "Success": "true", "Message": "Cancellation request completed successfully" }
Parameter Descriptions:
Parameter | Description | Type | Example | Mandatory |
---|---|---|---|---|
Method | Method name | string | "GeneratePurchaseClosedLoop" | Yes |
Partner | Information provided by FitBank | bigint | "847561" | Yes |
BusinessUnitId | Information provided by FitBank | int | "234334" | Yes |
PurchaseID | NoteID of the transaction | bigint | "847561" | Yes |
Status | Transaction status | tinyint | "Created" | Yes |
ContractIdentifier | Contract identifier | varchar | "CON965569f9-5c93-4335-b09e-29efe32ba292CON" | Yes |
MerchantAccountKey | Merchant account identifier | varchar | "378320-014700-0146333-1" | Yes |
Identifier | Transaction description provided by the client | varchar | "PurchaseTESTEcloseLOOP" | Yes |
TotalValue | Total transaction value | decimal | 20.00 | Yes |
InitiationType | User initiation type: QRCode or Code | tinyint | 0 - QRCode, 1 - Code | Yes |
TransactionIdentifier | Transaction identifier | varchar | "TRA4eb415ef-5c63-4996-8957-e1d2e3a95415TRA" | Yes |
PurchaseClosedLoopStatus:
{
"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
}
Updated about 2 months ago