Sale

This page provides a guide on handling Sale transactions, including the essential processes involved in completing a sale, field validation, and settlement. It covers key scenarios such as managing authorization limits, adjustments, and failed transactions.

In this guide, you’ll find:

Detailed instructions on processing sale transactions, including field validation and settlement.
Insights into handling authorization and sale completion scenarios.
Key guidelines for incorporating level 2 and level 3 data for reduced processing fees.

Sale in Vortex

A Sale transaction represents a complete payment process where the merchant charges the customer for goods or services immediately. Unlike an authorization hold, a sale transaction transfers funds without requiring a separate capture step. For merchants, capturing Level 2 and Level 3 data during these transactions is crucial for qualifying for lower processing fees, especially in business-to-business (B2B) scenarios.

Use Cases

Field validation: Ensures all required information is accurately provided for processing the sale, including level 2 or level 3 data when applicable.
Settlement: The process where the transaction is finalized, and funds are transferred from the customer's account to the merchant's account. This step concludes the sale transaction.

Examples

Basic Sale Transaction Example

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "173359216848807",
      "transactionType": "Sale",
      "totalAmount": 40.05,
      "currencyCode": "840",
      "merchant": {
        "accountId": "261559",
        "name": "PPS Engineering UAT 2",
        "sic": "7399",
        "address": {
          "street1": "2001 Westside",
          "city": "Alpharetta",
          "state": "GA",
          "postalCode": "30004"
        },
        "number": "518089240725465",
        "processor": {
          "name": "TSYS",
          "bankNumber": "8739"
        },
        "sponsor": {
          "ica": "3583",
          "bin": "470780"
        }
      },
      "meta": {
        "created": "2024-02-21"
      },
      "account": {
        "form": "plastic",
        "expiry": "2025-12",
        "number": "4761340000000050"
      },
      "device": {
        "accountCaptureMethod": "manual"
      },
      "recurring": false
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S4_1"
}

Response Body

