Authorization
This page provides a comprehensive guide for handling authorization transactions through Vortex. It covers standard authorizations, including approvals and declines, as well as incremental authorization adjustments.
Authorizations
This page provides an overview of the authorization process for payment transactions, focusing on both standard and incremental authorizations. It highlights common use cases, potential failure scenarios, and guidance for merchants dealing with payment authorization issues.
In this guide, you’ll find:
- A breakdown of standard and incremental authorization processes and their use cases.
- Details on common failure scenarios and how to address them.
- Links to additional resources, such as error codes and field schema documentation.
Authorizations in Vortex
Authorization transactions are a critical first step in processing payments. This step involves a merchant seeking approval to charge a customer's payment method for a specified amount. The authorization process ensures the customer's account is valid and has sufficient funds or credit availability for the transaction.
Incremental authorizations allow for adjustments to the initially approved amount to accommodate changes in the final purchase total.
Use Cases
Standard Authorizations
Used to secure approval for a transaction amount before finalizing the sale. This type of authorization is applicable in most sales scenarios, including both online and in-store purchases.
Incremental Authorizations (Adjustments)
Used when the final transaction amount exceeds the initially authorized amount. Incremental authorizations are common in industries like hospitality (e.g., hotels, car rentals), where the final purchase amount isn't known upfront.
Examples
Standard Authorization
Request body
{
"arguments": [
{
"ecom": false,
"moto": false,
"externalId": "700535928447888",
"transactionType": "Authorization",
"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.S3_1"
}Response Body
{
"arguments": [
{
"ecom": false,
"moto": false,
"externalId": "700535928447888",
"transactionType": "Authorization",
"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.S3_1"
}Standard Authorization - Decline Example
Request Body
{
"arguments": [
{
"ecom": false,
"moto": false,
"externalId": "855265466348383",
"transactionType": "Authorization",
"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",
"securityCode": "88888"
},
"device": {
"accountCaptureMethod": "manual"
},
"recurring": false
}
],
"procedure": "card.create",
"class": "rpc",
"requestId": "Scenario_Visa_WS0.S11_1"
}Response Body
{
"code": 200,
"requestId": "Scenario_Visa_WS0.S11_1",
"id": "d7cb2c74-92b4-47ce-874b-1946a0adb79b",
"error": null,
"value": {
"code": 30,
"cardType": "Visa",
"message": "Invalid length for security code.",
"network": "visa",
"authorization": {
"authorized": false,
"processingTime": "00:00:00",
"reversed": false
},
"totalAmount": 40.05,
"approved": false,
"declined": true,
"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"
},
"requestedAmount": 40.05,
"id": "EwmOUrK0VDTiYOhdagKhXQ==",
"partial": false,
"reversed": false
},
"class": "response"
}Incremental Authorization - Increase Example
{
"arguments": [
{
"ecom": false,
"moto": false,
"externalId": "694914181390999",
"transactionType": "Adjustment",
"totalAmount": 8.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": "PPS8ca",
"originalExternalId": "396512864234922"
}
],
"procedure": "card.create",
"class": "rpc",
"requestId": "Scenario_Visa_WS0.S301_2"
}Response body
{
"code": 200,
"requestId": "Scenario_Visa_WS0.S301_2",
"id": "9e515fce-0749-463b-96b5-9a852c5bfd97",
"error": null,
"value": {
"code": 0,
"cardType": "Visa",
"validationCode": "VI84",
"message": "Approved and completed successfully",
"transactionId": "050000000019884",
"network": "visa",
"authorization": {
"request": "BADyIGSBCGCAFgAAAEIAAAAAEEdhNAAAAABQAAAAAAAAABAQAiEUUhGQMVFzmQhAAQBxBkCGRPTw9fLw8Pnw8/H18fXx+PD4+fL08Pfy9fT29dfX4kDFlYeJlYWFmYmVh0DkweNA8kBAQEDBk5eIgZmFo6OBQEBAQEAIQAZAAAAAAAAX4AACAAAAAADVAFAAAAABlGnlyfb55UAHoAAAAAIlBAEAkDFRAiEAAAAAAAQIZEAAAAAAAPDw8PDw8PDw8Pjx8PDw8PDw8PDw8PDw8PDw8PDw8PDw8PDw8PDw8PDw8A==",
"response": "BBASIgAAChBABAAAAAAQEAIhFFIRkDFRAiH08PXy8PD58PPx9fHw8AHlCEAUYAAAAAAAAAAAUAAAAAGYhOXJ+PQ=",
"authorized": true,
"networkResponseMessage": {
"mti": "0410",
"bitmap1": "122200000A104004",
"fields": [
{
"bitmap": 4,
"dataType": "BinaryCodedDecimal",
"name": "TransactionAmount",
"value": "10.1"
},
{
"bitmap": 7,
"dataType": "BinaryCodedDecimal",
"name": "TransmissionDateTime",
"value": "0221145211"
},
{
"bitmap": 11,
"dataType": "BinaryCodedDecimal",
"name": "SystemTraceAuditNumber",
"value": "903151"
},
{
"bitmap": 15,
"dataType": "BinaryCodedDecimal",
"name": "SettlementDate",
"value": "0221"
},
{
"bitmap": 37,
"dataType": "AlphaNumeric",
"name": "RetrievalReferenceNumber",
"value": "405200903151"
},
{
"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": "60000000000000000050000000019884E5C9F8F4"
}
]
},
"source": "V",
"processingTime": "00:00:00.6130699",
"reversed": false,
"networkRequestMessage": {
"mti": "0400",
"bitmap2": "0000004200000000",
"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": "10.1"
},
{
"bitmap": 7,
"dataType": "BinaryCodedDecimal",
"name": "TransmissionDateTime",
"value": "0221145211"
},
{
"bitmap": 11,
"dataType": "BinaryCodedDecimal",
"name": "SystemTraceAuditNumber",
"value": "903151"
},
{
"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": "405200903151"
},
{
"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": "E000020000000000D50050000000019469E5C9F6F9E540"
},
{
"bitmap": 63,
"dataType": "Binary",
"name": "PrivateUse63",
"length": 7,
"value": "A0000000022504"
},
{
"bitmap": 90,
"dataType": "BinaryCodedDecimal",
"name": "OriginalDataElements",
"value": "010090315102210000000000040864400000000000"
},
{
"bitmap": 95,
"dataType": "AlphaNumeric",
"name": "ReplacementAmounts",
"value": "000000000810000000000000000000000000000000"
}
]
},
"responseCode": "00"
},
"totalAmount": 8.1,
"approved": true,
"declined": false,
"originalAmount": 8.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": {},
"requestedAmount": 8.1,
"id": "sogx4dgu06stl11cqTEdWw==",
"partial": false,
"reversed": false
},
"class": "response"
}Incremental Authorization - Decrease Example
{
"arguments": [
{
"ecom": false,
"moto": false,
"externalId": "571956524431960",
"transactionType": "Adjustment",
"totalAmount": 8.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": "PPS028",
"originalExternalId": "190291510937711"
}
],
"procedure": "card.create",
"class": "rpc",
"requestId": "Scenario_Visa_WS0.S299_2"
}Response body
{
"code": 200,
"requestId": "Scenario_Visa_WS0.S299_2",
"id": "1a57d472-2d04-4c34-b6d0-5720f393ab85",
"error": null,
"value": {
"code": 0,
"cardType": "Visa",
"validationCode": "VI83",
"message": "Approved and completed successfully",
"transactionId": "050000000019883",
"network": "visa",
"authorization": {
"request": "BADyIGSBCGCAFgAAAEIAAAAAEEdhNAAAAABQAAAAAAAAABAQAiEUUhGQMTFzmQhAAQBxBkCGRPTw9fLw8Pnw8/Hz8fXx+PD4+fL08Pfy9fT29dfX4kDFlYeJlYWFmYmVh0DkweNA8kBAQEDBk5eIgZmFo6OBQEBAQEAIQAZAAAAAAAAX4AACAAAAAADVAFAAAAABlGblyfb25UAHoAAAAAIlBAEAkDExAiEAAAAAAAQIZEAAAAAAAPDw8PDw8PDw8Pjx8PDw8PDw8PDw8PDw8PDw8PDw8PDw8PDw8PDw8PDw8A==",
"response": "BBASIgAAChBABAAAAAAQEAIhFFIRkDExAiH08PXy8PD58PPx8/Hw8AHlCEAUYAAAAAAAAAAAUAAAAAGYg+XJ+PM=",
"authorized": true,
"networkResponseMessage": {
"mti": "0410",
"bitmap1": "122200000A104004",
"fields": [
{
"bitmap": 4,
"dataType": "BinaryCodedDecimal",
"name": "TransactionAmount",
"value": "10.1"
},
{
"bitmap": 7,
"dataType": "BinaryCodedDecimal",
"name": "TransmissionDateTime",
"value": "0221145211"
},
{
"bitmap": 11,
"dataType": "BinaryCodedDecimal",
"name": "SystemTraceAuditNumber",
"value": "903131"
},
{
"bitmap": 15,
"dataType": "BinaryCodedDecimal",
"name": "SettlementDate",
"value": "0221"
},
{
"bitmap": 37,
"dataType": "AlphaNumeric",
"name": "RetrievalReferenceNumber",
"value": "405200903131"
},
{
"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": "60000000000000000050000000019883E5C9F8F3"
}
]
},
"source": "V",
"processingTime": "00:00:00.7735828",
"reversed": false,
"networkRequestMessage": {
"mti": "0400",
"bitmap2": "0000004200000000",
"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": "10.1"
},
{
"bitmap": 7,
"dataType": "BinaryCodedDecimal",
"name": "TransmissionDateTime",
"value": "0221145211"
},
{
"bitmap": 11,
"dataType": "BinaryCodedDecimal",
"name": "SystemTraceAuditNumber",
"value": "903131"
},
{
"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": "405200903131"
},
{
"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": "E000020000000000D50050000000019466E5C9F6F6E540"
},
{
"bitmap": 63,
"dataType": "Binary",
"name": "PrivateUse63",
"length": 7,
"value": "A0000000022504"
},
{
"bitmap": 90,
"dataType": "BinaryCodedDecimal",
"name": "OriginalDataElements",
"value": "010090313102210000000000040864400000000000"
},
{
"bitmap": 95,
"dataType": "AlphaNumeric",
"name": "ReplacementAmounts",
"value": "000000000810000000000000000000000000000000"
}
]
},
"responseCode": "00"
},
"totalAmount": 8.1,
"approved": true,
"declined": false,
"originalAmount": 8.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": {},
"requestedAmount": 8.1,
"id": "W1s+V6k6y2bRN64Hztx54g==",
"partial": false,
"reversed": false
},
"class": "response"
}Void of an Authorization - Example
{
"arguments": [
{
"ecom": false,
"moto": false,
"externalId": "508829736943977",
"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": "PPS832",
"originalExternalId": "833548164620409"
}
],
"procedure": "card.create",
"class": "rpc",
"requestId": "Scenario_Visa_WS0.S489_02"
}Response Body
{
"code": 200,
"requestId": "Scenario_Visa_WS0.S489_02",
"id": "cb02347c-cc24-43b3-b3e0-919a9266e407",
"error": null,
"value": {
"code": 0,
"cardType": "Visa",
"validationCode": "VI88",
"message": "Approved and completed successfully",
"transactionId": "050000000019888",
"network": "visa",
"reference": "405200908231",
"authorization": {
"request": "BADyIGSBCGCAFgAAAEAAAAAAEEdhNAAAAABQAAAAAAAAAEAFAiEUUhWQQZFzmQhAAQBxBkCGRPTw9fLw8Pnw9PH58fXx+PD4+fL08Pfy9fT29dfX4kDFlYeJlYWFmYmVh0DkweNA8kBAQEDBk5eIgZmFo6OBQEBAQEAIQAZAAAAAAAAX4AACAAAAAADVAFAAAAABlXLlyffy5UAHoAAAAAIlAQEAkEGRAiEAAAAAAAQIZEAAAAAAAA==",
"response": "BBASIgAAChBABAAAAABABQIhFFIVkEGRAiH08PXy8PD58PTx+fHw8AHlCEAUYAAAAAAAAAAAUAAAAAGYiOXJ+Pg=",
"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": "904191"
},
{
"bitmap": 15,
"dataType": "BinaryCodedDecimal",
"name": "SettlementDate",
"value": "0221"
},
{
"bitmap": 37,
"dataType": "AlphaNumeric",
"name": "RetrievalReferenceNumber",
"value": "405200904191"
},
{
"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": "60000000000000000050000000019888E5C9F8F8"
}
]
},
"source": "V",
"processingTime": "00:00:00.7182735",
"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": "904191"
},
{
"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": "405200904191"
},
{
"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": "E000020000000000D50050000000019572E5C9F7F2E540"
},
{
"bitmap": 63,
"dataType": "Binary",
"name": "PrivateUse63",
"length": 7,
"value": "A0000000022501"
},
{
"bitmap": 90,
"dataType": "BinaryCodedDecimal",
"name": "OriginalDataElements",
"value": "010090419102210000000000040864400000000000"
}
]
},
"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": "/5FvLfm93aX2C7Fq7sgXRQ==",
"partial": false,
"reversed": false
},
"class": "response"
}Partial Void - Example
{
"arguments": [
{
"ecom": false,
"moto": false,
"externalId": "853026681703648",
"transactionType": "Void",
"totalAmount": 5.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": "PPSf3f",
"originalExternalId": "897498875219680"
}
],
"procedure": "card.create",
"class": "rpc",
"requestId": "Scenario_Visa_WS0.S297_2"
}Response Body
{
"code": 422,
"requestId": "Scenario_Visa_WS0.S297_2",
"id": "90cc4b7e-0b0e-4e15-baf0-978008844f2b",
"error": "Error: The external Id '897498875219680' is invalid: the provided amount (5.1) does not match the original payment (10.1)",
"value": null,
"class": "response"
}Rules-Based Funding Support
For advanced configurations and rules-based funding, consult our Rules-Based Funding Documentation.
Failed Scenarios
To get a comprehensive list of error codes, visit our Error Codes dedicated page.
Standard Authorization Failures
Failures can occur due to:
- Insufficient funds
- Expired payment methods
- Bank rejections for security reasons
Merchants should communicate the issue to customers and, if possible, seek alternative payment methods.
Incremental Authorization Failures
Failures might happen due to:
- Adjustment requests exceeding the allowable limit set by the bank
- Errors in the adjustment process
Merchants should verify the requested adjustment amount and ensure compliance with the bank's policies before re-attempting.
For more specific scenarios and detailed field schema, visit our Scenarios & Fields Schema Documentation.
Updated 7 months ago
Did this page help you?