{"title":"Recurring payments with Pix","category":"default","creationDate":1676638860,"content":"<div class=\"additional-info-block output-inline\">\n<div class=\"additional-info-block__body\"><p><img style=\"width: 40px;\" alt=\"\" src=\"\/user\/pages\/docs\/08.payment-methods\/72.pix\/16.recurring-payments\/pix.svg?decoding=auto&amp;fetchpriority=auto\" \/>&nbsp; <strong>Read more<\/strong><\/p><p>Learn more about <a href=\"https:\/\/www.bcb.gov.br\/detalhenoticia\/699\/noticia\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Pix Autom\u00e1tico<\/a>.<\/p><\/div><\/div>\n\n<p>You can accept <a href=\"\/pt\/online-payments\/tokenization\/#recurring-payment-types\">subscription payments<\/a> with Pix, also known as Pix Autom\u00e1tico. Pix Autom\u00e1tico lets you choose from various billing cycles, and fixed or variable recurring amounts. It also allows you to retry failed subscription payments.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that you have built an <a href=\"\/pt\/online-payments\/build-your-integration\/advanced-flow\/?platform=Web&amp;integration=API%20only&amp;version=latest\">API-only<\/a> integration using Checkout API v49 or later.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/webhooks\">Webhooks<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Subscribe to the following webhook(s): <ul><li>Standard webhooks<\/li><li><a href=\"\/pt\/development-resources\/webhooks\/webhook-types#other-webhooks\">Recurring tokens life cycle events<\/a> webhook<\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\"><ul><li>This feature is in development. If you are interested in joining the pilot, reach out to your Adyen contact. Some of the processes and documentation may change as the feature evolves.<\/li><li>Recurring Pix payments are only available for the <span translate=\"no\"><strong>Subscription<\/strong><\/span> <a href=\"\/pt\/online-payments\/tokenization\/#recurring-payment-types\">recurring processing model<\/a>.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin: <ul><li><a href=\"\/pt\/payment-methods\/add-payment-methods\/\">Add Pix in your Customer Area<\/a>.<\/li><li>Integrate with <a href=\"\/pt\/payment-methods\/pix\/api-only\/\">Pix for API only<\/a>.<\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"flows\">Authorization flows for subscription payments<\/h2>\n<p>You can offer two types of recurring payment flows:<\/p>\n<ul>\n<li><strong>Authorization with QR code<\/strong>: Set up a subscription payment to bill shoppers regularly, where an initial payment is not required. This flow is ideal for setting up trial subscriptions. The Brazilian Central Bank refers to this flow as <span translate=\"no\"><strong>Journey 2<\/strong><\/span>.<\/li>\n<li><strong>Authorization and payment with QR code<\/strong>: Set up a subscription payment to bill shoppers regularly, and charge them. This flow is ideal for subscriptions that require an initial payment to start, or when combining a one-off purchase with signing up to a subscription service.  The Brazilian Central Bank refers to this flow as <span translate=\"no\"><strong>Journey 3<\/strong><\/span>.<\/li>\n<\/ul>\n<h2>How it works<\/h2>\n<p>The recurring payment flow with Pix works as follows:<\/p>\n<ol>\n<li>You make a  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> request to:\n<ul>\n<li>Specify the frequency, amount, and other details for a subscription.<\/li>\n<li>If you are using the <strong>Authorization and payment (Journey 3)<\/strong> flow, make an initial payment for the subscription, or for a one-off purchase.<\/li>\n<\/ul><\/li>\n<li>You show a QR code or QR code data for the shopper to copy, using the <code>action<\/code> object you receive in the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> response.<\/li>\n<li>After the shopper confirms their subscription, you get the confirmation that the token is created in a <a href=\"\/pt\/online-payments\/tokenization\/managing-tokens#webhooks\">Recurring tokens lifecycle events webhook<\/a>.\n<ul>\n<li>If you are using the <strong>Authorization and payment (Journey 3)<\/strong> flow, you also get an  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/AUTHORISATION\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">AUTHORISATION<\/a> webhook that informs you of the outcome of the immediate transaction.<\/li>\n<\/ul><\/li>\n<li>Before the expected billing date, you make a  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> request to charge the shopper for the subscription.<\/li>\n<li>After the billing date, you get a  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/CAPTURE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">CAPTURE<\/a> webhook that informs you of the payment result.<\/li>\n<\/ol>\n<p>If a subscription payment fails, we notify you in a  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/CAPTURE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">CAPTURE<\/a>, or  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/EXPIRE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">EXPIRE<\/a> webhook. You can <a href=\"#retry-a-recurring-payment\">retry the payment<\/a> up to three times.<\/p>\n<h2 id=\"create-token-with-billing-plan\">Create a token with a billing plan<\/h2>\n<div class=\"notices yellow\">\n<p>We strongly recommend that you ask explicit permission from the shopper if you intend to make future recurring payments. Being transparent about the payment schedule and the charged amount reduces the risk of chargebacks.<\/p>\n<\/div>\n<p>To set up a billing plan for a shopper, you need to store their payment details and specify the details of the subscription. If you are using the <strong>Authorization and payment<\/strong> <a href=\"#flows\">flow<\/a>, you make one request that combines the one-off payment and the billing plan setup.<\/p>\n<ol>\n<li>\n<p>Make a <span translate=\"no\"><strong>POST<\/strong><\/span>  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> request. In your request, include:<\/p>\n<ul>\n<li>\n<p><strong>Standard tokenization parameters<\/strong>:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameters<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>paymentMethod.type<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td><span translate=\"no\"><strong>pix<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperReference\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperReference<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Your unique identifier for the shopper. Minimum length: three characters. This field is case-sensitive. <div class=\"sc-notice note\"><div> Do not include personally identifiable information (PII), such as name or email address.  <\/div><\/div><\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperInteraction\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperInteraction<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Set to <span translate=\"no\"><strong>Ecommerce<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-recurringProcessingModel\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">recurringProcessingModel<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Set to <span translate=\"no\"><strong>Subscription<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-storePaymentMethod\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">storePaymentMethod<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Set to <span translate=\"no\"><strong>true<\/strong><\/span> to store the shopper's payment details for future recurring payments.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-amount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">amount<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The <code>currency<\/code> and <code>value<\/code> of the payment, in <a href=\"\/pt\/development-resources\/currency-codes\/\">minor units<\/a>. Set the <code>amount.value<\/code> field depending on your <a href=\"#flows\">authorization flow<\/a>: <ul><li><strong>Authorization with QR code (Journey 2)<\/strong>: Set to <strong>0<\/strong> to validate the payment details with a <a href=\"\/pt\/get-started-with-adyen\/adyen-glossary\/#zero-value-auth\">zero-auth<\/a> transaction before processing payments.<\/li><li><strong>Authorization and payment with QR code (Journey 3)<\/strong>: Set to the payment amount for the immediate payment.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p><strong>Pix-specific parameters<\/strong>:<\/p>\n<table>\n<thead>\n<tr>\n<th>Parameters<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperName\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperName<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The first and last name of the shopper.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-socialSecurityNumber\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">socialSecurityNumber<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The shopper's CPF or CNPJ number. This will be shown to the shopper on the Pix payment form.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.frequency<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The frequency at which the shopper will be charged. Possible values: <span translate=\"no\"><strong>weekly<\/strong><\/span>, <span translate=\"no\"><strong>monthly<\/strong><\/span>, <span translate=\"no\"><strong>quarterly<\/strong><\/span>, <span translate=\"no\"><strong>half-yearly<\/strong><\/span>, and <span translate=\"no\"><strong>yearly<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.recurringStatement<\/code><\/td>\n<td><\/td>\n<td>The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. <br> Maximum length: 35 characters.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.minAmount<\/code><\/td>\n<td><\/td>\n<td>For a billing plan where the payment amounts are variable, the <code>currency<\/code> and <code>value<\/code> of the minimum amount to charge the shopper for each recurring payment, in <a href=\"\/pt\/development-resources\/currency-codes\/\">minor units<\/a>. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.recurringAmount<\/code><\/td>\n<td><\/td>\n<td>For a billing plan where the payment amount is fixed, the <code>currency<\/code> and <code>value<\/code> for each recurring payment, in <a href=\"\/pt\/development-resources\/currency-codes\/\">minor units<\/a>.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.startsAt<\/code><\/td>\n<td><\/td>\n<td>Start date of the billing plan, in <span translate=\"no\"><strong>YYYY-MM-DD<\/strong><\/span> format. The default value is the transaction date.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.endsAt<\/code><\/td>\n<td><\/td>\n<td>End date of the billing plan, in <span translate=\"no\"><strong>YYYY-MM-DD<\/strong><\/span> format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is <a href=\"#cancel-a-billing-plan\">cancelled<\/a> by the shopper.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.retryPolicy<\/code><\/td>\n<td><\/td>\n<td>When set to <span translate=\"no\"><strong>true<\/strong><\/span>, you can <a href=\"#retry\">retry<\/a> for failed recurring payments. The default value is <span translate=\"no\"><strong>true<\/strong><\/span>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Set up a billing plan with a fixed amount'\" :id=\"'pix-recurring'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/checkout-test.adyen.com\\\/v72\\\/payments \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-d '{\\n        \\&quot;merchantAccount\\&quot;: \\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;,\\n        \\&quot;amount\\&quot;: {\\n            \\&quot;currency\\&quot;: \\&quot;BRL\\&quot;,\\n            \\&quot;value\\&quot;: 100000\\n        },\\n        \\&quot;reference\\&quot;: \\&quot;YOUR_PAYMENT_REFERENCE\\&quot;,\\n        \\&quot;paymentMethod\\&quot;: {\\n            \\&quot;type\\&quot;: \\&quot;pix\\&quot;,\\n            \\&quot;pixRecurring\\&quot;: {\\n                \\&quot;recurringStatement\\&quot;: \\&quot;YOUR_BILLING_STATEMENT\\&quot;,\\n                \\&quot;recurringAmount\\&quot;: {\\n                    \\&quot;currency\\&quot;: \\&quot;BRL\\&quot;,\\n                    \\&quot;value\\&quot;: 10000\\n                },\\n                \\&quot;frequency\\&quot;: \\&quot;monthly\\&quot;,\\n                \\&quot;startsAt\\&quot;: \\&quot;2025-08-01\\&quot;,\\n                \\&quot;endsAt\\&quot;: \\&quot;2025-12-01\\&quot;,\\n                \\&quot;retryPolicy\\&quot;: \\&quot;true\\&quot;\\n            }\\n        },\\n        \\&quot;shopperName\\&quot;: {\\n            \\&quot;firstName\\&quot;: \\&quot;John\\&quot;,\\n            \\&quot;lastName\\&quot;: \\&quot;Smith\\&quot;\\n        },\\n        \\&quot;shopperReference\\&quot;: \\&quot;YOUR_SHOPPER_REFERENCE\\&quot;,\\n        \\&quot;shopperInteraction\\&quot;: \\&quot;Ecommerce\\&quot;,\\n        \\&quot;recurringProcessingModel\\&quot;: \\&quot;Subscription\\&quot;,\\n        \\&quot;storePaymentMethod\\&quot;: \\&quot;true\\&quot;,\\n        \\&quot;socialSecurityNumber\\&quot;: \\&quot;01234567890\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>The response contains the following data:<\/p>\n<ul>\n<li><a href=\"\/pt\/online-payments\/build-your-integration\/payment-result-codes\/\">\n  <code>resultCode<\/code>\n<\/a>: informs you about the status of subscription setup and the payment.<\/li>\n<li><code>action<\/code>: contains the <code>qrCodeData<\/code>.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>From the response, use the <code>action<\/code> field that contains the <code>qrCodeData<\/code> to <a href=\"\/pt\/payment-methods\/pix\/api-only\/#present-qr-code\">render the QR code or present the QR code data<\/a>.<\/p>\n<\/li>\n<li>\n<p>Wait for the following <a href=\"\/pt\/development-resources\/webhooks\">webhooks<\/a> to get:<\/p>\n<ul>\n<li>The outcome of your request.<\/li>\n<li>The <code>storedPaymentMethodId<\/code> that you need to include in subsequent recurring payment requests.<\/li>\n<\/ul>\n<table>\n<thead>\n<tr>\n<th>Webhook<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/AUTHORISATION\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">AUTHORISATION<\/a><\/td>\n<td>Informs you whether the amount for the immediate payment is authorized.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Tokenization-webhooks\/latest\/post\/recurring.token.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">recurring.token.created<\/a><\/td>\n<td>Contains the <code>shopperReference<\/code>, and the <code>storedPaymentMethodId<\/code>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<div class=\"notices green\">\n<p>If you need to make changes to a billing plan after setting it up, you have to <a href=\"#cancel-a-billing-plan\">cancel the billing plan<\/a>, and create a new one.<\/p>\n<\/div>\n<h2 id=\"make-recurring-payments\">Make recurring payments<\/h2>\n<p>Make a request for the recurring payment within a period of ten to two days before the billing date. This is called the schedule window. For example, if the expected billing date is August 12, 2025, you can make the request between August 02 and August 10 to schedule the payment.<\/p>\n<ol>\n<li>\n<p>Make a <span translate=\"no\"><strong>POST<\/strong><\/span>  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> request, including:<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>paymentMethod.type<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td><span translate=\"no\"><strong>pix<\/strong><\/span><\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.storedPaymentMethodId<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The token for the shopper's stored payment details. This is the <code>storedPaymentMethodId<\/code> from the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Tokenization-webhooks\/latest\/post\/recurring.token.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">recurring.token.created<\/a> webhook.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-amount\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">amount<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The <code>currency<\/code> and <code>value<\/code> of the recurring payment, in <a href=\"\/pt\/development-resources\/currency-codes\/\">minor units<\/a>. <ul><li>If you included the <code>recurringAmount<\/code> field when you <a href=\"#create-token-with-billing-plan\">created the billing plan<\/a>, the amount must match the one in your initial request to create the token. <\/li><li>If you included the <code>minAmount<\/code> field when you <a href=\"#create-token-with-billing-plan\">created the billing plan<\/a>, you can set a new amount.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperReference\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperReference<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Your unique identifier for the shopper. Must be the same one you included with the <a href=\"#create-token-with-billing-plan\">request to create the token with a billing plan<\/a>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperInteraction\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperInteraction<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Set to <span translate=\"no\"><strong>ContAuth<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-recurringProcessingModel\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">recurringProcessingModel<\/a><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>Set to <span translate=\"no\"><strong>Subscription<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.billingDate<\/code><\/td>\n<td><img title=\"-white_check_mark-\" alt=\"-white_check_mark-\" class=\"smileys\" src=\"\/user\/data\/smileys\/emoji\/white_check_mark.png\" \/><\/td>\n<td>The date on which the shopper's payment method will be charged, in <span translate=\"no\"><strong>YYYY-MM-DD<\/strong><\/span> format.<\/td>\n<\/tr>\n<tr>\n<td><code>paymentMethod.pixRecurring.businessDayOnly<\/code><\/td>\n<td><\/td>\n<td>When set to <span translate=\"no\"><strong>true<\/strong><\/span>, if the <code>billingDate<\/code> is not a business day, the payment will be processed on the next business day. The default value is <span translate=\"no\"><strong>false<\/strong><\/span>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-component-wrapper=\"code-sample\">\n<code-sample :title=\"'Make a recurring payment'\" :id=\"'pix-recurring-payment'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/checkout-test.adyen.com\\\/v72\\\/payments \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-d '{\\n        \\&quot;merchantAccount\\&quot;: \\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;,\\n        \\&quot;amount\\&quot;: {\\n            \\&quot;currency\\&quot;: \\&quot;BRL\\&quot;,\\n            \\&quot;value\\&quot;: 100000\\n        },\\n        \\&quot;reference\\&quot;: \\&quot;YOUR_PAYMENT_REFERENCE\\&quot;,\\n        \\&quot;paymentMethod\\&quot;: {\\n            \\&quot;type\\&quot;: \\&quot;pix\\&quot;,\\n            \\&quot;storedPaymentMethodId\\&quot;: \\&quot;M5N7TQ4TG5PFWR50\\&quot;,\\n            \\&quot;pixRecurring\\&quot;: {\\n                \\&quot;billingDate\\&quot;: \\&quot;2025-08-01\\&quot;\\n            }\\n        },\\n        \\&quot;shopperReference\\&quot;: \\&quot;YOUR_SHOPPER_REFERENCE\\&quot;,\\n        \\&quot;shopperInteraction\\&quot;: \\&quot;ContAuth\\&quot;,\\n        \\&quot;recurringProcessingModel\\&quot;: \\&quot;Subscription\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>After you make the request to schedule the payment, the response contains:<\/p>\n<ul>\n<li><a href=\"\/pt\/online-payments\/build-your-integration\/payment-result-codes\/\">\n  <code>resultCode<\/code>\n<\/a>: <span translate=\"no\"><strong>Pending<\/strong><\/span>.<\/li>\n<\/ul>\n<\/li>\n<li>\n<p>When the payment scheduling is confirmed, you receive an  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/AUTHORISATION\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">AUTHORISATION<\/a> webhook. If you receive:<\/p>\n<ul>\n<li><code>success<\/code>: <span translate=\"no\"><strong>true<\/strong><\/span>, the payment is successfully scheduled, and the shopper will be charged for the subscription on the billing date you specified.<\/li>\n<li><code>success<\/code>: <span translate=\"no\"><strong>false<\/strong><\/span>, the payment was not successfully scheduled. This can happen when:\n<ul>\n<li>The amount in the request does not match the amount you specified when you <a href=\"#create-token-with-billing-plan\">created the billing plan<\/a>.<\/li>\n<li>A payment was already scheduled for this billing cycle.<\/li>\n<li>The request to schedule was not sent during the <a href=\"#make-recurring-payments\">schedule window<\/a>.<\/li>\n<li>The details in your request to schedule does not match a successfully created <a href=\"#create-token-with-billing-plan\">billing plan<\/a>.<\/li>\n<\/ul><\/li>\n<\/ul>\n<\/li>\n<li>\n<p>After the billing date you specified in the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> request, wait for a webhook to learn about the outcome of the subscription transaction.<\/p>\n<table>\n<thead>\n<tr>\n<th>Webhook<\/th>\n<th><code>success<\/code><\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/CAPTURE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">CAPTURE<\/a><\/td>\n<td><span translate=\"no\"><strong>true<\/strong><\/span><\/td>\n<td>The shopper was successfully charged for the subscription.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/CAPTURE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">CAPTURE<\/a><\/td>\n<td><span translate=\"no\"><strong>false<\/strong><\/span><\/td>\n<td>Adyen received a notification from the shopper's bank that the subscription payment failed. Save the <code>pspReference<\/code> from this webhook to <a href=\"#retry\">retry<\/a> the payment.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/EXPIRE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">EXPIRE<\/a><\/td>\n<td><span translate=\"no\"><strong>true<\/strong><\/span><\/td>\n<td>The subscription amount was not captured, and Adyen did not receive any notification from the shopper's bank. Save the <code>pspReference<\/code> from this webhook to <a href=\"#retry\">retry<\/a> the payment.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<h2 id=\"retry\">Retry a recurring payment<\/h2>\n<p>If you receive one of the following after the billing date, you can retry the payment up to three times:<\/p>\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/CAPTURE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">CAPTURE<\/a> webhook with <code>success<\/code>: <span translate=\"no\"><strong>false<\/strong><\/span><\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Webhooks\/latest\/post\/EXPIRE\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">EXPIRE<\/a> webhook<\/li>\n<\/ul>\n<div class=\"notices green\">\n<p>You can only retry recurring payments if the <code>paymentMethod.pixRecurring.retryPolicy<\/code> was enabled in your request to <a href=\"#create-token-with-billing-plan\">create the billing plan<\/a>.<\/p>\n<\/div>\n<p>To retry a recurring payment, copy your <a href=\"#make-recurring-payments\">failed recurring payment request<\/a>, including:<\/p>\n<ul>\n<li>The same fields you used in your first recurring payment request. Make sure that the <code>amount<\/code> in your retry request is the same as the <code>amount<\/code> from the failed recurring payment request.<\/li>\n<li>A new <code>paymentMethod.pixRecurring.billingDate<\/code>:\n<ul>\n<li>Must be at least 24 hours later than when you are making the request.<\/li>\n<li>Must be within seven days from the billing date of the failed recurring payment.<\/li>\n<\/ul><\/li>\n<li><code>paymentMethod.pixRecurring.originalPspReference<\/code>: The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#responses-200-pspReference\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">pspReference<\/a> for the failed recurring payment. Find this in <span translate=\"no\"><strong>CAPTURE<\/strong><\/span>, or <span translate=\"no\"><strong>EXPIRE<\/strong><\/span> webhook you received after the billing date.<\/li>\n<\/ul>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Retry a recurring payment'\" :id=\"'pix-recurring-retry'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/checkout-test.adyen.com\\\/v72\\\/payments \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-d '{\\n    \\&quot;merchantAccount\\&quot;: \\&quot;ADYEN_MERCHANT_ACCOUNT\\&quot;,\\n    \\&quot;amount\\&quot;: {\\n        \\&quot;currency\\&quot;: \\&quot;BRL\\&quot;,\\n        \\&quot;value\\&quot;: 100000\\n    },\\n    \\&quot;paymentMethod\\&quot;: {\\n        \\&quot;type\\&quot;: \\&quot;pix\\&quot;,\\n        \\&quot;storedPaymentMethodId: \\&quot;M5N7TQ4TG5PFWR50\\&quot;,\\n        \\&quot;pixRecurring\\&quot;: {\\n            \\&quot;billingDate\\&quot;: \\&quot;2025-08-05\\&quot;,\\n            \\&quot;originalPspReference\\&quot;: \\&quot;JDD6LKT8MBLZNN84\\&quot;\\n    },\\n    \\&quot;shopperReference\\&quot;: \\&quot;YOUR_SHOPPER_REFERENCE\\&quot;,\\n    \\&quot;shopperInteraction\\&quot;: \\&quot;ContAuth\\&quot;,\\n    \\&quot;recurringProcessingModel\\&quot;: \\&quot;Subscription\\&quot;\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2 id=\"cancel-a-billing-plan\">Cancel a billing plan<\/h2>\n<p>If your shopper wants to end their billing plan, you need to cancel the billing plan generated for their stored payment details on your side.<\/p>\n<p><a href=\"\/pt\/online-payments\/tokenization\/managing-tokens\/#delete-stored-details\">Delete the token<\/a> with a <span translate=\"no\"><strong>DELETE<\/strong><\/span>  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/delete\/storedPaymentMethods\/(storedPaymentMethodId)\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/storedPaymentMethods\/{storedPaymentMethodId}<\/a> request.<\/p>\n<p>Shoppers can also request to cancel the billing plan from their bank. In these cases, Adyen deletes the token on your behalf. It is still your responsibility to make sure any remaining shopper details are deleted from your servers, after payment details stored with Adyen are deleted.<\/p>\n<p>When a token is deleted, you receive a <code>recurring.token.disabled<\/code> webhook.<\/p>\n<h2 id=\"refund-cancel-recurring-payment\">Refund or cancel a recurring payment<\/h2>\n<p>You can refund a recurring payment within 90 days after the payment in the <a href=\"\/pt\/account\/manage-payments\/#refund-a-payment\">Customer Area<\/a> or with an <a href=\"\/pt\/online-payments\/refund\">API request<\/a>.<\/p>\n<p>You can only <a href=\"\/pt\/online-payments\/refund\/#refund-cancel-or-reverse-a-payment\">refund a payment after it is captured<\/a>. If you have already <a href=\"#make-recurring-payments\">scheduled a payment<\/a>, but the payment is not captured yet, you can <a href=\"\/pt\/online-payments\/cancel\/\">cancel the payment<\/a>.<\/p>\n<p>Cancellations must be made before 10 PM on the day before the scheduled date.<\/p>\n<p>To make things easier for you and allow more flexibility in the way you manage cancels and refunds, we recommend to use the <a href=\"\/pt\/online-payments\/reversal\">reversal flow<\/a>.<\/p>\n<h2>See also<\/h2>\n<ul>\n<li><a href=\"\/pt\/payment-methods\/pix\/api-only\/\">Pix API only<\/a><\/li>\n<li><a href=\"\/pt\/online-payments\/tokenization\">Tokenization<\/a><\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/pix\/recurring-payments","articleFields":{"description":"Offer recurring payments to your shoppers with our Pix Autom\u00e1tico integration.","parameters":{"payment_method":"Pix","integration":"API-only","platform":"Web"},"last_edit_on":"25-03-2024 16:08","feedback_component":true,"filters_component":false,"decision_tree":"[]","page_id":"e5637127-4012-4e6b-83b7-76141858f393"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/pix\/recurring-payments","title":"Recurring payments with Pix","content":"\n&nbsp; Read moreLearn more about Pix Autom\u00e1tico.\n\nYou can accept subscription payments with Pix, also known as Pix Autom\u00e1tico. Pix Autom\u00e1tico lets you choose from various billing cycles, and fixed or variable recurring amounts. It also allows you to retry failed subscription payments.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nMake sure that you have built an API-only integration using Checkout API v49 or later.\n\n\nWebhooks\nSubscribe to the following webhook(s): Standard webhooksRecurring tokens life cycle events webhook\n\n\nLimitations\nThis feature is in development. If you are interested in joining the pilot, reach out to your Adyen contact. Some of the processes and documentation may change as the feature evolves.Recurring Pix payments are only available for the Subscription recurring processing model.\n\n\nSetup steps\nBefore you begin: Add Pix in your Customer Area.Integrate with Pix for API only.\n\n\n\nAuthorization flows for subscription payments\nYou can offer two types of recurring payment flows:\n\nAuthorization with QR code: Set up a subscription payment to bill shoppers regularly, where an initial payment is not required. This flow is ideal for setting up trial subscriptions. The Brazilian Central Bank refers to this flow as Journey 2.\nAuthorization and payment with QR code: Set up a subscription payment to bill shoppers regularly, and charge them. This flow is ideal for subscriptions that require an initial payment to start, or when combining a one-off purchase with signing up to a subscription service.  The Brazilian Central Bank refers to this flow as Journey 3.\n\nHow it works\nThe recurring payment flow with Pix works as follows:\n\nYou make a  \/payments request to:\n\nSpecify the frequency, amount, and other details for a subscription.\nIf you are using the Authorization and payment (Journey 3) flow, make an initial payment for the subscription, or for a one-off purchase.\n\nYou show a QR code or QR code data for the shopper to copy, using the action object you receive in the  \/payments response.\nAfter the shopper confirms their subscription, you get the confirmation that the token is created in a Recurring tokens lifecycle events webhook.\n\nIf you are using the Authorization and payment (Journey 3) flow, you also get an  AUTHORISATION webhook that informs you of the outcome of the immediate transaction.\n\nBefore the expected billing date, you make a  \/payments request to charge the shopper for the subscription.\nAfter the billing date, you get a  CAPTURE webhook that informs you of the payment result.\n\nIf a subscription payment fails, we notify you in a  CAPTURE, or  EXPIRE webhook. You can retry the payment up to three times.\nCreate a token with a billing plan\n\nWe strongly recommend that you ask explicit permission from the shopper if you intend to make future recurring payments. Being transparent about the payment schedule and the charged amount reduces the risk of chargebacks.\n\nTo set up a billing plan for a shopper, you need to store their payment details and specify the details of the subscription. If you are using the Authorization and payment flow, you make one request that combines the one-off payment and the billing plan setup.\n\n\nMake a POST  \/payments request. In your request, include:\n\n\nStandard tokenization parameters:\n\n\n\nParameters\nRequired\nDescription\n\n\n\n\npaymentMethod.type\n\npix\n\n\n shopperReference\n\nYour unique identifier for the shopper. Minimum length: three characters. This field is case-sensitive.  Do not include personally identifiable information (PII), such as name or email address.  \n\n\n shopperInteraction\n\nSet to Ecommerce.\n\n\n recurringProcessingModel\n\nSet to Subscription.\n\n\n storePaymentMethod\n\nSet to true to store the shopper's payment details for future recurring payments.\n\n\n amount\n\nThe currency and value of the payment, in minor units. Set the amount.value field depending on your authorization flow: Authorization with QR code (Journey 2): Set to 0 to validate the payment details with a zero-auth transaction before processing payments.Authorization and payment with QR code (Journey 3): Set to the payment amount for the immediate payment.\n\n\n\n\n\nPix-specific parameters:\n\n\n\nParameters\nRequired\nDescription\n\n\n\n\n shopperName\n\nThe first and last name of the shopper.\n\n\n socialSecurityNumber\n\nThe shopper's CPF or CNPJ number. This will be shown to the shopper on the Pix payment form.\n\n\npaymentMethod.pixRecurring.frequency\n\nThe frequency at which the shopper will be charged. Possible values: weekly, monthly, quarterly, half-yearly, and yearly.\n\n\npaymentMethod.pixRecurring.recurringStatement\n\nThe text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments.  Maximum length: 35 characters.\n\n\npaymentMethod.pixRecurring.minAmount\n\nFor a billing plan where the payment amounts are variable, the currency and value of the minimum amount to charge the shopper for each recurring payment, in minor units. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app.\n\n\npaymentMethod.pixRecurring.recurringAmount\n\nFor a billing plan where the payment amount is fixed, the currency and value for each recurring payment, in minor units.\n\n\npaymentMethod.pixRecurring.startsAt\n\nStart date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.\n\n\npaymentMethod.pixRecurring.endsAt\n\nEnd date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.\n\n\npaymentMethod.pixRecurring.retryPolicy\n\nWhen set to true, you can retry for failed recurring payments. The default value is true.\n\n\n\n\n\n\n\n\nThe response contains the following data:\n\n\n  resultCode\n: informs you about the status of subscription setup and the payment.\naction: contains the qrCodeData.\n\n\n\nFrom the response, use the action field that contains the qrCodeData to render the QR code or present the QR code data.\n\n\nWait for the following webhooks to get:\n\nThe outcome of your request.\nThe storedPaymentMethodId that you need to include in subsequent recurring payment requests.\n\n\n\n\nWebhook\nDescription\n\n\n\n\n AUTHORISATION\nInforms you whether the amount for the immediate payment is authorized.\n\n\n recurring.token.created\nContains the shopperReference, and the storedPaymentMethodId.\n\n\n\n\n\n\nIf you need to make changes to a billing plan after setting it up, you have to cancel the billing plan, and create a new one.\n\nMake recurring payments\nMake a request for the recurring payment within a period of ten to two days before the billing date. This is called the schedule window. For example, if the expected billing date is August 12, 2025, you can make the request between August 02 and August 10 to schedule the payment.\n\n\nMake a POST  \/payments request, including:\n\n\n\nField\nRequired\nDescription\n\n\n\n\npaymentMethod.type\n\npix\n\n\npaymentMethod.storedPaymentMethodId\n\nThe token for the shopper's stored payment details. This is the storedPaymentMethodId from the  recurring.token.created webhook.\n\n\n amount\n\nThe currency and value of the recurring payment, in minor units. If you included the recurringAmount field when you created the billing plan, the amount must match the one in your initial request to create the token. If you included the minAmount field when you created the billing plan, you can set a new amount.\n\n\n shopperReference\n\nYour unique identifier for the shopper. Must be the same one you included with the request to create the token with a billing plan.\n\n\n shopperInteraction\n\nSet to ContAuth.\n\n\n recurringProcessingModel\n\nSet to Subscription.\n\n\npaymentMethod.pixRecurring.billingDate\n\nThe date on which the shopper's payment method will be charged, in YYYY-MM-DD format.\n\n\npaymentMethod.pixRecurring.businessDayOnly\n\nWhen set to true, if the billingDate is not a business day, the payment will be processed on the next business day. The default value is false.\n\n\n\n\n\n\nAfter you make the request to schedule the payment, the response contains:\n\n\n  resultCode\n: Pending.\n\n\n\nWhen the payment scheduling is confirmed, you receive an  AUTHORISATION webhook. If you receive:\n\nsuccess: true, the payment is successfully scheduled, and the shopper will be charged for the subscription on the billing date you specified.\nsuccess: false, the payment was not successfully scheduled. This can happen when:\n\nThe amount in the request does not match the amount you specified when you created the billing plan.\nA payment was already scheduled for this billing cycle.\nThe request to schedule was not sent during the schedule window.\nThe details in your request to schedule does not match a successfully created billing plan.\n\n\n\n\nAfter the billing date you specified in the  \/payments request, wait for a webhook to learn about the outcome of the subscription transaction.\n\n\n\nWebhook\nsuccess\nDescription\n\n\n\n\n CAPTURE\ntrue\nThe shopper was successfully charged for the subscription.\n\n\n CAPTURE\nfalse\nAdyen received a notification from the shopper's bank that the subscription payment failed. Save the pspReference from this webhook to retry the payment.\n\n\n EXPIRE\ntrue\nThe subscription amount was not captured, and Adyen did not receive any notification from the shopper's bank. Save the pspReference from this webhook to retry the payment.\n\n\n\n\n\nRetry a recurring payment\nIf you receive one of the following after the billing date, you can retry the payment up to three times:\n\n CAPTURE webhook with success: false\n EXPIRE webhook\n\n\nYou can only retry recurring payments if the paymentMethod.pixRecurring.retryPolicy was enabled in your request to create the billing plan.\n\nTo retry a recurring payment, copy your failed recurring payment request, including:\n\nThe same fields you used in your first recurring payment request. Make sure that the amount in your retry request is the same as the amount from the failed recurring payment request.\nA new paymentMethod.pixRecurring.billingDate:\n\nMust be at least 24 hours later than when you are making the request.\nMust be within seven days from the billing date of the failed recurring payment.\n\npaymentMethod.pixRecurring.originalPspReference: The  pspReference for the failed recurring payment. Find this in CAPTURE, or EXPIRE webhook you received after the billing date.\n\n\n    \n\nCancel a billing plan\nIf your shopper wants to end their billing plan, you need to cancel the billing plan generated for their stored payment details on your side.\nDelete the token with a DELETE  \/storedPaymentMethods\/{storedPaymentMethodId} request.\nShoppers can also request to cancel the billing plan from their bank. In these cases, Adyen deletes the token on your behalf. It is still your responsibility to make sure any remaining shopper details are deleted from your servers, after payment details stored with Adyen are deleted.\nWhen a token is deleted, you receive a recurring.token.disabled webhook.\nRefund or cancel a recurring payment\nYou can refund a recurring payment within 90 days after the payment in the Customer Area or with an API request.\nYou can only refund a payment after it is captured. If you have already scheduled a payment, but the payment is not captured yet, you can cancel the payment.\nCancellations must be made before 10 PM on the day before the scheduled date.\nTo make things easier for you and allow more flexibility in the way you manage cancels and refunds, we recommend to use the reversal flow.\nSee also\n\nPix API only\nTokenization\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Pix","lvl3":"Recurring payments with Pix"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/pix","lvl3":"\/pt\/payment-methods\/pix\/recurring-payments"},"levels":4,"category":"Payment method","category_color":"green","tags":["Recurring","payments"]},"articleFiles":{"pix.svg":"<img style=\"width: 40px;\" alt=\"\" src=\"https:\/\/docs.adyen.com\/user\/pages\/docs\/08.payment-methods\/72.pix\/16.recurring-payments\/pix.svg?decoding=auto&amp;fetchpriority=auto\" \/>"}}