{
  "code": 200,
  "requestId": "Scenario_Visa_WS0.S4_1",
  "id": "8afd852f-c798-4b6e-9bef-5772a523af3d",
  "error": null,
  "value": {
    "authCode": "PPSaf8",
    "code": 0,
    "productId": "V",
    "cardType": "Visa",
    "validationCode": "VI61",
    "message": "Approved and completed successfully",
    "transactionId": "050000000019261",
    "network": "visa",
    "reference": "405200901041",
    "authorization": {
      "request": "AQByPGSBCGCANhBHYTQAAAAAUAAAAAAAAABABQIhAAAAkBBBAAAAAiElEnOZCEABAHEGQIZE9PD18vDw+fDx8PTx9fH48Pj58vTw9/L19Pb119fiQMWVh4mVhYWZiZWHQOTB40DyQEBAQMGTl4iBmYWjo4FAQEBAQAhACvHz8PDw8/Dw8PQGQAAAAAAACYAAAAAAAAAA6AWAAAAAAg==",
      "response": "ARASIgAADhBABAAAAABABQIhAAAAkBBBAiH08PXy8PD58PHw9PHX1+KBhvjw8AHlCEAX4AACAAAAAADVAFAAAAABkmHlyfbx5UA=",
      "authorized": true,
      "networkResponseMessage": {
        "mti": "0110",
        "bitmap1": "122200000E104004",
        "fields": [
          {
            "bitmap": 4,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionAmount",
            "value": "40.05"
          },
          {
            "bitmap": 7,
            "dataType": "BinaryCodedDecimal",
            "name": "TransmissionDateTime",
            "value": "0221000000"
          },
          {
            "bitmap": 11,
            "dataType": "BinaryCodedDecimal",
            "name": "SystemTraceAuditNumber",
            "value": "901041"
          },
          {
            "bitmap": 15,
            "dataType": "BinaryCodedDecimal",
            "name": "SettlementDate",
            "value": "0221"
          },
          {
            "bitmap": 37,
            "dataType": "AlphaNumeric",
            "name": "RetrievalReferenceNumber",
            "value": "405200901041"
          },
          {
            "bitmap": 38,
            "dataType": "AlphaNumeric",
            "name": "AuthorizationIdentificationResponse",
            "value": "PPSaf8"
          },
          {
            "bitmap": 39,
            "dataType": "AlphaNumeric",
            "name": "ResponseCode",
            "value": "00"
          },
          {
            "bitmap": 44,
            "dataType": "AlphaNumeric",
            "name": "AdditionalResponseData",
            "length": 1,
            "value": "V"
          },
          {
            "bitmap": 50,
            "dataType": "BinaryCodedDecimal",
            "name": "SettlementCurrencyCode",
            "value": "840"
          },
          {
            "bitmap": 62,
            "dataType": "Binary",
            "name": "PrivateUse62",
            "length": 23,
            "value": "E000020000000000D50050000000019261E5C9F6F1E540"
          }
        ]
      },
      "source": "V",
      "acceptorId": "518089240725465",
      "processingTime": "00:00:00.3974025",
      "reversed": false,
      "networkRequestMessage": {
        "mti": "0100",
        "bitmap1": "723C648108608036",
        "fields": [
          {
            "bitmap": 2,
            "dataType": "BinaryCodedDecimal",
            "name": "PrimaryAccountNumber",
            "length": 16,
            "value": "4761340000000050"
          },
          {
            "bitmap": 3,
            "dataType": "BinaryCodedDecimal",
            "name": "ProcessingCode",
            "value": "0"
          },
          {
            "bitmap": 4,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionAmount",
            "value": "40.05"
          },
          {
            "bitmap": 7,
            "dataType": "BinaryCodedDecimal",
            "name": "TransmissionDateTime",
            "value": "0221000000"
          },
          {
            "bitmap": 11,
            "dataType": "BinaryCodedDecimal",
            "name": "SystemTraceAuditNumber",
            "value": "901041"
          },
          {
            "bitmap": 12,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionTimeLocal",
            "value": "000000"
          },
          {
            "bitmap": 13,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionDateLocal",
            "value": "0221"
          },
          {
            "bitmap": 14,
            "dataType": "BinaryCodedDecimal",
            "name": "ExpirationDate",
            "value": "2512"
          },
          {
            "bitmap": 18,
            "dataType": "BinaryCodedDecimal",
            "name": "MerchantType",
            "value": "7399"
          },
          {
            "bitmap": 19,
            "dataType": "BinaryCodedDecimal",
            "name": "AcquiringInstitutionCountryCode",
            "value": "840"
          },
          {
            "bitmap": 22,
            "dataType": "BinaryCodedDecimal",
            "name": "PointOfServiceEntryMode",
            "value": "100"
          },
          {
            "bitmap": 25,
            "dataType": "BinaryCodedDecimal",
            "name": "PointOfServiceConditionCode",
            "value": "71"
          },
          {
            "bitmap": 32,
            "dataType": "BinaryCodedDecimal",
            "name": "AcquiringInstitutionIdCode",
            "length": 6,
            "value": "408644"
          },
          {
            "bitmap": 37,
            "dataType": "AlphaNumeric",
            "name": "RetrievalReferenceNumber",
            "value": "405200901041"
          },
          {
            "bitmap": 42,
            "dataType": "AlphaNumeric",
            "name": "CardAcceptorIdentification",
            "value": "518089240725465"
          },
          {
            "bitmap": 43,
            "dataType": "Binary",
            "name": "CardAcceptorNameLocation",
            "value": "D7D7E240C59587899585859989958740E4C1E340F240404040C1939788819985A3A3814040404040"
          },
          {
            "bitmap": 49,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionCurrencyCode",
            "value": "0840"
          },
          {
            "bitmap": 59,
            "dataType": "AlphaNumericSpecial",
            "name": "NationalUse59",
            "length": 10,
            "value": "1300030004"
          },
          {
            "bitmap": 60,
            "dataType": "BinaryCodedDecimal",
            "name": "AdviceReasonCode",
            "length": 12,
            "value": "400000000000"
          },
          {
            "bitmap": 62,
            "dataType": "Binary",
            "name": "PrivateUse62",
            "length": 9,
            "value": "8000000000000000E8"
          },
          {
            "bitmap": 63,
            "dataType": "Binary",
            "name": "PrivateUse63",
            "length": 5,
            "value": "8000000002"
          }
        ]
      },
      "responseCode": "00",
      "accountCaptureMethod": 1
    },
    "totalAmount": 40.05,
    "approved": true,
    "declined": false,
    "originalAmount": 40.05,
    "cardBin": {
      "country": {
        "iso": "702",
        "name": "Singapore",
        "abbreviation2": "SG",
        "info": "",
        "abbreviation3": "SGP"
      },
      "bank": {
        "phone": "6468 5566",
        "www": "www.hsbc.com.sg",
        "name": "HSBC"
      },
      "business": false,
      "level": "CLASSIC",
      "regulated": false,
      "bin": "47613400",
      "reloadable": false,
      "prepaid": false,
      "id": "47613400",
      "source": "pci.bindb.com",
      "type": "CREDIT",
      "brand": "VISA"
    },
    "lossPrevention": {},
    "aciResponse": "N",
    "requestedAmount": 40.05,
    "id": "VsAwZKpNKAzTXDPl10sFzQ==",
    "partial": false,
    "reversed": false
  },
  "class": "response"
}

