{ "info": { "title": "FlexPay Subscription documentation", "version": "4" }, "openapi": "3.1.0", "paths": { "/cancel-subscription": { "get": { "operationId": "cancel-subscription-request", "parameters": [ { "description": "version version of the FlexPay call, `4` for this version", "in": "query", "name": "version", "required": true, "schema": { "type": "string" } }, { "description": "numerical ID of the website or shop in Verotel system", "in": "query", "name": "shopID", "required": true, "schema": { "type": "number" } }, { "description": "Verotel saleID identifier", "in": "query", "name": "saleID", "required": true, "schema": { "type": "number" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "servers": [ { "url": "https://secure.verotel.com" }, { "url": "https://secure.billing.creditcard" }, { "url": "https://secure.gaycharge.com" }, { "url": "https://secure.yoursafedirect.com" } ], "summary": "Cancel subscription request" } }, "/startorder": { "get": { "operationId": "create-a-subscription-order", "parameters": [ { "description": "version version of the FlexPay call, `4` for this version.\nWhen processing without Orderpage, at least version 3.3 must be used.", "in": "query", "name": "version", "required": true, "schema": { "type": "number" } }, { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": true, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": true, "schema": { "type": "string" } }, { "description": "priceAmount amount to be processed in nnn.nn format", "in": "query", "name": "priceAmount", "required": true, "schema": { "type": "number" } }, { "description": "priceCurrency 3 char ISO code, must be one of the Sale currencies (`USD` `EUR` `GBP` `AUD` `CAD` `CHF` `DKK` `NOK` `SEK`)\nNOTE: only `EUR` is can be used for `DDEU` payment method system", "in": "query", "name": "priceCurrency", "required": true, "schema": { "type": "string" } }, { "description": "duration in ISO8601 format, for example: `P30D`, minimum is 7 days for `recurring` and 2 days for `on-time`", "in": "query", "name": "period", "required": true, "schema": { "type": "string" } }, { "description": "`one-time` or `recurring`\nNOTE: `DDEU` and `YOURSAFE_DIRECT` only support `one-time`", "in": "query", "name": "subscriptionType", "required": true, "schema": { "type": "string" } }, { "description": "amount to be processed in nnn.nn format for the initial trial period, minimum is 2 days", "in": "query", "name": "trialAmount", "required": false, "schema": { "type": "number" } }, { "description": "duration in ISO8601 format, for example: `P30D`", "in": "query", "name": "trialPeriod", "required": false, "schema": { "type": "string" } }, { "description": "description of the product. Text is displayed on the order page - max 100 printable characters", "in": "query", "name": "name", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT` or `DDEU` (if not set then buyers can choose from available payment methods)\nNOTE: `DDEU` is available only in DE, AT, CH, BE, IT, NL, ES and FR\nIf oneClickToken is sent, the payment method must be set to `CC`.\nWhen processing without Orderpage, `IDEAL` must be set.", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "merchant’s reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "URL for redirect after successful transaction - max 255 characters. Defaults to success landing URL on the website.", "in": "query", "name": "successURL", "required": false, "schema": { "type": "string" } }, { "description": "URL for redirect after declined transaction - max 255 characters. Defaults to decline landing URL on the website.", "in": "query", "name": "declineURL", "required": false, "schema": { "type": "string" } }, { "description": "email of the buyer. If not set, it will be collected on the Order Page\nNOTE: email is excluded from signature calculations (max 100 chars else it will be ignored)", "in": "query", "name": "email", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "servers": [ { "url": "https://secure.verotel.com" }, { "url": "https://secure.billing.creditcard" }, { "url": "https://secure.gaycharge.com" }, { "url": "https://secure.yoursafedirect.com" } ], "summary": "Create a subscription order" } }, "/status/order": { "get": { "operationId": "status-page-request", "parameters": [ { "description": "`4`", "in": "query", "name": "version", "required": false, "schema": { "type": "number" } }, { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "Merchant’s reference identifier if provided (referenceID OR saleID must be posted - NOT BOTH)", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "Verotel saleID identifier (referenceID OR saleID must be posted - NOT BOTH)", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "billingAddr_addressLine1": { "description": "billing address: 1st line field value", "type": "string" }, "billingAddr_addressLine2": { "description": "billing address: 2nd line field value", "type": "string" }, "billingAddr_city": { "description": "billing address: city name", "type": "string" }, "billingAddr_company": { "description": "billing address: company field value", "type": "string" }, "billingAddr_country": { "description": "billing address: country ISO code (ISO 3166-1-alpha-2 code)", "type": "string" }, "billingAddr_fullName": { "description": "billing address: full name field value", "type": "string" }, "billingAddr_state": { "description": "billing address: US state code (ISO 3166-2)", "type": "string" }, "billingAddr_zip": { "description": "billing address: zip code / postal code", "type": "string" }, "cancelled": { "description": "`yes` or `no`", "type": "string" }, "cancelledBy": { "description": "`user` `support` `merchant` `system`", "type": "string" }, "cancelledOn": { "description": "Timestamp of cancellation", "type": "string" }, "country": { "description": "selected or detected country ISO code (ISO 3166-1-alpha-2 code)", "type": "string" }, "createdOn": { "description": "Timestamp of purchase creation", "type": "string" }, "description": { "description": "Product description text - max 100 printable characters", "type": "string" }, "discountAmount": { "description": "reccurring amount after cancel discount confirmation by buyer", "type": "string" }, "email": { "description": "email address of the buyer", "type": "string" }, "error": { "description": "message (for response=`ERROR`)", "type": "string" }, "expired": { "description": "`yes` or `no`", "type": "string" }, "expiresOn": { "description": "when subscription will be terminated", "type": "string" }, "name": { "description": "name of the buyer", "type": "string" }, "oneClickToken": { "description": "If the feature is enabled - Currently valid oneClickToken", "type": "string" }, "paymentMethod": { "description": "an identifier of payment method that was used for the transaction.\nCan be one of following: `Credit Card` or `Direct Debit EU`", "type": "string" }, "period": { "description": "duration in ISO8601 format, for example: `P30D`", "type": "string" }, "priceAmount": { "description": "amount processed in nnn.nn format", "type": "string" }, "priceCurrency": { "description": "3 char ISO code of the Sale currency", "type": "string" }, "referenceID": { "description": "Merchant reference identifier - max 100 printable characters", "type": "string" }, "response": { "description": "`FOUND` - purchase record found and returned\n`NOTFOUND` - purchase not found\n`ERROR` - error (see ‘error’ key)", "type": "string" }, "saleID": { "description": "identifier of the transaction in Verotel System", "type": "string" }, "saleResult": { "description": "purchase processing result (APPROVED)", "type": "string" }, "shopID": { "description": "ID of website in Verotel system", "type": "string" }, "subscriptionType": { "description": "`one-time` or `recurring`", "type": "string" }, "trialAmount": { "description": "trial period processed amount", "type": "string" }, "trialPeriod": { "description": "duration of trial period in ISO8601 format", "type": "string" }, "type": { "description": "`purchase` or `subscription`", "type": "string" } }, "type": "object", "x-order": [ "response", "error", "saleID", "shopID", "paymentMethod", "priceAmount", "priceCurrency", "trialAmount", "trialPeriod", "discountAmount", "period", "description", "type", "subscriptionType", "expired", "expiresOn", "referenceID", "name", "email", "country", "oneClickToken", "cancelled", "cancelledOn", "cancelledBy", "expiresOn", "createdOn", "saleResult", "billingAddr_fullName", "billingAddr_company", "billingAddr_addressLine1", "billingAddr_addressLine2", "billingAddr_city", "billingAddr_zip", "billingAddr_state", "billingAddr_country" ] } } }, "description": "response: `FOUND` - purchase record found and returned\n`NOTFOUND` - purchase not found\n`ERROR` - error (see ‘error’ key)\nerror: message (for response=`ERROR`)\nsaleID: identifier of the transaction in Verotel System\nshopID: ID of website in Verotel system\npaymentMethod: an identifier of payment method that was used for the transaction.\nCan be one of following: `Credit Card` or `Direct Debit EU`\npriceAmount: amount processed in nnn.nn format\npriceCurrency: 3 char ISO code of the Sale currency\ntrialAmount: trial period processed amount\ntrialPeriod: duration of trial period in ISO8601 format\ndiscountAmount: reccurring amount after cancel discount confirmation by buyer\nperiod: duration in ISO8601 format, for example: `P30D`\ndescription: Product description text - max 100 printable characters\ntype: `purchase` or `subscription`\nsubscriptionType: `one-time` or `recurring`\nexpired: `yes` or `no`\nexpiresOn: date of subscription expiration in ISO8601 format\nreferenceID: Merchant reference identifier - max 100 printable characters\nname: name of the buyer\nemail: email address of the buyer\ncountry: selected or detected country ISO code (ISO 3166-1-alpha-2 code)\noneClickToken: If the feature is enabled - Currently valid oneClickToken\ncancelled: `yes` or `no`\ncancelledOn: Timestamp of cancellation\ncancelledBy: `user` `support` `merchant` `system`\nexpiresOn: when subscription will be terminated\ncreatedOn: Timestamp of purchase creation\nsaleResult: purchase processing result (APPROVED)\nbillingAddr_fullName: billing address: full name field value\nbillingAddr_company: billing address: company field value\nbillingAddr_addressLine1: billing address: 1st line field value\nbillingAddr_addressLine2: billing address: 2nd line field value\nbillingAddr_city: billing address: city name\nbillingAddr_zip: billing address: zip code / postal code\nbillingAddr_state: billing address: US state code (ISO 3166-2)\nbillingAddr_country: billing address: country ISO code (ISO 3166-1-alpha-2 code)" } }, "servers": [ { "url": "https://secure.verotel.com" }, { "url": "https://secure.billing.creditcard" }, { "url": "https://secure.gaycharge.com" }, { "url": "https://secure.yoursafedirect.com" } ], "summary": "Status page request" } }, "/upgrade-subscription-request/startorder": { "get": { "operationId": "upgrade-subscription-request", "parameters": [ { "description": "version version of the FlexPay call, `4` for this version", "in": "query", "name": "version", "required": true, "schema": { "type": "number" } }, { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": true, "schema": { "type": "number" } }, { "description": "`upgradesubscription`", "in": "query", "name": "type", "required": true, "schema": { "type": "string" } }, { "description": "Identificator of sale the buyer is upgrading from", "in": "query", "name": "precedingSaleID", "required": true, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "priceAmount", "required": true, "schema": { "type": "number" } }, { "description": "priceCurrency 3 char ISO code, must be one of the Sale currencies (`USD` `EUR` `GBP` `AUD` `CAD` `CHF` `DKK` `NOK` `SEK`)\nNOTE: only `EUR` is can be used for `DDEU` payment method system", "in": "query", "name": "priceCurrency", "required": true, "schema": { "type": "string" } }, { "description": "duration in ISO8601 format, for example: `P30D`, minimum is 7 days for `recurring` and 2 days for `on-time`", "in": "query", "name": "period", "required": true, "schema": { "type": "string" } }, { "description": "`one-time` or `recurring`\nNOTE: `DDEU` and `YOURSAFE_DIRECT` only support `one-time`", "in": "query", "name": "subscriptionType", "required": true, "schema": { "type": "string" } }, { "description": "description of the product. Text is displayed on the order page - max 100 printable characters", "in": "query", "name": "name", "required": false, "schema": { "type": "string" } }, { "description": "`lost` or `extend` - – this option defines how to deal with the remaining period from the previous sale, if not provided the remaining period is added to new sale (“same as “extend”)", "in": "query", "name": "upgradeOption", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT`, `DDEU` (if not set then buyers can choose from available payment methods)\nNOTE: `DDEU` is available only in DE, AT, CH, BE, IT, NL, ES and FR\nIf oneClickToken is sent, the payment method must be set to `CC`", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "URL for redirect after successful transaction - max 255 characters. Defaults to success landing URL on the website.", "in": "query", "name": "successURL", "required": false, "schema": { "type": "string" } }, { "description": "email of the buyer. If not set, it will be collected on the Order Page\nNOTE: email is excluded from signature calculations (max 100 chars else will be ignored)", "in": "query", "name": "email", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": true, "schema": { "type": "string" } }, { "description": "amount to be processed (max 2 decimal places, stripped zeroes) for the initial trial period", "in": "query", "name": "trialAmount", "required": false, "schema": { "type": "number" } }, { "description": "duration in ISO8601 format", "in": "query", "name": "trialPeriod", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "servers": [ { "url": "https://secure.verotel.com" }, { "url": "https://secure.billing.creditcard" }, { "url": "https://secure.gaycharge.com" }, { "url": "https://secure.yoursafedirect.com" } ], "summary": "Upgrade subscription request", "x-upstream-path": "/startorder" } } }, "webhooks": { "cancel-postback": { "get": { "operationId": "cancel-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`cancel`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "expiry date [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "expiresOn", "required": false, "schema": { "type": "string" } }, { "description": "`user` `support` `merchant` `system`", "in": "query", "name": "cancelledBy", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Cancel postback" } }, "chargeback-postback": { "get": { "operationId": "chargeback-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`chargeback`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "amount of chargebacked transaction", "in": "query", "name": "priceAmount", "required": false, "schema": { "type": "number" } }, { "description": "chargebacked transaction currency", "in": "query", "name": "priceCurrency", "required": false, "schema": { "type": "string" } }, { "description": "transaction id of credit transaction", "in": "query", "name": "transactionID", "required": false, "schema": { "type": "number" } }, { "description": "transaction id of transaction which was credited", "in": "query", "name": "parentID", "required": false, "schema": { "type": "number" } }, { "description": "`recurring` or `one-time`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`terminated`", "in": "query", "name": "subscriptionPhase", "required": false, "schema": { "type": "string" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Chargeback postback" } }, "credit-postback": { "get": { "operationId": "credit-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`credit`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "amount of refunded transaction", "in": "query", "name": "priceAmount", "required": false, "schema": { "type": "number" } }, { "description": "refunded transaction currency", "in": "query", "name": "priceCurrency", "required": false, "schema": { "type": "string" } }, { "description": "transaction id of credit transaction", "in": "query", "name": "transactionID", "required": false, "schema": { "type": "number" } }, { "description": "transaction id of transaction which was credited", "in": "query", "name": "parentID", "required": false, "schema": { "type": "number" } }, { "description": "`recurring` or `one-time`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`terminated` or `normal` (for partial credit without terminate initiated)", "in": "query", "name": "subscriptionPhase", "required": false, "schema": { "type": "string" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Credit postback" } }, "downgrade-postback": { "get": { "operationId": "downgrade-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`recurring` or `one-time`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`downgrade`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "amount", "required": false, "schema": { "type": "number" } }, { "description": "3 char ISO code of the Sale currency", "in": "query", "name": "currency", "required": false, "schema": { "type": "string" } }, { "description": "`normal`", "in": "query", "name": "subscriptionPhase", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Downgrade postback" } }, "expiry-postback": { "get": { "operationId": "expiry-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`recurring` or `one-time`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`expiry`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Expiry postback" } }, "extend-postback": { "get": { "operationId": "extend-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`recurring` or `one-time`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`extend`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "date when cancelled or one-time subscription expires, or date of the next planned rebill [yyyy-mm-dd] e.g “2015-04-24”", "in": "query", "name": "nextChargeOn or expiresOn", "required": false, "schema": { "type": "string" } }, { "description": "`trial` `normal` `discounted`", "in": "query", "name": "subscriptionPhase", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Extend postback" } }, "initial-postback": { "get": { "operationId": "initial-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`one-time` or `recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`initial`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "identifier of the transaction in the Verotel system (only avaible for postbacks version 2)", "in": "query", "name": "transactionID", "required": false, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "priceAmount", "required": false, "schema": { "type": "number" } }, { "description": "3 char ISO code of the Sale currency", "in": "query", "name": "priceCurrency", "required": false, "schema": { "type": "string" } }, { "description": "subscription duration in ISO8601 format", "in": "query", "name": "period", "required": false, "schema": { "type": "string" } }, { "description": "amount to be processed (max 2 decimal places, stripped zeroes) for the initial trial period", "in": "query", "name": "trialAmount", "required": false, "schema": { "type": "number" } }, { "description": "duration in ISO8601 format", "in": "query", "name": "trialPeriod", "required": false, "schema": { "type": "string" } }, { "description": "date of next rebill or expiry date [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "expiresOn or nextChargeOn", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT`, `DDEU`", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } }, { "description": "Truncated (masked) payment instrument identification, e.g. card number", "in": "query", "name": "truncatedPAN", "required": false, "schema": { "type": "string" } }, { "description": "Only present if paid via Credit Card, represents the card brand, e.g. VISA", "in": "query", "name": "CCBrand", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Initial postback" } }, "rebill-postback": { "get": { "operationId": "rebill-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`rebill`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "identifier of the transaction in Verotel system", "in": "query", "name": "transactionID", "required": false, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "amount", "required": false, "schema": { "type": "number" } }, { "description": "3 char ISO code of the Sale currency", "in": "query", "name": "currency", "required": false, "schema": { "type": "string" } }, { "description": "date of next rebill [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "nextChargeOn", "required": false, "schema": { "type": "string" } }, { "description": "`normal` or `discounted`", "in": "query", "name": "subscriptionPhase", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT`, `DDEU`", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Rebill postback" } }, "success-redirect": { "get": { "operationId": "success-redirect", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`one-time` or `recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`initial`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "priceAmount", "required": false, "schema": { "type": "number" } }, { "description": "3 char ISO code of the Sale currency", "in": "query", "name": "priceCurrency", "required": false, "schema": { "type": "string" } }, { "description": "subscription duration in ISO8601 format", "in": "query", "name": "period", "required": false, "schema": { "type": "string" } }, { "description": "amount to be processed (max 2 decimal places, stripped zeroes) for the initial trial period", "in": "query", "name": "trialAmount", "required": false, "schema": { "type": "number" } }, { "description": "duration in ISO8601 format", "in": "query", "name": "trialPeriod", "required": false, "schema": { "type": "string" } }, { "description": "date of next rebill or expiry date [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "expiresOn or nextChargeOn", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT`, `DDEU`", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Success redirect" } }, "success-redirect-2": { "get": { "operationId": "success-redirect", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`one-time` or `recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`initial`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "priceAmount", "required": false, "schema": { "type": "number" } }, { "description": "3 char ISO code of the Sale currency", "in": "query", "name": "priceCurrency", "required": false, "schema": { "type": "string" } }, { "description": "subscription duration in ISO8601 format", "in": "query", "name": "period", "required": false, "schema": { "type": "string" } }, { "description": "amount to be processed (max 2 decimal places, stripped zeroes) for the initial trial period", "in": "query", "name": "trialAmount", "required": false, "schema": { "type": "number" } }, { "description": "duration in ISO8601 format", "in": "query", "name": "trialPeriod", "required": false, "schema": { "type": "string" } }, { "description": "date of next rebill or expiry date [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "expiresOn or nextChargeOn", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT`, `DDEU`", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Success redirect" } }, "uncancel-postback": { "get": { "operationId": "uncancel-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`uncancel`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier. It must be unique if provided", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "date of the next planned rebill [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "nextChargeOn", "required": false, "schema": { "type": "string" } }, { "description": "`trial` `normal` `discounted`", "in": "query", "name": "subscriptionPhase", "required": false, "schema": { "type": "string" } }, { "description": "`support`", "in": "query", "name": "uncancelledBy", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Uncancel postback" } }, "upgrade-postback": { "get": { "operationId": "upgrade-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`one-time` or `recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`upgrade`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier if provided in the first sale.", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "identifier of the transaction in the Verotel system (only avaible for postbacks version 2)", "in": "query", "name": "transactionID", "required": false, "schema": { "type": "number" } }, { "description": "Identifier of the previous sale the enduser is switching from", "in": "query", "name": "precededBySaleID", "required": false, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "priceAmount", "required": false, "schema": { "type": "number" } }, { "description": "3 char ISO code of the Sale currency", "in": "query", "name": "priceCurrency", "required": false, "schema": { "type": "string" } }, { "description": "subscription duration in ISO8601 format", "in": "query", "name": "period", "required": false, "schema": { "type": "string" } }, { "description": "date of next rebill or expiry date [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "expiresOn or nextChargeOn", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT`, `DDEU`", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } }, { "description": "Truncated (masked) payment instrument identification, e.g. card number", "in": "query", "name": "truncatedPAN", "required": false, "schema": { "type": "string" } }, { "description": "Only present if paid via Credit Card, represents the card brand, e.g. VISA", "in": "query", "name": "CCBrand", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Upgrade postback" } }, "upgrade-postback-2": { "get": { "operationId": "upgrade-postback", "parameters": [ { "description": "numerical ID of the website in the Verotel system", "in": "query", "name": "shopID", "required": false, "schema": { "type": "number" } }, { "description": "`subscription`", "in": "query", "name": "type", "required": false, "schema": { "type": "string" } }, { "description": "`one-time` or `recurring`", "in": "query", "name": "subscriptionType", "required": false, "schema": { "type": "string" } }, { "description": "`upgrade`", "in": "query", "name": "event", "required": false, "schema": { "type": "string" } }, { "description": "merchant reference identifier if provided in the first sale.", "in": "query", "name": "referenceID", "required": false, "schema": { "type": "string" } }, { "description": "identifier of the sale in the Verotel system", "in": "query", "name": "saleID", "required": false, "schema": { "type": "number" } }, { "description": "identifier of the transaction in the Verotel system (only avaible for postbacks version 2)", "in": "query", "name": "transactionID", "required": false, "schema": { "type": "number" } }, { "description": "Identifier of the previous sale the enduser is switching from", "in": "query", "name": "precededBySaleID", "required": false, "schema": { "type": "number" } }, { "description": "amount to be processed in nnn.nn format", "in": "query", "name": "priceAmount", "required": false, "schema": { "type": "number" } }, { "description": "3 char ISO code of the Sale currency", "in": "query", "name": "priceCurrency", "required": false, "schema": { "type": "string" } }, { "description": "subscription duration in ISO8601 format", "in": "query", "name": "period", "required": false, "schema": { "type": "string" } }, { "description": "date of next rebill or expiry date [yyyy-mm-dd] eq. “2015-04-24”", "in": "query", "name": "expiresOn or nextChargeOn", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom1", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom2", "required": false, "schema": { "type": "string" } }, { "description": "pass-through variable - max 255 printable characters", "in": "query", "name": "custom3", "required": false, "schema": { "type": "string" } }, { "description": "payment method, `CC`, `YOURSAFE_DIRECT`, `DDEU`", "in": "query", "name": "paymentMethod", "required": false, "schema": { "type": "string" } }, { "description": "Signature calculation", "in": "query", "name": "signature", "required": false, "schema": { "type": "string" } }, { "description": "Truncated (masked) payment instrument identification, e.g. card number", "in": "query", "name": "truncatedPAN", "required": false, "schema": { "type": "string" } }, { "description": "Only present if paid via Credit Card, represents the card brand, e.g. VISA", "in": "query", "name": "CCBrand", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "summary": "Upgrade postback" } } } }