post
https://api-sandbox.qorcommerce.io/v3/payment/recurring/setup
Setup and process a recurring credit/debit card sale
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Parameters
The following parameters are available to setup and process a recurring credit/debit card sale.
| parameter | description | required |
|---|---|---|
| mid | the merchant id assigned by USER.COMPANY_NAME 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 and set as a recurring purchase | 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 -or- card token | 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 | 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 |
| 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 USER.COMPANY_NAME Secure Vault and return a card token | No |
| recur_every | recurring plan period: 1 = weekly 2 = monthly 3 = quarterly 5 = annual 6 = bi-weekly | Yes |
| recur_start | recurring plan start date (mmddyyyy) | Yes |
| recur_occurrences | how many times to run recurring amount | Yes |
JSON Example
The following JSON example provides test values to process a swiped card. You can copy and paste these values in the Body Params section above to be used by the Try It feature
{
"transaction_data": {
"mid": "887728202",
"amount": "1.5",
"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",
"recur_every": "2",
"recur_start": "01202019",
"recur_occurrences": "6"
}
}Response Codes
- Payment Response Codes
Link to details on related response codes.