Increase Transaction Example

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "265021252943715",
      "transactionType": "Adjustment",
      "totalAmount": 7.1,
      "currencyCode": "840",
      "merchant": {
        "accountId": "261559",
        "name": "PPS Engineering UAT 2",
        "sic": "7399",
        "address": {
          "street1": "2001 Westside",
          "city": "Alpharetta",
          "state": "GA",
          "postalCode": "30004"
        },
        "number": "518089240725465",
        "processor": {
          "name": "TSYS",
          "bankNumber": "8739"
        },
        "sponsor": {
          "ica": "3583",
          "bin": "470780"
        }
      },
      "meta": {
        "created": "2024-02-21"
      },
      "account": {
        "form": "plastic",
        "expiry": "2025-12",
        "number": "4761340000000050"
      },
      "device": {
        "accountCaptureMethod": "manual"
      },
      "recurring": false,
      "authCode": "PPS924",
      "originalExternalId": "879828576788995"
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S310_3"
}

Response Body

{
  "code": 200,
  "requestId": "Scenario_Visa_WS0.S4_1",
  "id": "8afd852f-c798-4b6e-9bef-5772a523af3d",
  "error": null,
  "value": {
    "authCode": "PPSaf8",
    "code": 0,
    "productId": "V",
    "cardType": "Visa",
    "validationCode": "VI61",
    "message": "Approved and completed successfully",
    "transactionId": "050000000019261",
    "network": "visa",
    "reference": "405200901041",
    "authorization": {
      "request": "AQByPGSBCGCANhBHYTQAAAAAUAAAAAAAAABABQIhAAAAkBBBAAAAAiElEnOZCEABAHEGQIZE9PD18vDw+fDx8PTx9fH48Pj58vTw9/L19Pb119fiQMWVh4mVhYWZiZWHQOTB40DyQEBAQMGTl4iBmYWjo4FAQEBAQAhACvHz8PDw8/Dw8PQGQAAAAAAACYAAAAAAAAAA6AWAAAAAAg==",
      "response": "ARASIgAADhBABAAAAABABQIhAAAAkBBBAiH08PXy8PD58PHw9PHX1+KBhvjw8AHlCEAX4AACAAAAAADVAFAAAAABkmHlyfbx5UA=",
      "authorized": true,
      "networkResponseMessage": {
        "mti": "0110",
        "bitmap1": "122200000E104004",
        "fields": [
          {
            "bitmap": 4,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionAmount",
            "value": "40.05"
          },
          {
            "bitmap": 7,
            "dataType": "BinaryCodedDecimal",
            "name": "TransmissionDateTime",
            "value": "0221000000"
          },
          {
            "bitmap": 11,
            "dataType": "BinaryCodedDecimal",
            "name": "SystemTraceAuditNumber",
            "value": "901041"
          },
          {
            "bitmap": 15,
            "dataType": "BinaryCodedDecimal",
            "name": "SettlementDate",
            "value": "0221"
          },
          {
            "bitmap": 37,
            "dataType": "AlphaNumeric",
            "name": "RetrievalReferenceNumber",
            "value": "405200901041"
          },
          {
            "bitmap": 38,
            "dataType": "AlphaNumeric",
            "name": "AuthorizationIdentificationResponse",
            "value": "PPSaf8"
          },
          {
            "bitmap": 39,
            "dataType": "AlphaNumeric",
            "name": "ResponseCode",
            "value": "00"
          },
          {
            "bitmap": 44,
            "dataType": "AlphaNumeric",
            "name": "AdditionalResponseData",
            "length": 1,
            "value": "V"
          },
          {
            "bitmap": 50,
            "dataType": "BinaryCodedDecimal",
            "name": "SettlementCurrencyCode",
            "value": "840"
          },
          {
            "bitmap": 62,
            "dataType": "Binary",
            "name": "PrivateUse62",
            "length": 23,
            "value": "E000020000000000D50050000000019261E5C9F6F1E540"
          }
        ]
      },
      "source": "V",
      "acceptorId": "518089240725465",
      "processingTime": "00:00:00.3974025",
      "reversed": false,
      "networkRequestMessage": {
        "mti": "0100",
        "bitmap1": "723C648108608036",
        "fields": [
          {
            "bitmap": 2,
            "dataType": "BinaryCodedDecimal",
            "name": "PrimaryAccountNumber",
            "length": 16,
            "value": "4761340000000050"
          },
          {
            "bitmap": 3,
            "dataType": "BinaryCodedDecimal",
            "name": "ProcessingCode",
            "value": "0"
          },
          {
            "bitmap": 4,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionAmount",
            "value": "40.05"
          },
          {
            "bitmap": 7,
            "dataType": "BinaryCodedDecimal",
            "name": "TransmissionDateTime",
            "value": "0221000000"
          },
          {
            "bitmap": 11,
            "dataType": "BinaryCodedDecimal",
            "name": "SystemTraceAuditNumber",
            "value": "901041"
          },
          {
            "bitmap": 12,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionTimeLocal",
            "value": "000000"
          },
          {
            "bitmap": 13,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionDateLocal",
            "value": "0221"
          },
          {
            "bitmap": 14,
            "dataType": "BinaryCodedDecimal",
            "name": "ExpirationDate",
            "value": "2512"
          },
          {
            "bitmap": 18,
            "dataType": "BinaryCodedDecimal",
            "name": "MerchantType",
            "value": "7399"
          },
          {
            "bitmap": 19,
            "dataType": "BinaryCodedDecimal",
            "name": "AcquiringInstitutionCountryCode",
            "value": "840"
          },
          {
            "bitmap": 22,
            "dataType": "BinaryCodedDecimal",
            "name": "PointOfServiceEntryMode",
            "value": "100"
          },
          {
            "bitmap": 25,
            "dataType": "BinaryCodedDecimal",
            "name": "PointOfServiceConditionCode",
            "value": "71"
          },
          {
            "bitmap": 32,
            "dataType": "BinaryCodedDecimal",
            "name": "AcquiringInstitutionIdCode",
            "length": 6,
            "value": "408644"
          },
          {
            "bitmap": 37,
            "dataType": "AlphaNumeric",
            "name": "RetrievalReferenceNumber",
            "value": "405200901041"
          },
          {
            "bitmap": 42,
            "dataType": "AlphaNumeric",
            "name": "CardAcceptorIdentification",
            "value": "518089240725465"
          },
          {
            "bitmap": 43,
            "dataType": "Binary",
            "name": "CardAcceptorNameLocation",
            "value": "D7D7E240C59587899585859989958740E4C1E340F240404040C1939788819985A3A3814040404040"
          },
          {
            "bitmap": 49,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionCurrencyCode",
            "value": "0840"
          },
          {
            "bitmap": 59,
            "dataType": "AlphaNumericSpecial",
            "name": "NationalUse59",
            "length": 10,
            "value": "1300030004"
          },
          {
            "bitmap": 60,
            "dataType": "BinaryCodedDecimal",
            "name": "AdviceReasonCode",
            "length": 12,
            "value": "400000000000"
          },
          {
            "bitmap": 62,
            "dataType": "Binary",
            "name": "PrivateUse62",
            "length": 9,
            "value": "8000000000000000E8"
          },
          {
            "bitmap": 63,
            "dataType": "Binary",
            "name": "PrivateUse63",
            "length": 5,
            "value": "8000000002"
          }
        ]
      },
      "responseCode": "00",
      "accountCaptureMethod": 1
    },
    "totalAmount": 40.05,
    "approved": true,
    "declined": false,
    "originalAmount": 40.05,
    "cardBin": {
      "country": {
        "iso": "702",
        "name": "Singapore",
        "abbreviation2": "SG",
        "info": "",
        "abbreviation3": "SGP"
      },
      "bank": {
        "phone": "6468 5566",
        "www": "www.hsbc.com.sg",
        "name": "HSBC"
      },
      "business": false,
      "level": "CLASSIC",
      "regulated": false,
      "bin": "47613400",
      "reloadable": false,
      "prepaid": false,
      "id": "47613400",
      "source": "pci.bindb.com",
      "type": "CREDIT",
      "brand": "VISA"
    },
    "lossPrevention": {},
    "aciResponse": "N",
    "requestedAmount": 40.05,
    "id": "VsAwZKpNKAzTXDPl10sFzQ==",
    "partial": false,
    "reversed": false
  },
  "class": "response"
}

