post https://api-sandbox.qorcommerce.io/v3/payment/recurring
Process an existing recurring credit/debit card purchase initially run by the QorCommerce payments platform
Parameters
The following parameters are available to process a recurring credit/debit card sale. This endpoint can only be used if QorCommerce processed the original (first) recurring payment.
| parameter | description | required |
|---|---|---|
| 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 |
| creditcard | the card number or account token token | Yes |
| 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 |
| 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 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 |
| is_recurring | is this a recurring transaction | Yes |
| first_trxn | original transaction id of the first payment | Yes |
| 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 recurring 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",
"currency": "USD",
"invoiceid": "INV-123332",
"orderid": "193383",
"ipaddress": "0.0.0.0",
"bcountry": "US",
"cfirstname": "Russell",
"clastname": "Hanneman",
"cemail": "[email protected]",
"cphone": "1-344-877-8928",
"cwebaddress": "example.com",
"is_recurring": "1",
"first_trxn": "{trxn_id}}"
}
}
Response Codes
Link to details on related response codes.