Merchant-initiated transactions

Note

A saved card must have a mandate attached to be used for merchant-initiated transactions. A mandate is returned if the payment or setup intent was successfully confirmed. For more information, see Mandates.

A merchant-initiated transaction is a transaction initiated by the integration (merchant) and not the customer. Some examples of merchant-initiated transactions include charging for a monthly wine club subscription, charging fixed payments for large catering orders, or charging a one-time fee (unscheduled) payment such as a restaurant reservation fee.

After you have completed a customer-initiated transaction and created a card-on-file, you use the mandateId from the PaymentIntentResponse, SetupIntent response, or the ConfirmIntentResultEvent to create and confirm a payment intent.

For merchant-initiated transactions, you can use either a card-on-file or a saved card.

• Card-on-file: The payment card is created during the customer-initiated payment or setup intent transaction and can be used for future transactions. The payment card is not associated with a customer record and cannot be selected in the hosted checkout iframe. The card-on-file is deleted after the transaction is completed.

  Note

  After the transaction is complete, your integration must revoke (delete) the mandate associated with the transaction. For more information, see Revoking a mandate. After the mandate is revoked, then the payment method can be deleted. For more information, see Deleting a payment method.

  To authorize a payment card for merchant-initiated transactions, the customer must select the I authorize this business to charge my card as outlined in the terms checkbox in the hosted checkout integration iframe.

• Saved card: The payment card is created during the customer-initiated payment or setup intent workflow and can be used for future transactions. The payment card is associated with a customer record. To use a saved card for merchant-initiated transactions, the customer must have selected the Remember this card checkbox in the hosted checkout iframe to save the card during a previous customer-initiated transaction. Saved cards are displayed in the hosted checkout iframe for the customer to use once they log into their customer profile.

  To authorize a payment card to be used for merchant-initiated transactions, the customer must select the I authorize this business to charge my card as outlined in the terms checkbox in the hosted checkout integration iframe.