Decrease Transaction Example

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "329452958645616",
      "transactionType": "Adjustment",
      "totalAmount": 3.1,
      "currencyCode": "840",
      "merchant": {
        "accountId": "261559",
        "name": "PPS Engineering UAT 2",
        "sic": "7399",
        "address": {
          "street1": "2001 Westside",
          "city": "Alpharetta",
          "state": "GA",
          "postalCode": "30004"
        },
        "number": "518089240725465",
        "processor": {
          "name": "TSYS",
          "bankNumber": "8739"
        },
        "sponsor": {
          "ica": "3583",
          "bin": "470780"
        }
      },
      "meta": {
        "created": "2024-02-21"
      },
      "account": {
        "form": "plastic",
        "expiry": "2025-12",
        "number": "4761340000000050"
      },
      "device": {
        "accountCaptureMethod": "manual"
      },
      "recurring": false,
      "authCode": "PPS5f6",
      "originalExternalId": "137552670487076"
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S311_3"
}

Response Body

{
  "code": 200,
  "requestId": "Scenario_Visa_WS0.S311_3",
  "id": "856809bf-1d18-48c9-b1aa-b4a0aae7a3d7",
  "error": null,
  "value": {
    "authCode": "PPS5f6",
    "code": 0,
    "productId": "V",
    "cardType": "Visa",
    "validationCode": "VI81",
    "message": "Approved and completed successfully",
    "transactionId": "050000000019481",
    "network": "visa",
    "reference": "405200909531",
    "authorization": {
      "authorized": false,
      "source": "V",
      "acceptorId": "518089240725465",
      "processingTime": "00:00:00",
      "reversed": false,
      "responseCode": "00",
      "accountCaptureMethod": 1
    },
    "totalAmount": 3.1,
    "approved": true,
    "declined": false,
    "originalAmount": 3.1,
    "cardBin": {
      "country": {
        "iso": "702",
        "name": "Singapore",
        "abbreviation2": "SG",
        "info": "",
        "abbreviation3": "SGP"
      },
      "bank": {
        "phone": "6468 5566",
        "www": "www.hsbc.com.sg",
        "name": "HSBC"
      },
      "business": false,
      "level": "CLASSIC",
      "regulated": false,
      "bin": "47613400",
      "reloadable": false,
      "prepaid": false,
      "id": "47613400",
      "source": "pci.bindb.com",
      "type": "CREDIT",
      "brand": "VISA"
    },
    "lossPrevention": {},
    "aciResponse": "N",
    "requestedAmount": 3.1,
    "id": "c4DuTd+ycjNMg2EA6ObbRw==",
    "partial": false,
    "reversed": false
  },
  "class": "response"
}

