# Regional API GetNet ## API Docs - Authentication [Authentication Token](https://a53unok0r1.apifox.cn/436931182e0.md): __Authentication__

All transactions are authenticated using a Bearer token generated through the OAuth 2.0 protocol. To obtain a token, clients must send a request to the authentication endpoint using their `client_id` and `client_secret` (click here to see how to generate your credentials). To authenticate this request, you must pass the Base64-encoded string of `client_id:client_secret` in the `Authorization` header. The generated access token must be included in the `Authorization` header of each API request, ensuring secure and controlled access to the API.

__Usage__

Once the token is obtained, include it in the Authorization header of your API requests as follows:
`Authorization: Bearer {access_token}`

__Token Expiration & Renewal__
- The token is valid for the duration specified in `expires_in` (usually 3599 seconds or ~1 hour).
- When the token expires, you must request a new one using the same authentication process.

v20250823.0859 - Payments [Create - Authorize](https://a53unok0r1.apifox.cn/436931183e0.md): __Create a Payment Transaction__

- Payments [Adjustment](https://a53unok0r1.apifox.cn/436931184e0.md): __Update a Payment Transaction__

- Payments [Capture](https://a53unok0r1.apifox.cn/436931185e0.md): __Capture an Authorized Payment__

- Payments [QRCode](https://a53unok0r1.apifox.cn/436931186e0.md): __Capture an Authorized Payment__

This endpoint is used to receive payments through QR Code. QR Code payments have an expiration limit of 1 minute and 50 seconds. After this period, a new QR Code must be generated, disregarding the previous one.
This service is available only for VISA and MasterCard.

- Payments [Cancel](https://a53unok0r1.apifox.cn/436931187e0.md): __Cancel a Captured Payment__

- Payments [Create an Invoice/Boleto](https://a53unok0r1.apifox.cn/436931188e0.md): __Generate Payment with Boleto__

- Payments [Create PIX](https://a53unok0r1.apifox.cn/436931189e0.md): __Generate Payment with PIX__

- Payments [3DS - Init Authentication](https://a53unok0r1.apifox.cn/436931190e0.md): __Initiate 3DS Authentication__

- Payments [3DS - Banking Login Authentication Payload](https://a53unok0r1.apifox.cn/436931191e0.md): This endpoint generates the necessary payload for the customer to authenticate using their banking login. The response includes the required authentication details, which can be used to proceed with the transaction securely. - Payments [3DS - Validate authentication](https://a53unok0r1.apifox.cn/436931192e0.md): This endpoint validates a 3DS authentication by verifying the payer authentication response received from the card issuer. It confirms whether the customer has been successfully authenticated, allowing the transaction to proceed securely. - Payment Record Management [Get Transaction](https://a53unok0r1.apifox.cn/436931193e0.md): __Retrieve transaction details using a unique transaction ID__

The Transaction Query endpoint allows you to retrieve details of a specific transaction using its unique identifier. This is useful for verifying transaction statuses, fetching payment details, and tracking processed transactions. - Payment Record Management [Get by Idempotent Key](https://a53unok0r1.apifox.cn/436931194e0.md): __Retrieving Transaction Data Using Idempotency Keys__

This endpoint allows querying transaction components linked to a specific payment using an **idempotency key**. The idempotency mechanism ensures that repeated requests with the same key will always return the same response, preventing the creation of duplicate transactions.

**Notes:**
_- Using an idempotency key ensures that repeated queries always return the same transaction details without triggering duplicate operations.
- This endpoint is particularly useful for retrieving transaction statuses or confirming previously executed payment operations._ - Combined Payments [Authorize](https://a53unok0r1.apifox.cn/436931195e0.md): __Splitting a Transaction Across Multiple Cards__

This endpoint allows you to authorize a combined payment using multiple cards. It is typically used when a buyer wishes to split the total amount across two or more payment methods.

**Usage Scenarios:**
_- Offering flexibility to the customer in payment options.
- Handling split transactions for marketplaces or platforms._

**Notes:**
_- **Only card-based payments are allowed.** APMs like PIX and Boleto are **not supported**.
- This flow is valid **only for card-not-present** (e-commerce) scenarios.
- The field_ `combined_id` _in the response is used to **track the overall transaction**.
- Each card must be represented as an object inside the payments array._ - Combined Payments [Capture](https://a53unok0r1.apifox.cn/436931196e0.md): __Capture Combined Payments__

This endpoint allows you to **capture a previously authorized combined payment**. It is used to finalize a transaction that was initially authorized using more than one card.

**Usage Scenarios:**
_- Completing a combined payment after order fulfillment.
- Capturing authorized funds split across multiple cards.
- Post-authorization capture logic for marketplaces or platforms.._

**Notes:**
_- The combined payment must have been **previously authorized** using the combined payment authorization endpoint.
- All payment components must be included in the payments array for the capture to be valid.
- The capture amount must match the authorized amount for each payment method.
- Additional data can be sent via the `additional_data` field for custom use cases or integrations._ - Combined Payments [Cancel](https://a53unok0r1.apifox.cn/436931197e0.md): __Cancel Combined Payment__

This endpoint allows you to cancel a previously authorized combined payment. It is typically used when the entire payment (made with more than one card) must be voided before capture.

**Usage Scenarios:**
_- Full void of a combined authorization due to user request or error.
- Rejection of payment during fraud analysis or validation stage._

**Notes:**
_- Only authorized but not captured payments can be canceled.
- All payment components involved in the combined authorization must be listed in the payments array.
- A unique `request_id` must be used to ensure idempotency of cancellation.
- Cancellation might not be reversible depending on the acquirer or issuer’s rules._ - Crossborder [Get CrossBorder Quote](https://a53unok0r1.apifox.cn/436931198e0.md): Retrieve a cross border quote. - Crossborder [Validate customer](https://a53unok0r1.apifox.cn/436931199e0.md): Submits a new customer for documentation validation. If the document_number has already been submitted, the endpoint will retrieve the customer record with its updated status. When the customer analysis is complete, we will send a webhook with the same response format as the '200' case to a URL registered by the seller at the time of enrollment. - Installments [Get Installments](https://a53unok0r1.apifox.cn/436931200e0.md): __Request Installment Quotes__

This endpoint allows you to retrieve a list of available installment quotes for a customer’s payment card. Each quote includes final interest and tax rates, which can be used if the merchant has no pre-negotiated rates with the issuer.

**Usage Scenarios:**
_- Displaying installment options to users during checkout.
- Calculating total payment amounts with interest included.
- Preparing a purchase request that involves installments._

**Notes:**
_- This operation is only available for merchants located in **Argentina** and **Chile**.
-The installment quote ID returned from this operation is required in subsequent payment operations.
-This request must include the card’s **BIN** (first nine digits) and `number_token`. - Cards [Generate Token](https://a53unok0r1.apifox.cn/436931201e0.md): __Generate Card Token__

This endpoint enables the secure tokenization of card data, a required step to carry out transactions without exposing sensitive card details. Tokenization replaces the actual card number with a token, ensuring PCI compliance and transaction security.

**Usage Scenarios:**
_- Generating a token for secure storage and future payments.
- Preparing a card for one-time or recurring transactions.
- Avoiding the need to handle raw card numbers in your system._

**Notes:**
_- The CVV is not required for token generation.
- Tokenization is mandatory before using the card for any transaction.
- The card must be verified by the issuer to complete this process._ - Cards [BIN Lookup](https://a53unok0r1.apifox.cn/436931202e0.md): __BIN Lookup__

This endpoint retrieves detailed information about a specific BIN (Bank Identification Number), including brand, country of issue, issuer, and product type. It’s used to identify and classify credit or debit cards before processing.

**Usage Scenarios:**
_- Identifying the brand or network of a card using its BIN.
- Determining the issuing country or financial institution.
- Classifying the card type (credit, debit, prepaid, etc.).
- Enhancing fraud prevention and analytics by understanding the card’s origin._

**Notes:**
_- Requires the bin parameter in the path, typically the first 9 digits of a card number.
- Useful for card validation, enrichment, and routing logic._ - Cards [Get Cards By Customer Id](https://a53unok0r1.apifox.cn/436931203e0.md): __Get Customer’s Saved Cards__

Returns a list of cards previously stored in the Getnet vault, based on the buyer’s `customer_id`. Useful for displaying saved cards for reuse or management.

**Usage Scenarios:**
_- Retrieve a user’s stored payment methods.
- Prefill card info at checkout for returning customers.
- Display saved cards in account management interfaces._ - Cards [Store Card in Vault](https://a53unok0r1.apifox.cn/436931204e0.md): __Store Card in Vault__

This endpoint securely stores a consumer’s card information in Getnet’s digital vault for future use. It allows the creation of a reusable card resource based on previously tokenized data, enabling seamless and secure transactions without requiring the card details again.

**Usage Scenarios:**
_- Tokenizing and saving card data for future payments.
- Enabling subscriptions or billing cycles without re-entering card information.
- Minimizing PCI scope by leveraging secure storage of sensitive data._

**Notes:**
_- This operation requires a previously generated tokenized card number_ (`number_token`)_, typically obtained via the_ **/v1/tokens/card** _endpoint.
-The card data is stored securely, and sensitive fields like CVV are **never stored**.
- You may optionally skip card verification by using the_ `x-by-pass-parameters` _header._ - Cards [Get Card by Id](https://a53unok0r1.apifox.cn/436931205e0.md): __Get Card by ID__

Retrieves detailed information about a specific card previously stored in the Getnet vault, using its unique `card_id`.

**Usage Scenarios:**
_- Retrieve details of a specific saved card.
- Validate if a stored card is still active.
- Display or process a specific saved card in the checkout flow._ - Cards [Delete Card by Id](https://a53unok0r1.apifox.cn/436931206e0.md): __Delete Card by ID__

Deletes a specific card previously stored in the Getnet vault, identified by its `card_id`.

This action removes the card from the buyer’s list of saved payment methods and makes it unavailable for future transactions.

**Usage Scenarios:**
_- Remove outdated or expired cards.
- Let users manage (clean up) their saved payment methods.
- Enhance compliance with data privacy requirements._ - Cards [Card verification](https://a53unok0r1.apifox.cn/436931207e0.md): __Verify a Card__

This endpoint allows you to validate a credit card using its tokenized representation. It confirms that the card is valid, active, and not subject to restrictions such as being cancelled, blocked, or expired.

**Usage Scenarios:**
_- Ensuring the card is valid before storing it in the vault.
- Verifying a card prior to initiating a payment or subscription.
- Reducing transaction failures by detecting invalid or restricted cards early._

**Notes:**
_- The request must include a tokenized card number, not raw card data.
- Card information such as brand, expiration, and CVV must match what was originally provided.
- A successful response includes a verification ID, authorization code, and transaction ID, which can be logged for traceability._ - Customers [Get Customers by Seller Id](https://a53unok0r1.apifox.cn/436931208e0.md): __List Customers for a specific Seller__

This endpoint retrieves a paginated list of registered customers associated with a specific seller. It is typically used for customer management, recurrence billing, or administrative queries within the Getnet platform.

**Usage Scenarios:**
_- Viewing all customers created under a given seller account.
- Performing administrative tasks such as customer record management or audit logging.
- Validating if a customer is already registered before attempting to create or update their data._

**Notes:**
_- Requires the_ `x-seller-id` _header to identify the seller making the request.
- The query supports pagination via the_ `page` _and_ `limit` _parameters.
- The endpoint returns a structured list of customers including their IDs and registered attributes (e.g., name, document type, email)._ - Customers [Create Customer](https://a53unok0r1.apifox.cn/436931209e0.md): __Request Installment Quotes__

This endpoint allows you to create a new customer profile within the Getnet platform. It is primarily used for recurrence scenarios, enabling the association of customer data with future payments such as subscriptions, recurring charges, or tokenized transactions.

**Usage Scenarios:**
_- Associating customer profiles with saved cards or tokenized payments.
- Enabling customer-specific metadata and preferences for personalization and tracking._

**Notes:**
_- The_ `seller_id` _and_ `customer_id` _fields are required to uniquely identify the platform and the buyer.
- Detailed personal information is collected including name, document type and number, birth date, and contact info.
-The document_type supports various formats depending on the country (e.g.,_ `CPF`, `CNPJ`, `DNI_AR`, `CI_CL`_, etc.).
-Phone numbers should be provided without mask or formatting.
-An address block can be added optionally for billing or verification purposes.
-Proper validation of document formats and lengths is essential for successful registration._ - Customers [Get Customer by Id](https://a53unok0r1.apifox.cn/436931210e0.md): __Get Customer by Id__

This endpoint retrieves detailed information of a specific customer based on their unique `customer_id`. It is used to fetch full customer records for validation, recurrence processing, or support tasks.

**Usage Scenarios:**
_- Fetching a customer’s profile for review or display in a dashboard.
- Validating customer details before processing a new recurring transaction.
- Verifying stored data such as address, document type, or contact information._

**Notes:**
_- Requires the_ `customer_id` _as a path parameter in_ **UUIDv4** _format.
- Returns full customer information including personal details, contact data, and optionally, address and document metadata._ - Recurrence Plans [Get Plans by Seller Id](https://a53unok0r1.apifox.cn/436931211e0.md): __List Recurrence Plans for a specific Seller__

This endpoint allows you to retrieve a paginated list of recurrence plans previously registered on the Getnet platform. It helps manage existing subscription or recurring payment configurations tied to a specific seller.

**Usage Scenarios:**
_- Displaying available plans for customer enrollment.
- Reviewing existing billing plan configurations.
- Auditing or maintaining the lifecycle of recurrence plans._

**Notes:**
_- Requires the_ `x-seller-id` _header to identify the seller making the request.
- The query supports pagination via the_ `page` _and_ `limit` _parameters._ - Recurrence Plans [Create Recurrence Plan](https://a53unok0r1.apifox.cn/436931212e0.md): __Register a Recurrence Plan__

This endpoint allows the creation of a recurrence plan, which defines the structure for future scheduled payments. These plans are commonly used for subscriptions, installments, or recurring services.

**Usage Scenarios:**
_- Creating monthly or yearly subscription plans for digital services or physical products._

**Notes:**
_- The field_ `seller_id` _is required and must be valid for authorization.
- You must specify at least one **payment_type** (e.g.,_ `credit_card`, `debit_card`_).
- The period object defines the recurrence interval (e.g., monthly with 12 cycles).
- Accepted_ product_type _values define the nature of what is being billed (e.g.,_ `digital_goods`, `service`_).
- The_ `currency` _must follow **ISO 4217** format (e.g.,_ `BRL`, `ARS`, `USD`_)._ - Recurrence Plans [Get Plan by Id](https://a53unok0r1.apifox.cn/436931213e0.md): __Get Recurrence Plan by Id__

This endpoint retrieves detailed information about a specific recurrence plan using its unique `plan_id`. It is useful for viewing the configuration of a subscription plan, including billing cycle, payment methods, and amount.

**Usage Scenarios:**
_- Retrieving full details of a recurrence plan for display or review.
- Validating a specific plan’s configuration before customer subscription._

**Notes:**
_- Requires the_ `plan_id` _as a path parameter in_ **UUIDv4** _format.
- The_ `x-seller-id` _header is mandatory to identify the requesting merchant.
- Returns full plan metadata including period, amount, currency, payment types, and floating data if applicable.
- Ensures that only plans associated with the authenticated seller are accessible._ - Recurrence Plans [Update Plan](https://a53unok0r1.apifox.cn/436931214e0.md): __Update a Plan__

This endpoint allows you to update the attributes of an existing recurrence plan. It is typically used to modify plan metadata such as the name, description, or floating installment data without altering its identity or subscription history.

**Usage Scenarios:**
_- Correcting or improving plan presentation on user-facing interfaces.
- Adjusting installment options (e.g. adding or modifying floating amounts per installment)._

**Notes:**
_- You can update attributes like the plan’s **name**, **description**, and **floating_data**, which contains customized **installment** options (**installment number** and corresponding **amount** in cents).
- Only the fields included in the request body will be updated — fields not present will remain unchanged._ - Recurrence Plans [Migrate Subscriptions](https://a53unok0r1.apifox.cn/436931215e0.md): __Migrate Subscriptions to Another Plan__

This endpoint allows you to migrate one or more subscriptions from an existing recurrence plan (from) to a new target plan (to). This is useful when updating the terms or pricing of an active subscription without interrupting service to the customer.

**Usage Scenarios:**
_- Moving existing customers from a legacy plan to a newly structured or updated plan.
- Updating subscription pricing or billing frequency while preserving active subscriptions.
- Consolidating subscriptions under a single plan for easier management._

**Notes:**
_- Both from and to plan IDs must be valid **UUIDs** and belong to the same seller.
- If the subscriptions list is not provided, all subscriptions linked to the source plan (from) will be migrated to the destination plan (to).
- The username header should be provided for audit and traceability purposes.
- Ensure that the destination plan has compatible settings to avoid issues during migration._ - Recurrence Plans [Update Plan status](https://a53unok0r1.apifox.cn/436931216e0.md): __Update Plan status__

This endpoint allows you to update the status of an existing recurrence plan. You can use it to **activate** or **deactivate** (inactive) a plan depending on your business needs. It is commonly used for enabling or pausing plans without deleting them.

**Usage Scenarios:**
_- Activating a new plan after initial setup.
- Temporarily deactivating a plan that is no longer available for new subscriptions.
- Enabling or disabling a plan based on promotional periods or internal business rules._

**Notes:**
_- The_ `plan_id` _must be provided in the path of the request URL.
- The new status (_`active` _or_ `inactive`_) is also passed as a path parameter._ - Webhooks [Subscribe to a webhook event](https://a53unok0r1.apifox.cn/436931217e0.md): Subscribe to receive webhooks. Select the event, authentication type and url to subscribe to an event. - Webhooks [Get a list of all subscriptions events](https://a53unok0r1.apifox.cn/436931218e0.md): Obtain a list of all events subscribed by a seller - Webhooks [Subscribe to a webhook event](https://a53unok0r1.apifox.cn/436931219e0.md): Subscribe to receive webhooks. Select the event, authentication type and url to subscribe to an event. - Webhooks [Get a list of all subscriptions events messages based on filters](https://a53unok0r1.apifox.cn/436931220e0.md): Send your specific filtes to obtain a list of messages. The limit of messages is 1000. The default pagination is 20 messages per page. - Webhooks [Re-send a message](https://a53unok0r1.apifox.cn/436931221e0.md): Send your specific filtes to obtain a list of messages. The limit of messages is 1000. The default pagination is 20 messages per page. - Webhooks [Get a list of all possible events to subscribe.](https://a53unok0r1.apifox.cn/436931222e0.md): Get a list of all possible events to subscribe. - Subscriptions [Get Subscriptions](https://a53unok0r1.apifox.cn/436931223e0.md): __List Subscriptions__

This endpoint retrieves a paginated list of all subscriptions created by the seller, including their current status, customer details, and plan associations.

**Usage Scenarios:**
_- Monitoring active or scheduled subscriptions tied to specific customers or plans.
- Building dashboards or reports with current subscription statuses.
- Auditing or debugging subscription activity based on filters (e.g., customer, date, or plan)._

**Notes:**
_- You must include the_ `x-seller-id` _header to identify the seller.
- Supports pagination via_ `page` _and_ `limit` query parameters.
- The result will contain metadata about each subscription, such as ID, plan reference, creation and billing dates, and current status (e.g.,_ `active`, `scheduled`, `canceled`_)._ - Subscriptions [Create Subscription](https://a53unok0r1.apifox.cn/436931224e0.md): __Register a New Subscription__

based on a predefined plan. It’s used to enroll a customer into a recurring payment schedule.

**Usage Scenarios:**
_- Starting a new subscription for digital services, memberships, etc.
- Associating a buyer to a specific plan with automated recurring billing.
- Setting a custom start date for the subscription to control billing cycles._

**Notes:**
_- Requires a valid_ `plan_id` _from an existing recurrence plan.
- The_ `installment_start_date` _determines when the subscription begins billing. Until then, it remains in a Scheduled state.
- The_ `subscription` _object must include the chosen_ `payment_type` _(e.g.,_ `credit`_), and optionally billing address and installment info._ - Subscriptions [Get Subscription by Id](https://a53unok0r1.apifox.cn/436931225e0.md): __Get Subscription by Id__

This endpoint retrieves detailed information about a specific subscription using its unique identifier. It returns data about the plan, billing cycle, customer, and current status of the subscription.

**Usage Scenarios:**
_- Displaying full subscription details in a customer dashboard or admin panel.
- Verifying the current status of a subscription (e.g., active, scheduled, canceled).
- Retrieving the associated billing plan, payment settings, and next billing date._ - Subscriptions [Cancel Subscription](https://a53unok0r1.apifox.cn/436931226e0.md): __Cancel an Existing Subscription__

This endpoint allows you to cancel an existing subscription using its unique identifier. It updates the subscription status to `CANCELED` and optionally logs a reason for audit and tracking purposes.

**Usage Scenarios:**
_- When a customer explicitly requests to stop their subscription.
- As part of automated processes (e.g., failed payments, policy violations).
- When a service or product is discontinued._

**Notes:**
_- You can optionally provide a_ `status_details` _field to document the reason for cancellation (useful for audit or business insights).
- Once canceled, the subscription will not generate further billing events or renewals._ - Subscriptions [Projection of Charges](https://a53unok0r1.apifox.cn/436931227e0.md): __Demonstrates the projection of charges__

This endpoint returns a detailed projection of the upcoming charges for a specific subscription. It’s useful for understanding future billing dates and amounts, based on the subscription’s billing cycle and current configuration.

**Usage Scenarios:**
_- Displaying upcoming charges to the customer in a client-facing dashboard.
- Validating recurring charge patterns for subscription-based products or services.
- Estimating revenue over time for analytics or forecasting.
- Confirming upcoming charges prior to executing renewals or retries._

**Notes:**
_- The response includes one or multiple entries with projected charge amounts and due dates.
- It does **not** trigger any billing — this is a **read-only**, informational request.
- Helps identify issues like misaligned billing or incorrect values before they affect payment flows._ - Subscriptions [Confirm Payment for a Subscription](https://a53unok0r1.apifox.cn/436931228e0.md): __Confirm Payment for a Subscription__

This endpoint confirms the payment of a specific charge associated with a subscription. It’s typically used to confirm payments manually in cases where the payment has been completed outside the regular processing flow and needs to be acknowledged within the system.

**Usage Scenarios:**
_- Marking a charge as paid after receiving manual or offline confirmation (e.g., bank transfer).
- Synchronizing the subscription billing status after resolving external payment processing.
- Overriding failed or pending states for specific charges, when validated by the merchant._

**Notes:**
- `status_detail` _is optional and can be used to add context or audit notes for the confirmation.
- This action should only be performed if payment was indeed completed, as it directly updates the billing state of the subscription.
_ - Subscriptions [Update Payment Date](https://a53unok0r1.apifox.cn/436931229e0.md): __Update Subscription Payment Date__

This endpoint allows merchants to update the recurring payment date of an active subscription. It modifies the day of the month on which future charges will be generated.

**Usage Scenarios:**
_- Adjusting the charge schedule based on customer preferences.
- Aligning the subscription billing date with payroll or other payment cycles.
- Correcting an initial setup error regarding the charge date._

**Notes:**
_- Only the day of the month can be updated using this endpoint (e.g., 1 to 28 or 31, depending on calendar constraints).
- The update affects all future billing cycles, starting from the next charge.
- If the new date has already passed in the current month, the change applies starting the next available billing cycle.
- Ensure the subscription is active before attempting this update. Inactive or canceled subscriptions cannot be modified._ - Subscriptions [Update Payment Data](https://a53unok0r1.apifox.cn/436931230e0.md): __Update Subscription Payment Data__

This endpoint allows merchants to update the payment method of an existing subscription, specifically switching to a new or updated credit card.

**Usage Scenarios:**
_- Updating the credit card for an active subscription.
- Replacing an expired or invalid card.
- Switching to a different card brand or issuer for billing._

**Notes:**
_- The new card information must be tokenized and provided securely.
- This update applies to all future billing cycles of the subscription.
- Ensure that the subscription is active before using this operation._ - Subscriptions [Get Changes of Subscription Installments](https://a53unok0r1.apifox.cn/436931231e0.md): __Get Changes of Subscription Installments__

This endpoint retrieves all date and/or value changes made to a specific recurrence subscription’s billing schedule. It allows you to track adjustments to installment amounts or billing dates.

**Usage Scenarios:**
_- Auditing changes to subscription billing dates or amounts.
- Validating scheduled changes prior to executing a billing cycle.
- Troubleshooting subscription discrepancies due to modified installments._

**Notes:**
_- Returns detailed information for each modified installment, including the original and new values for amount and scheduled date.
- Useful for compliance, reporting, and billing transparency._ - Subscriptions [Set Changes of Subscription Installments](https://a53unok0r1.apifox.cn/436931232e0.md): __Set Changes of Subscription Installments__

On this endpoint you can create a new date and/or value change for one or more charges that are scheduled for the subscription. To use this endpoint, the establishment must be enabled for this specific product. For more details see the Date change rules.

**Usage Scenarios:**
_- Adjusting the charge amount for a specific installment due to discounts or corrections.
- Changing the billing day of an installment for customer convenience.
- Updating dynamic subscription plans with variable billing conditions._ - Subscriptions [Delete Changes of Subscription Installments](https://a53unok0r1.apifox.cn/436931233e0.md): __Delete Changes of Subscription Installments__

This endpoint deletes all floating data (installment-specific changes) associated with a given subscription. This effectively restores the default installment schedule and values as defined by the plan.

**Usage Scenarios:**
_- Reverting customized billing dates or amounts back to the default plan settings.
- Cleaning up outdated or incorrect floating data entries.
- Resetting a subscription’s billing behavior after customer or business decisions._

**Notes:**
_- This action will delete all floating data associated with the subscription.
- This operation is irreversible—once deleted, floating data must be recreated manually if needed._ - Subscriptions [Update Changes of Subscription Installments](https://a53unok0r1.apifox.cn/436931234e0.md): __Update Changes of Subscription Installments__

This endpoint updates or creates a floating data entry for a specific subscription. Floating data allows the customization of installment values on specific days of the month, overriding the default schedule and values set by the subscription plan.

**Usage Scenarios:**
_- Modifying a previously created floating installment value.
- Adjusting billing behavior to reflect a negotiated or promotional value._ - Subscriptions [Update fluctuation of Subscription Installment](https://a53unok0r1.apifox.cn/436931235e0.md): __Updates date and value fluctuation in the subscription for a specific installment__

This endpoint updates a specific installment within a subscription’s floating data, allowing for precise adjustment of both the amount and billing date for that installment. It provides finer control over payment customization beyond regular monthly rules.

**Usage Scenarios:**
_- Modifying the amount and billing date of a specific installment in a subscription.
- Correcting a previously configured installment charge.
- Troubleshooting subscription discrepancies due to modified installments._ - Subscriptions [Delete fluctuation of Subscriptions Installment](https://a53unok0r1.apifox.cn/436931236e0.md): __Delete date and value fluctuation in the subscription for a specific installment__

This endpoint deletes a specific floating installment entry from a subscription. It is useful when only one installment within the floating configuration needs to be removed, rather than clearing the entire floating setup.

**Usage Scenarios:**
_- Removing a single incorrect or outdated floating installment configuration.
- Reverting a specific installment to follow the default plan configuration.
- Allowing for manual redefinition or update of one installment without affecting others._ - Subscriptions [Migrate Subscription Plan](https://a53unok0r1.apifox.cn/436931237e0.md): __Migrate Subscription Plan__

This endpoint enables the migration of a subscription from one plan to another. It allows merchants to update the terms of an existing subscription by assigning a different predefined plan to it.

**Usage Scenarios:**
_- Migrating legacy subscriptions to new or updated plans.
- Adjusting a subscription’s features or pricing structure without requiring cancellation and recreation._ - Subscriptions [Get All Charges](https://a53unok0r1.apifox.cn/436931238e0.md): __List All Charges__

This endpoint retrieves a list of all registered charges in the system. You can apply various filters to narrow down the results, such as filtering by subscription, customer, charge status, and dates.

**Usage Scenarios:**
_- Viewing all charges within a certain time period.
- Filtering charges by subscription, customer, or plan.
- Monitoring charge statuses (e.g., pending, paid, failed).
- Exporting charge data for analysis or reporting._ ## Schemas - [payment](https://a53unok0r1.apifox.cn/259983617d0.md): - [seller_id](https://a53unok0r1.apifox.cn/259983618d0.md): - [request_id](https://a53unok0r1.apifox.cn/259983619d0.md): - [payment_id](https://a53unok0r1.apifox.cn/259983620d0.md): - [order_id](https://a53unok0r1.apifox.cn/259983621d0.md): - [amount](https://a53unok0r1.apifox.cn/259983622d0.md): - [currency](https://a53unok0r1.apifox.cn/259983623d0.md): - [received_at](https://a53unok0r1.apifox.cn/259983624d0.md): - [transaction_id](https://a53unok0r1.apifox.cn/259983625d0.md): - [authorized_at](https://a53unok0r1.apifox.cn/259983626d0.md): - [acquirer](https://a53unok0r1.apifox.cn/259983627d0.md): - [soft_descriptor](https://a53unok0r1.apifox.cn/259983628d0.md): - [brand](https://a53unok0r1.apifox.cn/259983629d0.md): - [authorization_code](https://a53unok0r1.apifox.cn/259983630d0.md): - [acquirer_transaction_id](https://a53unok0r1.apifox.cn/259983631d0.md): - [eci](https://a53unok0r1.apifox.cn/259983632d0.md): - [total_installment_amount](https://a53unok0r1.apifox.cn/259983633d0.md): - [first_installment_amount](https://a53unok0r1.apifox.cn/259983634d0.md): - [other_installment_amount](https://a53unok0r1.apifox.cn/259983635d0.md): - [payment_method](https://a53unok0r1.apifox.cn/259983636d0.md): - [status](https://a53unok0r1.apifox.cn/259983637d0.md): - [idempotency_key](https://a53unok0r1.apifox.cn/259983638d0.md): - [reason_code](https://a53unok0r1.apifox.cn/259983639d0.md): - [reason_message](https://a53unok0r1.apifox.cn/259983640d0.md): - [custom_key](https://a53unok0r1.apifox.cn/259983641d0.md): - [customer_id](https://a53unok0r1.apifox.cn/259983642d0.md): - [plan_id](https://a53unok0r1.apifox.cn/259983643d0.md): - [md](https://a53unok0r1.apifox.cn/259983644d0.md): - [tx_id](https://a53unok0r1.apifox.cn/259983645d0.md): - [xid](https://a53unok0r1.apifox.cn/259983646d0.md): - [status3DS](https://a53unok0r1.apifox.cn/259983647d0.md): - [protocol](https://a53unok0r1.apifox.cn/259983648d0.md): - [operation](https://a53unok0r1.apifox.cn/259983649d0.md): - [cavv](https://a53unok0r1.apifox.cn/259983650d0.md): - [ds_trans_id](https://a53unok0r1.apifox.cn/259983651d0.md): - [redirect_html_template](https://a53unok0r1.apifox.cn/259983652d0.md): - [acs_redirect_form](https://a53unok0r1.apifox.cn/259983653d0.md): - [requestPayment](https://a53unok0r1.apifox.cn/259983654d0.md): - [requestCapture](https://a53unok0r1.apifox.cn/259983655d0.md): - [requestCancel](https://a53unok0r1.apifox.cn/259983656d0.md): - [paymentAuthorizationResponse](https://a53unok0r1.apifox.cn/259983657d0.md): - [record](https://a53unok0r1.apifox.cn/259983658d0.md): - [requestQRCode](https://a53unok0r1.apifox.cn/259983659d0.md): - [responseQRCode](https://a53unok0r1.apifox.cn/259983660d0.md): - [paymentCancelResponse](https://a53unok0r1.apifox.cn/259983661d0.md): - [paymentCaptureResponse](https://a53unok0r1.apifox.cn/259983662d0.md): - [paymentPurchaseResponse](https://a53unok0r1.apifox.cn/259983663d0.md): - [cancelResult](https://a53unok0r1.apifox.cn/259983664d0.md): - [protocol3DS](https://a53unok0r1.apifox.cn/259983665d0.md): - [registered_at](https://a53unok0r1.apifox.cn/259983666d0.md): - [rel](https://a53unok0r1.apifox.cn/259983667d0.md): - [notFound](https://a53unok0r1.apifox.cn/259983668d0.md): - [badRequest](https://a53unok0r1.apifox.cn/259983669d0.md): - [internalServerError](https://a53unok0r1.apifox.cn/259983670d0.md): - [CreditCancel](https://a53unok0r1.apifox.cn/259983671d0.md): - [DefaultErrorHttpResponse](https://a53unok0r1.apifox.cn/259983672d0.md): - [ErrorDetail](https://a53unok0r1.apifox.cn/259983673d0.md): - [OrderItemReleaseDTO](https://a53unok0r1.apifox.cn/259983674d0.md): - [ReleaseDTO](https://a53unok0r1.apifox.cn/259983675d0.md): - [AddressDTO](https://a53unok0r1.apifox.cn/259983676d0.md): - [CardDTO](https://a53unok0r1.apifox.cn/259983677d0.md): - [ServiceCodeDTO](https://a53unok0r1.apifox.cn/259983678d0.md): - [CustomerDTOSubs](https://a53unok0r1.apifox.cn/259983679d0.md): - [CustomerDTO](https://a53unok0r1.apifox.cn/259983680d0.md): - [InternalDTO](https://a53unok0r1.apifox.cn/259983681d0.md): - [OrderPaymentDTO](https://a53unok0r1.apifox.cn/259983682d0.md): - [OrderDTO](https://a53unok0r1.apifox.cn/259983683d0.md): - [InstallmentCuotesDTO](https://a53unok0r1.apifox.cn/259983684d0.md): - [RecurringDTO](https://a53unok0r1.apifox.cn/259983685d0.md): - [SubMerchantDTO](https://a53unok0r1.apifox.cn/259983686d0.md): - [TokenizationDTO](https://a53unok0r1.apifox.cn/259983687d0.md): - [ReceiverDTO](https://a53unok0r1.apifox.cn/259983688d0.md): - [FundTransferDTO](https://a53unok0r1.apifox.cn/259983689d0.md): - [WalletCreditDTO](https://a53unok0r1.apifox.cn/259983690d0.md): - [CreditResponseDTO](https://a53unok0r1.apifox.cn/259983691d0.md): - [DetailsResponseDTO](https://a53unok0r1.apifox.cn/259983692d0.md): - [PaymentResponseDTO](https://a53unok0r1.apifox.cn/259983693d0.md): - [BoletoDTO](https://a53unok0r1.apifox.cn/259983694d0.md): - [DataDTO](https://a53unok0r1.apifox.cn/259983695d0.md): - [DataAdjustmentDTO](https://a53unok0r1.apifox.cn/259983696d0.md): - [DataBoletoDTO](https://a53unok0r1.apifox.cn/259983697d0.md): - [PaymentDataDTO](https://a53unok0r1.apifox.cn/259983698d0.md): - [TerminalPaymentDTO](https://a53unok0r1.apifox.cn/259983699d0.md): - [PaymentDataAdjustmentDTO](https://a53unok0r1.apifox.cn/259983700d0.md): - [PaymentBoletoDataDTO](https://a53unok0r1.apifox.cn/259983701d0.md): - [BoletoDataDTO](https://a53unok0r1.apifox.cn/259983702d0.md): - [CancelRequestDTO](https://a53unok0r1.apifox.cn/259983703d0.md): - [MarketplaceSubsellerPayment](https://a53unok0r1.apifox.cn/259983704d0.md): - [OrderItem](https://a53unok0r1.apifox.cn/259983705d0.md): - [CancelDTO](https://a53unok0r1.apifox.cn/259983706d0.md): - [CaptureResponseDTO](https://a53unok0r1.apifox.cn/259983707d0.md): - [CancelResponseDTO](https://a53unok0r1.apifox.cn/259983708d0.md): - [PaymentDTO](https://a53unok0r1.apifox.cn/259983709d0.md): - [AdjustmentDTO](https://a53unok0r1.apifox.cn/259983710d0.md): - [PaymentBoletoDTO](https://a53unok0r1.apifox.cn/259983711d0.md): - [AutorizationResponseDTO](https://a53unok0r1.apifox.cn/259983712d0.md): - [BolepixDTO](https://a53unok0r1.apifox.cn/259983713d0.md): - [BoletoResponseDTO](https://a53unok0r1.apifox.cn/259983714d0.md): - [LinkBoletoDTO](https://a53unok0r1.apifox.cn/259983715d0.md): - [InstallmentQuotesRequestDTO](https://a53unok0r1.apifox.cn/259983716d0.md): - [IncreaseRateDTO](https://a53unok0r1.apifox.cn/259983717d0.md): - [InstallmentQuotesResponseDTO](https://a53unok0r1.apifox.cn/259983718d0.md): - [CrossborderQuoteResponseDTO](https://a53unok0r1.apifox.cn/259983719d0.md): - [PricesDTO](https://a53unok0r1.apifox.cn/259983720d0.md): - [InterestRateDTO](https://a53unok0r1.apifox.cn/259983721d0.md): - [InterestTaxRateDTO](https://a53unok0r1.apifox.cn/259983722d0.md): - [OptionResponseDTO](https://a53unok0r1.apifox.cn/259983723d0.md): - [Data](https://a53unok0r1.apifox.cn/259983724d0.md): - [ConfirmRequestDTO](https://a53unok0r1.apifox.cn/259983725d0.md): - [ConfirmResponseDTO](https://a53unok0r1.apifox.cn/259983726d0.md): - [CreditConfirmDTO](https://a53unok0r1.apifox.cn/259983727d0.md): - [CancelCustomKeyResponseDTO](https://a53unok0r1.apifox.cn/259983728d0.md): - [TokensCardRequest](https://a53unok0r1.apifox.cn/259983729d0.md): - [TokensCardResponse](https://a53unok0r1.apifox.cn/259983730d0.md): - [CardDataResponse](https://a53unok0r1.apifox.cn/259983731d0.md): - [ListCardDataResponse](https://a53unok0r1.apifox.cn/259983732d0.md): - [SaveCardDataRequest](https://a53unok0r1.apifox.cn/259983733d0.md): - [SaveCardDataResponse](https://a53unok0r1.apifox.cn/259983734d0.md): - [VerificationCardRequest](https://a53unok0r1.apifox.cn/259983735d0.md): - [VerificationCardResponse](https://a53unok0r1.apifox.cn/259983736d0.md): - [CustomerResponse](https://a53unok0r1.apifox.cn/259983737d0.md): - [ListCustomersResponse](https://a53unok0r1.apifox.cn/259983738d0.md): - [Address](https://a53unok0r1.apifox.cn/259983739d0.md): - [FloatingDataPlan](https://a53unok0r1.apifox.cn/259983740d0.md): - [Period](https://a53unok0r1.apifox.cn/259983741d0.md): - [PlanRequest](https://a53unok0r1.apifox.cn/259983742d0.md): - [Plan](https://a53unok0r1.apifox.cn/259983743d0.md): - [PlanData](https://a53unok0r1.apifox.cn/259983744d0.md): - [TenantData](https://a53unok0r1.apifox.cn/259983745d0.md): - [PlanDataWrapper](https://a53unok0r1.apifox.cn/259983746d0.md): - [UpdatePlan](https://a53unok0r1.apifox.cn/259983747d0.md): - [PlanPartialUpdateRequest](https://a53unok0r1.apifox.cn/259983748d0.md): - [SubscriptionPlanMigration](https://a53unok0r1.apifox.cn/259983749d0.md): - [FilteredResponse](https://a53unok0r1.apifox.cn/259983750d0.md): - [SubscriptionResponse](https://a53unok0r1.apifox.cn/259983751d0.md): - [Device](https://a53unok0r1.apifox.cn/259983752d0.md): - [SubscriptionDetailResponse](https://a53unok0r1.apifox.cn/259983753d0.md): - [PaymentResponse](https://a53unok0r1.apifox.cn/259983754d0.md): - [PaymentTypeResponse](https://a53unok0r1.apifox.cn/259983755d0.md): - [PlanResponse](https://a53unok0r1.apifox.cn/259983756d0.md): - [CreditResponse](https://a53unok0r1.apifox.cn/259983757d0.md): - [PeriodResponse](https://a53unok0r1.apifox.cn/259983758d0.md): - [FloatingData](https://a53unok0r1.apifox.cn/259983759d0.md): - [Tokenization](https://a53unok0r1.apifox.cn/259983760d0.md): - [Wallet](https://a53unok0r1.apifox.cn/259983761d0.md): - [CreditCardResponse](https://a53unok0r1.apifox.cn/259983762d0.md): - [PaymentDataResponse](https://a53unok0r1.apifox.cn/259983763d0.md): - [PaymentError](https://a53unok0r1.apifox.cn/259983764d0.md): - [PaymentErrorDetail](https://a53unok0r1.apifox.cn/259983765d0.md): - [Shipping](https://a53unok0r1.apifox.cn/259983766d0.md): - [CreditCardCreation](https://a53unok0r1.apifox.cn/259983767d0.md): - [CreditCreation](https://a53unok0r1.apifox.cn/259983768d0.md): - [PaymentCreation](https://a53unok0r1.apifox.cn/259983769d0.md): - [PaymentTypeCreation](https://a53unok0r1.apifox.cn/259983770d0.md): - [SubscriptionCreation](https://a53unok0r1.apifox.cn/259983771d0.md): - [SubscriptionDetailCreation](https://a53unok0r1.apifox.cn/259983772d0.md): - [PaymentDate](https://a53unok0r1.apifox.cn/259983773d0.md): - [SubscriptionCancel](https://a53unok0r1.apifox.cn/259983774d0.md): - [FloatingDataProjection](https://a53unok0r1.apifox.cn/259983775d0.md): - [Projection](https://a53unok0r1.apifox.cn/259983776d0.md): - [AmountProjection](https://a53unok0r1.apifox.cn/259983777d0.md): - [ConfirmPayment](https://a53unok0r1.apifox.cn/259983778d0.md): - [ReplaceCreditCard](https://a53unok0r1.apifox.cn/259983779d0.md): - [FloatingDataResponse](https://a53unok0r1.apifox.cn/259983780d0.md): - [FloatingDataRemoveResponse](https://a53unok0r1.apifox.cn/259983781d0.md): - [FloatingDataWithDetails](https://a53unok0r1.apifox.cn/259983782d0.md): - [FloatingDataUpdate](https://a53unok0r1.apifox.cn/259983783d0.md): - [PlanMigrationRequest](https://a53unok0r1.apifox.cn/259983784d0.md): - [Order](https://a53unok0r1.apifox.cn/259983785d0.md): - [Card](https://a53unok0r1.apifox.cn/259983786d0.md): - [PaymentResponseCharge](https://a53unok0r1.apifox.cn/259983787d0.md): - [PlanCharge](https://a53unok0r1.apifox.cn/259983788d0.md): - [consultaBinResponse](https://a53unok0r1.apifox.cn/259983789d0.md): - [results](https://a53unok0r1.apifox.cn/259983790d0.md): - [split_data](https://a53unok0r1.apifox.cn/259983791d0.md): - [rates](https://a53unok0r1.apifox.cn/259983792d0.md): - [DeviceDTO](https://a53unok0r1.apifox.cn/259983793d0.md): - [CustomerDTOAddData](https://a53unok0r1.apifox.cn/259983794d0.md): - [BillingAddressDTO](https://a53unok0r1.apifox.cn/259983795d0.md): - [ShippingsDTO](https://a53unok0r1.apifox.cn/259983796d0.md): - [PixDTO](https://a53unok0r1.apifox.cn/259983797d0.md): - [Payment](https://a53unok0r1.apifox.cn/259983798d0.md): - [quote_id](https://a53unok0r1.apifox.cn/259983799d0.md): - [CombinedPaymentDTO](https://a53unok0r1.apifox.cn/259983800d0.md): - [CombinedDataDTO](https://a53unok0r1.apifox.cn/259983801d0.md): - [CombinedPaymentDataDTO](https://a53unok0r1.apifox.cn/259983802d0.md): - [CrossBorderDataDTO](https://a53unok0r1.apifox.cn/259983803d0.md): - [CombinedResponseDTOCombinedAutorizationResponseDataDTO](https://a53unok0r1.apifox.cn/259983804d0.md): - [CombinedAutorizationResponseDataDTO](https://a53unok0r1.apifox.cn/259983805d0.md): - [CombinedOperationsRequestDTOCombinedCapturetDataDTO](https://a53unok0r1.apifox.cn/259983806d0.md): - [CombinedCapturetDataDTO](https://a53unok0r1.apifox.cn/259983807d0.md): - [CombinedResponseDTOCaptureResponseDTO](https://a53unok0r1.apifox.cn/259983808d0.md): - [CombinedOperationsRequestDTOCombinedCancelDataDTO](https://a53unok0r1.apifox.cn/259983809d0.md): - [CombinedCancelDataDTO](https://a53unok0r1.apifox.cn/259983810d0.md): - [CombinedResponseDTOCancelResponseDTO](https://a53unok0r1.apifox.cn/259983811d0.md): - [CombinedReleaseDTO](https://a53unok0r1.apifox.cn/259983812d0.md): - [MgmReleaseSubSellerPaymentResponse](https://a53unok0r1.apifox.cn/259983813d0.md): - [Errors](https://a53unok0r1.apifox.cn/259983814d0.md): - [ValidationsDTO](https://a53unok0r1.apifox.cn/259983815d0.md): - [EnrolmentsInitialDTO](https://a53unok0r1.apifox.cn/259983816d0.md): - [PaymentMethod](https://a53unok0r1.apifox.cn/259983817d0.md): - [ExtraFields](https://a53unok0r1.apifox.cn/259983818d0.md): - [InitialResponseDTO](https://a53unok0r1.apifox.cn/259983819d0.md): - [StatusTransaction](https://a53unok0r1.apifox.cn/259983820d0.md): - [ValidationsResponseDTO](https://a53unok0r1.apifox.cn/259983821d0.md): - [EnrolmentsContinueDTO](https://a53unok0r1.apifox.cn/259983822d0.md): - [ContinueResponseDTO](https://a53unok0r1.apifox.cn/259983823d0.md): - [Airlines](https://a53unok0r1.apifox.cn/259983824d0.md): - [dccDTO](https://a53unok0r1.apifox.cn/259983825d0.md): - [crossBorderDTO](https://a53unok0r1.apifox.cn/259983826d0.md): - [ValidateCustomerDTO](https://a53unok0r1.apifox.cn/259983827d0.md): - [ValidateCustomerResponseDTO](https://a53unok0r1.apifox.cn/259983828d0.md): - [WebhookSubscription](https://a53unok0r1.apifox.cn/259983829d0.md): - [WebhookSubscriptions](https://a53unok0r1.apifox.cn/259983830d0.md): - [WebhookUserCredentials](https://a53unok0r1.apifox.cn/259983831d0.md): - [WebhookOauth](https://a53unok0r1.apifox.cn/259983832d0.md): - [WebhookNotification](https://a53unok0r1.apifox.cn/259983833d0.md): - [WebhookNotificationsList](https://a53unok0r1.apifox.cn/259983834d0.md): - [WebhookHttpConfig](https://a53unok0r1.apifox.cn/259983835d0.md): - [WebhookEmailConfig](https://a53unok0r1.apifox.cn/259983836d0.md): - [WebhookHttpMessage](https://a53unok0r1.apifox.cn/259983837d0.md): - [WebhookEmailMessage](https://a53unok0r1.apifox.cn/259983838d0.md): - [WebhookEventList](https://a53unok0r1.apifox.cn/259983839d0.md): - [BadRequestError](https://a53unok0r1.apifox.cn/259983840d0.md): - [InternalServerError](https://a53unok0r1.apifox.cn/259983841d0.md): - [Error](https://a53unok0r1.apifox.cn/259983842d0.md): - [WebhookResponseTransactions](https://a53unok0r1.apifox.cn/259983843d0.md): - [WebhookCancelledTransactions](https://a53unok0r1.apifox.cn/259983844d0.md): - [WebhookCapturedTransactions](https://a53unok0r1.apifox.cn/259983845d0.md): - [WebhookCardUpdated](https://a53unok0r1.apifox.cn/259983846d0.md):