Tesouro currently supports recurring payments only. Support for other MIT types is planned for
a future release.
- You need to charge a cardholder on a scheduled, recurring basis (e.g., monthly subscription, weekly service fee).
- The cardholder is not actively present to authorize the payment.
- You have a prior customer initiated transaction or account verification on file to reference.
ExampleLast month, Ben subscribed to StreamHQ’s monthly plan. Each subsequent month,
StreamHQ submits a merchant initiated recurring transaction to charge Ben’s card on file. Because Ben consented to recurring charges during sign-up, StreamHQ can charge his card each month without requiring him to actively authorize each payment.
Prerequisites
EveryauthorizeRecurring request must reference a prior transaction from Tesouro’s platform. Before submitting a merchant initiated transaction, you must have on file either:
- A previously approved customer initiated transaction, or
- A previously approved account verification
paymentId and the date of that original transaction to complete the request.
Steps
- Call the authorizeRecurring mutation, passing in the required and optional input fields:
| Required input | Description |
|---|---|
acceptorId | The unique, 36 character identifier assigned to the entity providing the goods or services to the cardholder. Other processors may refer to this as the Merchant ID (MID), Outlet ID, or Customer number. |
transactionReference | The unique transaction identifier created by YOU to distinguish this transaction from another. |
channel | How the consumer interacts with the acceptor. Defaults to ECOMMERCE if not provided. |
paymentMethodDetails | Includes the pertinent payment method details for the card being charged. Accepts an acquirer token, a full PAN, or a network token pass-through. |
transactionAmountDetails | The amount of the transaction and its currency. |
citReference | A reference to the paymentId of the original customer initiated transaction or account verification that established the cardholder’s consent. |
originalPurchaseDate | The submission date of the original customer initiated transaction or account verification being referenced, as recorded within the partner’s system. |
automaticCapture | Specifies if the authorization should be automatically captured upon approval. If you instruct to not automatically capture the authorization, keep track of the paymentId in the response, as it will be needed to capture the authorization. If you instructed to automatically capture upon approval, then you are done with the authorization. |
CIT reference
EveryauthorizeRecurring request must include a citReference pointing to a prior customer initiated transaction or account verification processed through Tesouro. This reference is how the card networks verify that the cardholder previously consented to recurring charges.
The citReference input accepts two forms depending on where the original transaction was processed:
| Scenario | Fields to provide |
|---|---|
| The original CIT or card verification was processed through Tesouro | citReference.citPaymentId — the paymentId returned in the original transaction response |
| The original CIT was processed through another processor | citReference.mitPassThrough.citNetworkTransactionId — the network transaction ID from the original processor’s response |
Automatic capture
Automatically capturing an authorization upon approval instructs Tesouro to submit a capture request on your behalf without requiring additional information or actions from you. To know if you should automatically capture upon approval, use the following chart:| Scenarios | Input |
|---|---|
| If the final amount to capture will NOT change from the authorized amount And all product line items will be shipped (or rendered) together | automaticCapture:"ON_APPROVAL" |
| If the final amount to capture may change from the authorized amount And some or all of the purchased goods or services are not immediately available to ship or render at the time of authorization. | automaticCapture:"NEVER" |
Payment transaction reason
When submitting an authorization, accurately specifying thereason for the payment request can:
- Help qualify the transaction for better interchange rates
- Ensure proper processing and reporting
- Comply with relevant financial regulations
GENERAL_PURCHASE.
Supported reasons:
| Value | Description |
|---|---|
GENERAL_PURCHASE | Standard purchases of goods or services. |
DEBT_REPAYMENT | The payment will be used to reduce or eliminate an outstanding debt, such as credit card balances, loans, or other forms of borrowing. |