Success
Bad Request
Not Found
Server Error
Total = amount of items, Items = transactions list
{- "items": [
- {
- "id": "c7c37acc-7e3d-460a-a2cf-d2b91244f0bb",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993001Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "fff98821-bc9d-4aa9-8fc9-4510fa6d662a",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "5c3d443d-f0ba-457f-a85f-79967656ae94",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993202Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "7025a8ba-6f16-40a7-8505-380bb67d8e6e",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "b295cb73-71e7-43f8-9f5c-bb1abf2c146a",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993246Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "96c9a91d-7319-4c87-91c3-31f84234552d",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "78565281-0193-49d5-a5bc-c02e1a3bea2d",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993284Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "17516bca-5c39-4314-8001-616039b194fb",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "91ee2e8a-58de-4595-a911-c083ae39b694",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993321Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "9c25a136-ca16-41bf-8bd3-2c3042f3cba0",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "8d389b90-109d-41e1-8149-c9febc769848",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993357Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "15343748-9a43-40c9-a937-4bb1cb29d0ba",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "2d633585-7f57-4eb4-b3bb-adaa6de9c579",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993398Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "19801940-eff4-4ec0-a44a-a46c9ace5917",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "229f80f9-c23f-4bad-b9aa-f26fb2ebcf7a",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993438Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "352bbea4-985d-4fae-877d-0123fc0e7b6e",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "0ec54a8d-0afa-478c-bee5-daf65c43e54a",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993477Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "18462064-ffaa-4a05-84ac-f97cb5ce625e",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "7e2345f4-a1fc-4d7a-9039-c07fce254890",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993516Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "b46dbcee-4e91-4b78-ac91-29b75d77085b",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "dab23531-ae14-4e96-afea-31c55a748380",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993557Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "d326d904-7ba3-4eca-8203-c6074f7da551",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "ed3d541f-8bc7-4998-a2dc-0966da33ddde",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993597Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "f7ff36f0-748c-4572-84f7-231705fdeb0a",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "e2577ac1-7c66-4e1c-9d8d-a9cc5f4a2e2c",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993635Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "a08402a7-5d36-4c5a-83b9-b09890e5c0d4",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "b3f0ab70-6efe-4f07-a668-59f8d100e84b",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6993926Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "bb659bda-cdf5-492e-a154-e8f0ebeb140c",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "3b7d7974-215e-421d-a8d7-69dbbbe4a8d3",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6994013Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "2b8f204d-b0c3-407a-a1f9-d06f30379c19",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "ddb54f30-18ef-4fec-bfd5-1bd4a7888c7e",
- "paymentProcessorId": "6396c8e4-838c-4aa8-b213-45ec8cd266e6",
- "date": "2025-01-09T13:27:49.6994054Z",
- "baseAmount": 1.1,
- "totalAmount": 1.1,
- "surchargeAmount": 0,
- "surchargePercentage": 0,
- "currencyCode": "USD",
- "currencyId": null,
- "merchant": "Merchant",
- "merchantId": "00000000-0000-0000-0000-000000000000",
- "operationMode": null,
- "paymentMethodType": "Card",
- "paymentMethodTypeId": 1,
- "paymentMethodName": null,
- "customerName": "John",
- "customerCompany": "Company",
- "customerPan": "************4512",
- "customerEmail": "e@mail.com",
- "customerPhone": "12345678",
- "status": "Captured",
- "statusId": 2,
- "batchId": null,
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "c22c7421-e761-411c-a6b8-b4a4fa3e17cb",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}
], - "total": 16
}
Success
Bad Request
Not Found
Server Error
{- "paymentProcessorId": "350bd2e9-1a74-4f3f-9575-e3b6ddc947f3",
- "customerId": null,
- "paymentMethodId": null,
- "amount": 123.45,
- "tipAmount": 1,
- "tipRate": null,
- "currencyId": 1,
- "percentageOffRate": 3,
- "surchargeRate": 4,
- "useCardPrice": null,
- "billingAddress": {
- "city": "Phoenix",
- "countryId": 1,
- "line1": null,
- "line2": null,
- "postalCode": "12345",
- "stateName": null,
- "stateId": 1
}, - "shippingAddress": {
- "city": "Phoenix",
- "countryId": 1,
- "line1": null,
- "line2": null,
- "postalCode": "12345",
- "stateName": null,
- "stateId": 1
}, - "contactInfo": {
- "firstName": "John",
- "lastName": "Smith",
- "companyName": "Aurora",
- "email": "example@example.com",
- "mobileNumber": null,
- "smsNotification": null
}, - "accountNumber": "4111111111111111",
- "securityCode": "123",
- "expirationMonth": 12,
- "expirationYear": 24,
- "track1": null,
- "track2": null,
- "emvTags": null,
- "emvPaymentAppVersion": null,
- "cardDataSource": 1,
- "pin": null,
- "pinKsn": null,
- "emvFallbackCondition": null,
- "emvFallbackLastChipRead": null,
- "referenceId": null,
- "l2": null,
- "l3": null,
- "customerInitiatedTransaction": false
}
Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request
{- "processedAmount": 10,
- "avsResponse": {
- "actionId": 1,
- "action": "Allow",
- "responseCode": "0",
- "groupId": 5,
- "group": "ValidGroup",
- "resultId": 1,
- "result": "Passed",
- "codeDescription": "Street Address and ZIP Code Match the information on file."
}, - "transactionId": "00000000-0000-0000-0000-000000000000",
- "transactionDateTime": "2025-01-09T13:27:50.0330992Z",
- "typeId": 1,
- "type": "Authorization",
- "statusId": 1,
- "status": "Authorized",
- "details": {
- "hostResponseCode": "00",
- "hostResponseMessage": "APPROVAL",
- "hostResponseDefinition": "Approved and completed",
- "code": "Approve",
- "message": "Success",
- "processorResponseCode": null,
- "authCode": "VTLMC1",
- "maskedPan": null
}
}
Success
Bad Request
Not Found
Server Error
{- "paymentProcessorId": "fe520286-0125-4cc4-bd3c-f50333e679e5",
- "customerId": null,
- "paymentMethodId": null,
- "amount": 123.45,
- "tipAmount": 1,
- "tipRate": null,
- "currencyId": 1,
- "percentageOffRate": 3,
- "surchargeRate": 4,
- "useCardPrice": null,
- "billingAddress": {
- "city": "Phoenix",
- "countryId": 1,
- "line1": null,
- "line2": null,
- "postalCode": "12345",
- "stateName": null,
- "stateId": 1
}, - "shippingAddress": {
- "city": "Phoenix",
- "countryId": 1,
- "line1": null,
- "line2": null,
- "postalCode": "12345",
- "stateName": null,
- "stateId": 1
}, - "contactInfo": {
- "firstName": "John",
- "lastName": "Smith",
- "companyName": "Aurora",
- "email": "example@example.com",
- "mobileNumber": null,
- "smsNotification": null
}, - "accountNumber": "4111111111111111",
- "securityCode": "123",
- "expirationMonth": 12,
- "expirationYear": 24,
- "track1": null,
- "track2": null,
- "emvTags": null,
- "emvPaymentAppVersion": null,
- "cardDataSource": 1,
- "pin": null,
- "pinKsn": null,
- "debit": null,
- "emvFallbackCondition": null,
- "emvFallbackLastChipRead": null,
- "referenceId": null,
- "l2": null,
- "l3": null,
- "customerInitiatedTransaction": false
}
Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request
{- "processedAmount": 10,
- "avsResponse": {
- "actionId": 1,
- "action": "Allow",
- "responseCode": "0",
- "groupId": 5,
- "group": "ValidGroup",
- "resultId": 1,
- "result": "Passed",
- "codeDescription": "Street Address and ZIP Code Match the information on file."
}, - "transactionId": "00000000-0000-0000-0000-000000000000",
- "transactionDateTime": "2025-01-09T13:27:50.0663225Z",
- "typeId": 1,
- "type": "Authorization",
- "statusId": 1,
- "status": "Authorized",
- "details": {
- "hostResponseCode": "00",
- "hostResponseMessage": "APPROVAL",
- "hostResponseDefinition": "Approved and completed",
- "code": "Approve",
- "message": "Success",
- "processorResponseCode": null,
- "authCode": "VTLMC1",
- "maskedPan": null
}
}
Success
Bad Request
Not Found
Server Error
{- "amount": 123.45,
- "transactionId": "4028d8cb-df52-4f3a-a32e-9b17f6a328a7"
}
{- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
- "transactionDateTime": "2019-08-24T14:15:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}
}
Success
Bad Request
Not Found
Server Error
Transaction Id is required
{- "track1": null,
- "track2": null,
- "emvTags": null,
- "emvPaymentAppVersion": null,
- "cardDataSource": 0,
- "pin": null,
- "pinKsn": null,
- "transactionId": "c5e25ebd-cd56-4fb4-a113-3fc2815a726f",
- "amount": null
}
{- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
- "transactionDateTime": "2019-08-24T14:15:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}
}
Success
Bad Request
Not Found
Server Error
{- "paymentProcessorId": "d53252fb-7086-452e-a12c-f413ea56141f",
- "customerId": null,
- "amount": 10.1,
- "currencyId": 1,
- "accountNumber": null,
- "securityCode": null,
- "expirationMonth": null,
- "expirationYear": null,
- "track1": "B5413330056003511^CUST IMP MC 351/^2512101000000000",
- "track2": null,
- "emvTags": null,
- "emvPaymentAppVersion": null,
- "cardDataSource": 2,
- "billingAddress": null,
- "shippingAddress": null,
- "contactInfo": null,
- "pin": "1111",
- "pinKsn": "2222222222",
- "debit": false,
- "emvFallbackCondition": null,
- "emvFallbackLastChipRead": null,
- "referenceId": "123456"
}
Transaction, type Authorization, status = Authorized. Transaction status after an approved pre-authorization request
{- "processedAmount": 10,
- "avsResponse": {
- "actionId": 1,
- "action": "Allow",
- "responseCode": "0",
- "groupId": 5,
- "group": "ValidGroup",
- "resultId": 1,
- "result": "Passed",
- "codeDescription": "Street Address and ZIP Code Match the information on file."
}, - "transactionId": "00000000-0000-0000-0000-000000000000",
- "transactionDateTime": "2025-01-09T13:27:50.0994906Z",
- "typeId": 1,
- "type": "Authorization",
- "statusId": 1,
- "status": "Authorized",
- "details": {
- "hostResponseCode": "00",
- "hostResponseMessage": "APPROVAL",
- "hostResponseDefinition": "Approved and completed",
- "code": "Approve",
- "message": "Success",
- "processorResponseCode": null,
- "authCode": "VTLMC1",
- "maskedPan": null
}
}
Success
Bad Request
Not Found
Server Error
{- "paymentProcessorId": "062a15e3-81b7-4b69-871d-1033c6545787"
}
{- "code": 0,
- "message": "string",
- "processorResponseCode": "string"
}
Success
Bad Request
Not Found
Server Error
{- "transactionId": "38cdda7f-23b8-444a-afce-96a65b7c4ae6"
}
{- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
- "transactionDateTime": "2019-08-24T14:15:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}
}
Success
Bad Request
Not Found
Server Error
{- "baseAmount": 100,
- "totalAmount": 100,
- "tsysCardDetails": {
- "authCode": "A0000",
- "mid": "222222222",
- "tid": "1000001"
}, - "achDetails": {
- "customerAccountNumber": null,
- "customerRoutingNumber": null,
- "accountHolderType": null,
- "accountHolderTypeId": 0,
- "accountType": null,
- "accountTypeId": 0,
- "taxId": null
}, - "transactionId": "00000000-0000-0000-0000-000000000000",
- "transactionDateTime": "2025-01-08T13:27:50.1641281Z",
- "amount": {
- "baseAmount": 100,
- "percentageOffAmount": 0,
- "percentageOffRate": 0,
- "cashDiscountAmount": 0,
- "cashDiscountRate": 0,
- "surchargeAmount": 0,
- "surchargeRate": 0,
- "tipAmount": 0,
- "tipRate": 0,
- "totalAmount": 100
}, - "currencyId": 1,
- "currency": "USD",
- "processorId": "00000000-0000-0000-0000-000000000000",
- "processor": "TSYS Sample",
- "operationTypeId": 1,
- "operationType": "PayNow",
- "paymentMethodTypeId": 1,
- "paymentMethodType": "Card",
- "transactionTypeId": 1,
- "transactionType": "Authorization",
- "customerPan": "************4512",
- "statusId": 1,
- "status": "Authorized",
- "merchantName": "Your Company",
- "merchantAddress": "WallStreet 1, New York",
- "merchantPhoneNumber": "1555123123",
- "merchantEmailAddress": "support@company.com",
- "merchantWebsite": "",
- "authCode": "A0000",
- "source": {
- "typeId": 1,
- "type": "Portal",
- "id": "1bf4aeb9-be94-4896-907f-aeb54251b236",
- "name": "SourceName"
}, - "responseCode": null,
- "responseDescription": null,
- "cardProcessingDetails": {
- "authCode": "A0000",
- "mid": "222222222",
- "tid": "1000001",
- "cardCreditDebitTypeId": 1,
- "cardCreditDebitType": "Credit",
- "processCreditDebitTypeId": 1,
- "processCreditDebitType": "Credit"
}, - "achProcessingDetails": {
- "customerAccountNumber": null,
- "customerRoutingNumber": null,
- "accountHolderType": null,
- "accountHolderTypeId": 0,
- "accountType": null,
- "accountTypeId": 0,
- "taxId": null
}, - "availableOperations": [
- {
- "typeId": 3,
- "type": "Capture",
- "availableAmount": 97.85,
- "suggestedTips": null
}, - {
- "typeId": 4,
- "type": "Void",
- "availableAmount": null,
- "suggestedTips": null
}
], - "avsResponse": {
- "actionId": 1,
- "action": "Allow",
- "responseCode": "0",
- "groupId": 5,
- "group": "ValidGroup",
- "resultId": 1,
- "result": "Passed",
- "codeDescription": "Street Address and ZIP Code Match the information on file."
}
}
Success
Bad Request
Not Found
Server Error
{- "transactionId": "91c2dc81-b5ba-4431-8dc1-06c8a86f2143",
- "tipAmount": 10
}
{- "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
- "transactionDateTime": "2019-08-24T14:15:22Z",
- "typeId": 0,
- "type": "string",
- "statusId": 0,
- "status": "string",
- "details": {
- "hostResponseCode": "string",
- "hostResponseMessage": "string",
- "hostResponseDefinition": "string",
- "code": "string",
- "message": "string",
- "processorResponseCode": "string",
- "authCode": "string",
- "maskedPan": "string"
}
}
Success
Bad Request
Not Found
Server Error
{- "phoneNumber": "string",
- "customerConsent": true
}
{- "phoneNumber": "string",
- "customerConsent": true
}
Use the Calculate Transaction Amount endpoint to determine the final amount to be charged to the customer. This endpoint considers applicable discounts, percentage-off values, tips, and any Zero Cost Processing (ZCP) mode enabled for the merchant account, including Dual Pricing, Cash Discount, or Credit Card Surcharge. The calculated amount can then be displayed on the payment terminal or POS for customer review before submitting the payment.
Success
Bad Request
Not Found
Server Error
{- "currencyId": 1,
- "currency": "string",
- "zeroCostProcessingOptionId": 1,
- "zeroCostProcessingOption": "string",
- "useCardPrice": true,
- "cash": {
- "baseAmount": 0,
- "percentageOffAmount": 0,
- "percentageOffRate": 0,
- "cashDiscountAmount": 0,
- "cashDiscountRate": 0,
- "surchargeAmount": 0,
- "surchargeRate": 0,
- "tipAmount": 0,
- "tipRate": 0,
- "taxAmount": 0,
- "taxRate": 0,
- "totalAmount": 0
}, - "creditCard": {
- "baseAmount": 0,
- "percentageOffAmount": 0,
- "percentageOffRate": 0,
- "cashDiscountAmount": 0,
- "cashDiscountRate": 0,
- "surchargeAmount": 0,
- "surchargeRate": 0,
- "tipAmount": 0,
- "tipRate": 0,
- "taxAmount": 0,
- "taxRate": 0,
- "totalAmount": 0
}, - "debitCard": {
- "baseAmount": 0,
- "percentageOffAmount": 0,
- "percentageOffRate": 0,
- "cashDiscountAmount": 0,
- "cashDiscountRate": 0,
- "surchargeAmount": 0,
- "surchargeRate": 0,
- "tipAmount": 0,
- "tipRate": 0,
- "taxAmount": 0,
- "taxRate": 0,
- "totalAmount": 0
}, - "ach": {
- "baseAmount": 0,
- "percentageOffAmount": 0,
- "percentageOffRate": 0,
- "cashDiscountAmount": 0,
- "cashDiscountRate": 0,
- "surchargeAmount": 0,
- "surchargeRate": 0,
- "tipAmount": 0,
- "tipRate": 0,
- "taxAmount": 0,
- "taxRate": 0,
- "totalAmount": 0
}
}