POST payments/credit/sale
Creates a card payment (manually-keyed or swiped card) for a credit sale transaction.
Request Information
URI Parameters
None.
Body Parameters
request payload
CreditSaleRequestName | Description | Type | Additional information |
---|---|---|---|
TransactionData |
Specific information for the transaction. |
CreditSaleTransactionData |
Required |
AmountsReq |
Amount requested for this transaction. |
CreditSaleAmountsRequest |
Required |
PaymentData |
Payment data for this transaction. |
CreditSalePaymentData |
Required |
Signature |
Base64-encoded string representing the cardholder's signature as captured by a POS device. |
string |
None. |
SendReceiptRequest |
Request for sending a transaction receipt. |
PaymentReceiptRequest |
None. |
AdditionalData |
Contains Additional data for processing a credit sale. |
CreditSaleAdditionalData |
None. |
Request Formats
application/json, text/json
{ "TransactionData": { "UniqueIdentifier": "sample string 1", "TimeStamp": "2024-05-11T06:26:12.768Z", "TotalAmount": 3.0, "Description": "sample string 4", "GeotagInfo": { "Longitude": 1.1, "Latitude": 2.1 }, "InvoiceNumber": "sample string 5", "DeviceRegistrationIdentifier": "e9784404-f2ee-475c-97c6-d85dbd48c342" }, "AmountsReq": { "SubTotalAmount": 1.0, "TaxAmount": 2.0, "TipAmount": 3.0, "SurchargeAmount": 4.0 }, "PaymentData": { "EntryMethod": "Standard", "CardData": { "CardVerificationMethod": "Unknown", "PinCode": "sample string 1", "PinKeySerialNumber": "sample string 2", "ManualCardData": { "PAN": "sample string 1", "ExpirationDate": "sample string 2", "CardHolderName": "sample string 3" }, "SensitiveCardData": { "Track1": "sample string 1", "Track2": "sample string 2" }, "ProtectedCardData": { "Reader": "sample string 1", "ReaderEncoding": "None", "MaskedCardData": { "FirstSix": "sample string 1", "LastFour": "sample string 2", "CardHolderName": "sample string 3" }, "EncryptedData": { "CombinedBlock": "sample string 1", "Track1": "sample string 2", "Track2": "sample string 3" }, "KeyID": "sample string 2", "TrackDataKeySerialNumber": "sample string 3" }, "EMVCardData": { "Reader": "sample string 1", "ReaderSerialNumber": "sample string 2", "ReaderKernelHash": "sample string 3", "ReaderConfigurationVersion": "sample string 4", "ReaderEncoding": "None", "TlvEncrypted": "sample string 5", "Tlv": "sample string 6", "KeySerialNumber": "sample string 7" }, "CardOnFileData": { "Token": "sample string 1" } }, "VerificationData": { "CardSecurityCode": "sample string 1", "CardSecurityCodeReason": "not provided", "AddressPostalCode": "sample string 2", "AddressBillingAddress": "sample string 3" }, "EmvCapable": true, "ContactlessEntryMethod": "EMV" }, "Signature": "sample string 1", "SendReceiptRequest": { "Emails": [ { "Email": "sample string 1" }, { "Email": "sample string 1" } ] }, "AdditionalData": { "AddCardOnFile": true } }
Response Information
Resource Description
Creates a card payment (manually-keyed or swiped card) for a credit sale transaction.
CreditSaleResponseName | Description | Type | Additional information |
---|---|---|---|
TransactionRequestData |
Transaction request data, such as echo back properties. |
PaymentTransactionRequestData |
Required |
AmountsResp |
Response to amount requested. |
AmountsResponse |
Required |
PaymentRespData |
Payment response data. |
PaymentResponseData |
Required |
TransactionResultData |
Transaction result data. |
PaymentTransactionResultData |
Required |
Result |
Transaction result, such as success or failure. |
PaymentTransactionResult |
Required |
AdditionalData |
Contains Additional data responses. |
AdditionalResponseData |
None. |
AdditionalTransactionData |
Gets or sets the additional transaction data. |
AdditionalTransactionData |
None. |
Response Formats
application/json, text/json
{ "TransactionRequestData": { "UniqueIdentifier": "sample string 1" }, "AmountsResp": { "RequestedTotalAmount": 1.0, "ApprovedAmount": 2.0 }, "PaymentRespData": { "CardVerificationResponse": { "CVVResponseCode": "sample string 1", "CVVResponseText": "sample string 2", "AVSResponseCode": "sample string 3", "AVSResponseText": "sample string 4" }, "CommercialCardResponse": { "PromptForTaxExempt": true, "PromptForCustomerCode": true }, "EmvCardResponse": { "Tlv": "sample string 1" } }, "TransactionResultData": { "AuthCode": "sample string 1", "HostTransactionID": 1, "ParentHostTransactionID": 1, "RRN": "sample string 2", "ReceiptID": 1 }, "Result": { "ProcessorResponseCode": "sample string 1", "ProcessorResponseText": "sample string 2", "ResponseCode": 3, "ResponseText": "sample string 4" }, "AdditionalData": { "CardOnFileToken": "sample string 1" }, "AdditionalTransactionData": { "EmvArqcTlv": "sample string 1", "Description": "sample string 2", "InvoiceNumber": "sample string 3", "TaxAmount": 1.0, "TipAmount": 1.0, "PaymentCardType": "Other", "CardFirstSix": "sample string 4", "CardLastFour": "sample string 5", "CardExpirationMonth": "sample string 6", "CardExpirationYear": "sample string 7", "EmvCapable": true, "CardReaderType": "Unspecified", "CardVerificationMethod": "Unknown", "TransactionDateTime": "2024-05-11T06:26:12.847Z", "TransactionReferenceNumber": "sample string 8", "ValidationCode": "sample string 9", "VisaRewardsProgramIdentifier": "sample string 10" } }