Authorization (pre-auth) - Use a Payment Token

Pre-Authorize an amount on a credit/debit card using a card token

QorCommerce provides a Secure Vault that will encrypt and store card numbers and return a token you can store with the client and/or a contract to use for future payments.

Card Tokens can be created from card data or track data during a sale or authorize transaction by providing the required card data and store_card == true parameter in the request. You can also create a card token using the Create a Payment Token endpoint.

To use a card token for a authorization, you simply pass the token as a creditcard value in the request using this endpoint.

Parameters

    The following parameters are available to process a card token authorization.

parameterdescriptionrequired

mid

the Merchant ID (MID) assigned by QorCommerce or your merchant service provider (MSP)

Yes

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 card token

Yes

cvv

supply the card validation value of the tokenized card for security purposes

Yes

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 number

Yes

ipaddress

The IP address of the client or server sending the request

No

cfirstname

the customers first name

No

clastname

the customers last name

No

cemail

the customers email address

No

cphone

the customers phone number

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 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 card token sale. 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",
    "creditcard": "909055$asoCdcdt",
    "cvv": "999",
    "currency": "USD",
    "orderid": "193383",
    "invoiceid": "INV-123332",
    "ipaddress": "0.0.0.0",
    "cfirstname": "Russell",
    "clastname": "Hanneman",
    "cemail": "[email protected]",
    "cphone": "1-344-877-8928",
    "cwebaddress": "example.com"
  }
}

Response Codes

Language
Click Try It! to start a request and see the response here!