Process a payment with a keyed/manually entered credit/debit card
Note:
To simplify your development and have consistency across the various Purchase requests - all Purchase API calls can also be reached at the following endpoint with any combination of the required Purchase... parameters :
https://<<test_api_url>>/v3/payment/sale/
Parameters
The following parameters are available to process a keyed/manually entered credit/debit card.
| parameter | description | required |
|---|---|---|
| mid | the merchant id assigned by QorCommerce or your merchant service provider (MSP) | Yes |
| tid | terminal id for processing (use as a reference, but required for MarketPlace transactions) | No |
| topt | Type Of Payment Transaction - set a value to simply tag and/or route a transaction to a pre-defined provider. | No |
| reference_id | A reference id that will be echo'd back in the message response. | No |
| amount | the total amount to process | Yes |
| service_charge | the amount of the total sum of this transaction that is made up of the service_charge | No |
| creditcard | the credit card number | Yes |
| month | the card expiration month | Yes |
| year | the card expiration year | Yes |
| cvv | the card verification value | Yes |
| cardfullname | the name printed or embossed on the front of the credit card | Yes if store_card value is true |
| baddress | the card billing street address | No |
| baddress2 | the card billing street 2 address | No |
| bcity | the card billing city name | No |
| bstate | the card billing state code | No |
| bzip | the card billing zip code | Yes |
| bcountry | the card billing country code default: US | No |
| currency | The currency to process. Defaults to USD if no value provided | No |
| invoiceid | the merchant invoice id associated with the sale | No |
| orderid | unique merchant order tracking number | Yes |
| ipaddress | The IP address of the client or server sending the request | No |
| cfirstname | the customer first name | No |
| clastname | the customer last name | No |
| cemail | the customer email address | No |
| cphone | the customer phone number | No |
| cwebaddress | the customer website | No |
| risk_score | risk score associated to this transaction (*if you are using a risk prevention system) | No |
| store_card | if true will store card in the QorCommerce Secure Vault and return a card token | No |
| 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. | No |
JSON Example
The following JSON example provides test values to process a manual card. You can copy and paste these values in the Body Params section below to be used by the Try It feature
{
"transaction_data": {
"mid": "887728202",
"amount": "1.5",
"service_charge": "0.00",
"creditcard": "5544044490909090",
"cvv": "123",
"month": "04",
"year": "19",
"bzip": "92382",
"cardfullname": "Crypto Kings LLC",
"currency": "USD",
"invoiceid": "INV-123332",
"orderid": "193383",
"ipaddress": "0.0.0.0",
"baddress": "18312 All View Dr.",
"baddress2": "Apt 207",
"bcity": "Running Springs",
"bstate": "CA",
"bcountry": "US",
"cfirstname": "Russell",
"clastname": "Hanneman",
"cemail": "[email protected]",
"cphone": "1-344-877-8928",
"cwebaddress": "example.com",
"risk_score": "0",
"store_card": "true
}
}
Store Card Option
You can store the credit card information provided in the QorCommerce Secure Vault by setting the store_card parameter to true. The response will provide a token value representing the credit card that you can associate with your customer and/or a contract to use for payment in place of credit card data when needed.
JSON Example
The following JSON example provides test values to process a manual card. You can copy and paste these values in the Body Params section below to be used by the Try It feature
{
"mid": "887728202",
"amount": "1.5",
"creditcard": "5544044490909090",
"cvv": "123",
"month": "04",
"year": "25",
"bzip": "92838",
"cardholdername": "Nelson Bighetti",
"store_card": "true"
}
Response Codes
Link to details on related response codes.