Partial Void

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "884152323103865",
      "transactionType": "Reversal",
      "totalAmount": 38.02,
      "currencyCode": "840",
      "merchant": {
        "accountId": "261559",
        "name": "PPS Engineering UAT 2",
        "sic": "7399",
        "address": {
          "street1": "2001 Westside",
          "city": "Alpharetta",
          "state": "GA",
          "postalCode": "30004"
        },
        "number": "518089240725465",
        "processor": {
          "name": "TSYS",
          "bankNumber": "8739"
        },
        "sponsor": {
          "ica": "3583",
          "bin": "470780"
        }
      },
      "meta": {
        "created": "2024-02-21"
      },
      "account": {
        "form": "plastic",
        "expiry": "2025-12",
        "number": "4761340000000050"
      },
      "device": {
        "accountCaptureMethod": "manual"
      },
      "recurring": false,
      "authCode": "PPS4ef",
      "originalExternalId": "894336631281994"
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S61_2"
}

Response Body

	{
  "code": 422,
  "requestId": "Scenario_Visa_WS0.S61_2",
  "id": "162fec67-0c9f-4e0b-b6a3-b60a7cce83b1",
  "error": "Error: The external Id '894336631281994' is invalid: the provided amount (38.02) does not match the original payment (40.05)",
  "value": null,
  "class": "response"
}

