Success
Bad Request
Not Found
Server Error
Total = amount of items, Items = transactions list
{- "items": [
- {
- "id": "a4b1ab64-bf66-4cb3-bd05-5a5c8c68b947",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.948891Z",
- "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": "415f8747-0439-4b66-8706-23d1932bcc54",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "90cbe2ae-0060-4715-87be-9f7737e509f3",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489145Z",
- "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": "dde172ff-be6a-44a3-b991-c8713237e36d",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "b99f5630-4a24-4ae5-9c35-7f54aa2ca9cf",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.94892Z",
- "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": "0a14c0cc-6569-464b-9042-7352c5c3ea88",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "753abc20-6866-48eb-acbe-78a2f85823e2",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489247Z",
- "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": "fb9e74ba-2900-4a2b-aa86-ea9ef053d4b1",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "858731b2-9407-47d0-a0ed-733dfad40b45",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489295Z",
- "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": "0dd7cb11-bd53-4e7f-82bc-3870c590e1f7",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "8d55670d-56b5-4c8a-a891-6c0a7177e968",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489342Z",
- "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": "9745bffc-01eb-476f-846a-a6e9a6bbd7bc",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "be130464-59ea-4b6a-8e01-b20cecbd8028",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489389Z",
- "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": "2b28591c-d041-407f-9921-f4160b703e90",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "8430f196-7e23-48ad-9354-21c8ae14444d",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489436Z",
- "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": "0285d3ee-9668-4262-b93f-b144d88c32ab",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "ac356f4a-0e22-4671-aa34-3e7d9fd5ec3e",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489482Z",
- "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": "d7fa6e3f-dedc-42cc-9352-2a92fae77473",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "3c3889d4-2ef8-4fe2-98e9-e1a1ec80c259",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489528Z",
- "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": "b306603c-ce3c-4475-b57e-016d3d44e463",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "94aa6c58-47ec-49c1-ba93-4940b921f5a1",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489574Z",
- "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": "dd346037-f4df-4aa5-a5d3-8ccfdfa66d4e",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "ca95557e-f111-47ad-aae5-a05272351da8",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489621Z",
- "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": "6f3cd441-7736-4498-adc8-2a6cd225a75d",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "de5a6959-ca4c-404b-b658-b8d64f4df263",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489668Z",
- "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": "7213bf9e-26f8-4fbb-a087-047ee13b4578",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "0b813599-01e5-452b-b2f0-d92873de9838",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489714Z",
- "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": "f4e7701a-57af-4a44-a979-e39cfe3901ed",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "72d48500-157d-45e3-8a0d-09c945a1903e",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489789Z",
- "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": "b7d8848b-7706-48b0-802c-44339c216fa2",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}, - {
- "id": "8e63a65d-7d61-4c89-bb41-c4ed78300910",
- "paymentProcessorId": "bfdf8d80-107a-4908-b6df-86cb82ccc750",
- "date": "2025-02-04T13:44:58.9489837Z",
- "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": "6963c274-833a-4c2e-807f-629826320ca7",
- "name": "SourceName"
}, - "availableOperations": [
- {
- "typeId": 4,
- "type": "Void",
- "availableAmount": 1.1,
- "suggestedTips": null
}
], - "amount": null
}
], - "total": 16
}
Success
Bad Request
Not Found
Server Error
{- "paymentProcessorId": "82001b58-c869-42be-b2f6-f42699eae09d",
- "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-02-04T13:44:59.5135001Z",
- "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": "4f7b73dd-ccf0-4cdf-9679-0e5f25ff1424",
- "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-02-04T13:44:59.6048836Z",
- "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": "72d4ac97-352b-4412-84cf-b65d01315159"
}
{- "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": "aa22f497-6ac8-4131-9433-edc9cadb7813",
- "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": "704b67ce-4cbb-42e4-9cf3-516aeb08f493",
- "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-02-04T13:45:00.4184512Z",
- "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": "7290b79a-6147-4756-abfd-5d33b3d41d8b"
}
{- "code": 0,
- "message": "string",
- "processorResponseCode": "string"
}
Success
Bad Request
Not Found
Server Error
{- "transactionId": "604089e1-5b85-419a-ae07-2af374b85efc"
}
{- "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-02-03T13:45:00.9809131Z",
- "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": "f449f4ef-2199-4f42-a4a0-617d687ce52f",
- "name": "SourceName"
}, - "responseCode": null,
- "responseDescription": null,
- "cardProcessingDetails": {
- "authCode": "A0000",
- "mid": "222222222",
- "tid": "1000001",
- "cardCreditDebitTypeId": 1,
- "cardCreditDebitType": "Credit",
- "processCreditDebitTypeId": 1,
- "processCreditDebitType": "Credit",
- "rrn": "10628361287F",
- "cardTypeId": 0,
- "cardType": null
}, - "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."
}, - "emvTags": {
- "ac": "533C2902770EA987",
- "tvr": "0040040000",
- "tsi": null,
- "aid": "A0000000031010",
- "applicationLabel": "MasterCard",
- "rawTags": [
- {
- "key": "5F34",
- "value": "SOMETHING"
}, - {
- "key": "5F35",
- "value": "SOMETHING"
}
]
}, - "orderNumber": "752314"
}
Success
Bad Request
Not Found
Server Error
{- "transactionId": "97b67da5-e354-4632-bd62-82eff0c11921",
- "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
}
}