CreditCardAuthorization

Description: This method authorizes a credit card transaction by requesting an authorization number from the card issuer. An approved authorization means that the transaction dollar amount has been reserved for usage but not yet deducted from the cardholder’s account. Funds are not settled (transferred to the merchant) until the CreditCardSettle() method is called using the authorization number returned by this method.

Resource Url: https://webservice.paymentxp.com/wh/WebHost.aspx

Method: POST

Content-Type: application/x-www-form-urlencoded

Notes

Parameters in bold are required in the request for example, BillingNameFirst
COF Fields in API methods are highlighted by double asterisk, **.
COF fields are optional however, if submitting as credentials-on-file, ALL COF related fields must be sent with valid values. If COF fields are missing or do not contain the correct value combination, the transaction request will be submitted as a regular, non-credential-on-file transaction.
COF is supported on Ecommerce or MOTO at this time.

Request

Parameter	Is Required	Data Type	Max Length	Description
`BillingAddress`	No	String	50	The billing address of the cardholder. Used to check for AVS identification.
`BillingCity`	No	String	50	The billing city of the cardholder.
`BillingCountry`	No	String	50	The billing country of the cardholder.
`BillingFullName`	No	String	50	The name of the cardholder as it appears on the card.
`BillingMethod`**	No	String	50	Values: 'initial_recurring' or 'recurring'
`BillingNameFirst`	Yes	String	50	The first name of the cardholder. Note: Required if BillingFullName not present
`BillingNameLast`	Yes	String	50	The last name of the cardholder. Note: Required if BillingFullName not present
`BillingState`	No	String	25	The billing state of the cardholder.
`BillingZipCode`	No	String	10	The billing zip code of the cardholder. Used to check for AVS identification.
`CardNumber`	Yes	String	76	Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data. Note: not required if you supplied a Token
`ClerkID`	No	String	15	The cashier/clerk who initiated the transaction.
`ClientIPAddress`	No	String	25	The IP address of the client device.
`Custominfo1` (1-20)	No	String	255	For merchant use.
`CVV2`	No	String	4	Card Verification Value. Leave this field empty if you’re doing swiped transactions or are using a KORT Payments Token
`EmailAddress`	No	String	50	The e-mail address of the cardholder.
`EncryptedDevice`	No	String	2000	String identifying device.
`ExpirationDateMMYY`	Yes	String	4	Identifies the cardholder’s account expiration date (format ). Note this field empty if you are swiping transactions or are using a KORT Payments Token
`InitialTransactionID`**	No	String	30	Original payment gateway transaction id. Only required on subsequent COF transactions where the credentials are to be used AND BillingMethod = ‘Firstrecurring’ or ‘Recurring’ ‘Firstrecurring’ or ‘Recurring’ transactions sent in without a valid InitialTransactionID will be sent to the processor as a regular, non-COF transaction
`InitiatedBy`**	No	String	50	Who initiated the transaction. Values: 'customer' or 'merchant'
`IsRecurring`	No	Boolean	1	Indicates transaction is a recurring transaction
`MarketSegment`**	No	String	50	Values: 'Ecommerce' or 'Retail' or 'Moto'
`MerchantID`	Yes	Number	9	The identification that is assigned to the merchant.
`MerchantKey`	Yes	String	36	A unique identification that is assigned to the merchant id.
`PaymentMemo`	No	String	50	Additional payment memo.
`PhoneNumber`	No	String	10	The phone number of the cardholder.
`ReferenceNumber`	No	String	50	The merchant/customer transaction identifier.
`ScheduleIndicator`**	No	String	50	Values: 'Scheduled' or 'Unscheduled'
`ShippingAddress1`	No	String	50	The shipping address for the product(s) purchased in the transaction.
`ShippingAddress2`	No	String	50	Additional shipping address information for the product(s)purchased in the transaction.
`ShippingCity`	No	String	50	The shipping city for the product(s) purchased in the transaction.
`ShippingCountry`	No	String	50	The shipping country for the product(s) purchased in the transaction.
`ShippingState`	No	String	25	The shipping state for the product(s) purchased in the transaction.
`ShippingZipCode`	No	String	10	The shipping zip code for the product(s) purchased in the transaction.
`StoredCredentialIndicator`**	No	String	50	The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
`Token`	No	String	40	If you have a KORT Payments Token, then use it here. When using the KORT Payments Token, CardNumber, ExpirationDateMMYY, and CVV2 should not be passed.
`TransactionAmount`	Yes	Number	9	Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
`TransactionType`	Yes	String	23	CreditCardAuthorization

Response

Field Name	Description
`PostedDate`	The date and time the transaction was posted.
`StatusID`	The result of the transaction. Status 0 indicates an approved transaction.
`TransactionID`	The number that identifies the transaction in the KORT Payments system.
`ReferenceNumber`	The merchant/customer transaction identifier that was sent in the initial request.
`TransactionAmount`	Identifies the transaction amount that was sent in the initial request.
`AuthorizationCode`	Authorization code from the issuing bank.
`ResponseCode`	The approval or decline code from the processor.
`ResponseMessage`	The approval or decline message from the processor.
`CVV2ResponseCode`	The CVV2 response code.
`CVV2ResponseMessage`	The CVV2 response message.
`AVSResponseCode`	The AVS response code.
`AVSResponseMessage`	The AVS response message.
`URLPostback`	URL to redirect customer after sale has been posted
`CardNumber`	Identifies the last 4 cardholder’s account number.
`CustomerName`	The name of the cardholder as it appears on the card.
`BillingNameFirst`	The first name of the cardholder.
`BillingNameLast`	The last name of the cardholder.
`BillingAddress`	The billing address of the cardholder. Used to check for AVS identification.
`BillingCity`	The billing city of the cardholder.
`BillingState`	The billing state of the cardholder.
`BillingZip`	The billing zip code of the cardholder. Used to check for AVS identification.
`BillingCountry`	The billing country of the cardholder.
`BillingPhone`	The phone number of the cardholder.
`BillingFax`	The fax number of the cardholder
`BillingEmail`	The e-mail address of the cardholder.
`CustomerID`	An existing customer record.
`ProductDesc`	Use to identify product name.
`Action`	The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
`ShippingAddress1`	The shipping address of the cardholder.
`ShippingAddress2`	The shipping address of the cardholder.
`ShippingCity`	The shipping city of the cardholder.
`ShippingState`	The shipping state of the cardholder.
`ShippingZipCode`	The shipping zip code of the cardholder. Used to check for AVS identification.
`ShippingCountry`	The shipping country of the cardholder.
`Custominfo1` (1-20)	For merchant use.
`TransTypeID`	Identifies the type of transaction that was processed. View appendix F.
`SettleDate`	The date and time the transaction was settled.
`VoidDate`	The date and time the transaction was voided.
`RefundDate`	The date and time the transaction was refunded.
`TransactionStatusID`	Identifies the status of the transaction that was processed. View appendix G.
`IsStoredCredentialEnabled`	Parameter indicating if a transaction was accepted by the processor as credential-on-file (True) or regular transaction (False).

Test Information

CreditCardCapture