A set of API endpoints that allow you to initiate, settle, and modify credit/debit card payments on the QorCommerce payments orchestration platform.

📘
Note:

To simplify your development and have consistency across different Purchase requests - all Purchase API calls can also be reached at the following endpoint with any combination of the required Purchase... sale parameters :

https://{user.test_api_url}/v3/payment/sale/

The Payment endpoints (sale, authorization and recurring) demonstrate the required parameters for processing a specific type of transaction. In practice, you may need to combine parameters across examples to match your use case. For instance, you can submit an authorization request with a token while also including 3DS/3RI fields for recurring payments.

All available parameters

The following are all the available parameters to contruct a purchase with a credit / debit card. The pages that follow demonstrate required parameters to specific use cases:

parameter	description
mid	the merchant id assigned by `{user.company_name}` or your merchant service provider (MSP)
tid	terminal id for processing (use as a reference, but required for MarketPlace transactions)
topt	Type Of Payment Transaction - set a value to simply tag and/or route a transaction to a pre-defined provider.
reference_id	A reference id that will be echo'd back in the message response.
amount	the total amount to process
service_charge	the amount of the total sum of this transaction that is made up of the service_charge
cardfullname	the name printed or embossed on the front of the credit card
creditcard	the credit card number
month	the card expiration month
year	the card expiration year
cvv	the card verification value
ticket	POS ticket `{object}` (`{user.cp_product_name}`) - (see ticket object parameters below)
baddress	the card billing street address
baddress2	the card billing street 2 address
bcity	the card billing city name
bstate	the card billing state code
bzip	the card billing zip code
bcountry	the card billing country code default: US
currency	The currency to process. Defaults to USD if no value provided
invoiceid	the merchant invoice id associated with the sale
orderid	unique merchant order tracking number
ipaddress	The IP address of the client or server sending the request
cfirstname	the customer first name
clastname	the customer last name
cemail	the customer email address
cphone	the customer phone number
cwebaddress	the customer website
total_tax	the total tax amount applied to the sale
purchase_order	the purchase order associated with this sale
shipping_amount	the total shipping amount applied to the sale
shipping_zip	if items shipped or delivered, the shipping zip code
shipping_country	if items shipped or delivered, the shipping country code
line_items	an array of item objects sold (see line_item object parameters below)
risk_score	risk score associated to this transaction (*if you are using a risk prevention system)
is_initial	first transaction in a recurring or installment plan
is_recurring	is this a recurring transaction (0 or 1) default = 0
first_trxn	original transaction ID associated with the initial payment of a subscription or installment plan
CAVV	The 3DS/3RI Cardholder Authentication Verification Value (MasterCard's UCAF value) Must be 28-32 chars. in length
ECIFlag	Provide the Electronic Commerce Indicator from the 3DS/3RI service
XID	3DS/3RI Transaction Identifier
store_card	if `true` will store card in the `{user.company_name} Secure Vault` and return a card token
send_rcpt	send the customer a receipt to `cemail`
metadata	a set of key-value pairs that you can attach to a payment. This can be useful for storing additional information about the payment in a structured format.

The ticket object array requires the following parameters

parameter	description	required
terminal_id	the POS terminal id	Yes
clerk_number	unique employee id	Yes
check_number	the POS ticket ID	Yes
payment_id	the payment ID from the POS	Yes

Level III (3) data - each object in the line_items array requires the following parameters

parameter	description	required
name	the name of the item	Yes
description	a description of the item	No
unit_price	the price per unit for the item	Yes
units_sold	the number of item units sold	Yes
unit_measurement	the unit of measurement	No
total_amount	the total amount of the item sale which should equal unit_price x units_sold + any taxes, discounts and/or fees	Yes
ucc	the item Universal Commercial Code	No
upc	the item Universal Product Code	No