Full Void

{
  "arguments": [
    {
      "ecom": false,
      "moto": false,
      "externalId": "322963559697320",
      "transactionType": "Void",
      "totalAmount": 40.05,
      "currencyCode": "840",
      "merchant": {
        "accountId": "261559",
        "name": "PPS Engineering UAT 2",
        "sic": "7399",
        "address": {
          "street1": "2001 Westside",
          "city": "Alpharetta",
          "state": "GA",
          "postalCode": "30004"
        },
        "number": "518089240725465",
        "processor": {
          "name": "TSYS",
          "bankNumber": "8739"
        },
        "sponsor": {
          "ica": "3583",
          "bin": "470780"
        }
      },
      "meta": {
        "created": "2024-02-21"
      },
      "account": {
        "form": "plastic",
        "expiry": "2025-12",
        "number": "4761340000000050"
      },
      "device": {
        "accountCaptureMethod": "manual"
      },
      "recurring": false,
      "authCode": "PPSb9e",
      "originalExternalId": "254395532680612"
    }
  ],
  "procedure": "card.create",
  "class": "rpc",
  "requestId": "Scenario_Visa_WS0.S487_02"
}

Body Response

{
  "code": 200,
  "requestId": "Scenario_Visa_WS0.S487_02",
  "id": "860c5955-5e4d-435f-a1f5-1c937d838a4c",
  "error": null,
  "value": {
    "code": 0,
    "cardType": "Visa",
    "validationCode": "VI91",
    "message": "Approved and completed successfully",
    "transactionId": "050000000019891",
    "network": "visa",
    "reference": "405200908271",
    "authorization": {
      "request": "BADyIGSBCGCAFgAAAEAAAAAAEEdhNAAAAABQAAAAAAAAAEAFAiEUUhWQQWFzmQhAAQBxBkCGRPTw9fLw8Pnw9PH28fXx+PD4+fL08Pfy9fT29dfX4kDFlYeJlYWFmYmVh0DkweNA8kBAQEDBk5eIgZmFo6OBQEBAQEAIQAZAAAAAAAAX4AACAAAAAADVAFAAAAABlXHlyffx5UAHoAAAAAIlAQEAkEFhAiEAAAAAAAQIZEAAAAAAAA==",
      "response": "BBASIgAAChBABAAAAABABQIhFFIVkEFhAiH08PXy8PD58PTx9vHw8AHlCEAUYAAAAAAAAAAAUAAAAAGYkeXJ+fE=",
      "authorized": true,
      "networkResponseMessage": {
        "mti": "0410",
        "bitmap1": "122200000A104004",
        "fields": [
          {
            "bitmap": 4,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionAmount",
            "value": "40.05"
          },
          {
            "bitmap": 7,
            "dataType": "BinaryCodedDecimal",
            "name": "TransmissionDateTime",
            "value": "0221145215"
          },
          {
            "bitmap": 11,
            "dataType": "BinaryCodedDecimal",
            "name": "SystemTraceAuditNumber",
            "value": "904161"
          },
          {
            "bitmap": 15,
            "dataType": "BinaryCodedDecimal",
            "name": "SettlementDate",
            "value": "0221"
          },
          {
            "bitmap": 37,
            "dataType": "AlphaNumeric",
            "name": "RetrievalReferenceNumber",
            "value": "405200904161"
          },
          {
            "bitmap": 39,
            "dataType": "AlphaNumeric",
            "name": "ResponseCode",
            "value": "00"
          },
          {
            "bitmap": 44,
            "dataType": "AlphaNumeric",
            "name": "AdditionalResponseData",
            "length": 1,
            "value": "V"
          },
          {
            "bitmap": 50,
            "dataType": "BinaryCodedDecimal",
            "name": "SettlementCurrencyCode",
            "value": "840"
          },
          {
            "bitmap": 62,
            "dataType": "Binary",
            "name": "PrivateUse62",
            "length": 20,
            "value": "60000000000000000050000000019891E5C9F9F1"
          }
        ]
      },
      "source": "V",
      "processingTime": "00:00:00.7645861",
      "reversed": false,
      "networkRequestMessage": {
        "mti": "0400",
        "bitmap2": "0000004000000000",
        "bitmap1": "F220648108608016",
        "fields": [
          {
            "bitmap": 2,
            "dataType": "BinaryCodedDecimal",
            "name": "PrimaryAccountNumber",
            "length": 16,
            "value": "4761340000000050"
          },
          {
            "bitmap": 3,
            "dataType": "BinaryCodedDecimal",
            "name": "ProcessingCode",
            "value": "0"
          },
          {
            "bitmap": 4,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionAmount",
            "value": "40.05"
          },
          {
            "bitmap": 7,
            "dataType": "BinaryCodedDecimal",
            "name": "TransmissionDateTime",
            "value": "0221145215"
          },
          {
            "bitmap": 11,
            "dataType": "BinaryCodedDecimal",
            "name": "SystemTraceAuditNumber",
            "value": "904161"
          },
          {
            "bitmap": 18,
            "dataType": "BinaryCodedDecimal",
            "name": "MerchantType",
            "value": "7399"
          },
          {
            "bitmap": 19,
            "dataType": "BinaryCodedDecimal",
            "name": "AcquiringInstitutionCountryCode",
            "value": "840"
          },
          {
            "bitmap": 22,
            "dataType": "BinaryCodedDecimal",
            "name": "PointOfServiceEntryMode",
            "value": "100"
          },
          {
            "bitmap": 25,
            "dataType": "BinaryCodedDecimal",
            "name": "PointOfServiceConditionCode",
            "value": "71"
          },
          {
            "bitmap": 32,
            "dataType": "BinaryCodedDecimal",
            "name": "AcquiringInstitutionIdCode",
            "length": 6,
            "value": "408644"
          },
          {
            "bitmap": 37,
            "dataType": "AlphaNumeric",
            "name": "RetrievalReferenceNumber",
            "value": "405200904161"
          },
          {
            "bitmap": 42,
            "dataType": "AlphaNumeric",
            "name": "CardAcceptorIdentification",
            "value": "518089240725465"
          },
          {
            "bitmap": 43,
            "dataType": "Binary",
            "name": "CardAcceptorNameLocation",
            "value": "D7D7E240C59587899585859989958740E4C1E340F240404040C1939788819985A3A3814040404040"
          },
          {
            "bitmap": 49,
            "dataType": "BinaryCodedDecimal",
            "name": "TransactionCurrencyCode",
            "value": "0840"
          },
          {
            "bitmap": 60,
            "dataType": "BinaryCodedDecimal",
            "name": "AdviceReasonCode",
            "length": 12,
            "value": "400000000000"
          },
          {
            "bitmap": 62,
            "dataType": "Binary",
            "name": "PrivateUse62",
            "length": 23,
            "value": "E000020000000000D50050000000019571E5C9F7F1E540"
          },
          {
            "bitmap": 63,
            "dataType": "Binary",
            "name": "PrivateUse63",
            "length": 7,
            "value": "A0000000022501"
          },
          {
            "bitmap": 90,
            "dataType": "BinaryCodedDecimal",
            "name": "OriginalDataElements",
            "value": "010090416102210000000000040864400000000000"
          }
        ]
      },
      "responseCode": "00"
    },
    "totalAmount": 40.05,
    "approved": true,
    "declined": false,
    "originalAmount": 40.05,
    "cardBin": {
      "country": {
        "iso": "702",
        "name": "Singapore",
        "abbreviation2": "SG",
        "info": "",
        "abbreviation3": "SGP"
      },
      "bank": {
        "phone": "6468 5566",
        "www": "www.hsbc.com.sg",
        "name": "HSBC"
      },
      "business": false,
      "level": "CLASSIC",
      "regulated": false,
      "bin": "47613400",
      "reloadable": false,
      "prepaid": false,
      "id": "47613400",
      "source": "pci.bindb.com",
      "type": "CREDIT",
      "brand": "VISA"
    },
    "lossPrevention": {},
    "requestedAmount": 40.05,
    "id": "OoKkv/HfkWcczgb4zwUhzw==",
    "partial": false,
    "reversed": false
  },
  "class": "response"
}

Authorization + Sale Completion Scenarios

This guide offers practical insights for managing essential Authorization and Sale Completion scenarios in Vortex effectively.

Use Case Description	Expected Outcome	Additional Notes
Multiple Completions Within Authorization Limit Authorization for $10, first completion for $6, second completion for $4. Authorization for $10, first completion for $3, second completion for $5.	Both completion transactions are successfully approved.
Multiple Completions Exceeding Authorization Limit Authorization for $10, first completion for $6, second completion for $5.	The first completion is approved; the second completion is declined due to insufficient authorization limit.
Single Completion Exceeding Authorization Limit Authorization for $10, single completion for $12, including a $2 tip.	Completion is approved, provided the excess amount is within the network's allowable adjustment threshold (up to 20%).	It is advisable for any amount exceeding the authorized limit to be allocated to the tip field, though this practice is not mandatory.
Voiding Transactions After Completion Case 1: Authorization for $10, two completions for $4 each, void one completion. Case 2: Authorization for $10, one completion for $8, adjust authorization to $8, attempt to void authorization. Case 3: Authorization for $10, one completion for $8, adjust authorization to $8, void the completion, attempt to void the authorization.	Voiding an authorization post-completion is not permissible. – Voiding a completion of $4 when $8 has been completed is not viable. A partial void of $2 is feasible. – Adjustments or voiding of authorization post-completion is not allowed and will result in an error. – Only a partial void is permissible following the voiding of a completion transaction.
Authorization Adjustment After Sale Completion 1. Authorization for $10, completion for $8, adjustment to $8. 2. Authorization for $10, completion for $8, attempt to adjust to $6. 3. Authorization for $10, completion for $8, adjustment to $9. 4. Authorization for $10, two completions for $4 each, adjustment to $8. 5. Authorization for $10, two completions for $4 each, attempt to adjust to $6.	1. Authorization, sale completion, and adjustment are valid and processed successfully. 2. The adjustment attempt will result in an error, as adjustments cannot lower the authorized amount below the completed sale amount. 3. Authorization, sale completion, and adjustment are successfully processed. 4. Authorization, sale completions, and adjustment are processed successfully. 5. The adjustment will result in an error.	It is crucial to verify the authorized amount after each adjustment, void, or completion transaction. This ensures that completing an authorization decreases the available limit appropriately, and voiding a completion transaction increases it accordingly.

Implementation Notes

While the initial data requirements for processing a sale may align with those for authorizations, capturing Level 2 and Level 3 data is essential for merchants seeking reduced processing fees. This additional data is not required at the point of sale but should be included during the transaction's completion phase.

Key steps for successful sale transactions:

Field validation: Ensure that all required fields, including those for Level 2 and Level 3 data, are completed accurately.
Backend authorization: Perform proper backend checks to confirm sufficient authorization for the sale amount.
Settlement: Finalize the transaction, transferring the funds to the merchant's account.

Failed Scenarios

For a detailed list of error codes and explanations for failed transactions, visit our Error Codes Reference Page.

Common Failure Reasons

Incorrect data submission:
Sales transactions may fail if data is incomplete or incorrectly submitted, particularly Level 2 and Level 3 data.
Authorization failure:
Sales transactions may be declined due to insufficient funds, expired payment methods, or other issues flagged by the customer's bank.

This guide ensures that merchants have a clear and structured approach to processing "Sales" transactions, capturing necessary data for lower fees, and handling authorization and settlement scenarios effectively.