3D Secure Processing

openapi: 3.0.0 info: title: Regional API GetNet contact: {} version: '1.0.0' description: "Welcome to GetNet. This API enables your company to integrate with the GetNet Regional API and leverage top-tier payment solutions. GetNet provides secure and efficient services for processing e-commerce transactions, allowing merchants to accept credit, debit, and bank cards seamlessly in their virtual stores. In addition to payment processing, GetNet offers safe, recurring, anti-fraud, conciliator services and other features designed to support your business with speed and security.

**Overview (What You’ll Find in This Documentation)**
This section provides an overview of the Regional API’s key functionalities. It covers authentication methods, base URL configuration, and available endpoints for processing payments, managing subscriptions, handling installments, and performing card operations. Additionally, it details transaction queries, post-sale processes such as cancellations and refunds, and 3D Secure authentication. Use this documentation to understand the structure and behavior of each API request and response.

__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. 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." servers: - url: https://api.pre.globalgetnet.com - url: https://api.globalgetnet.com paths: # PAYMENTS /dpm/payments-gwproxy/v2/payments: post: tags: - Payments summary: Create - Authorize description: __Create Payment Transaction__

The Create Payment endpoint allows merchants to initiate a payment transaction using credit or debit cards. This request processes the transaction and returns a response indicating its status.

**Usage Scenarios:**
_- Charging customers for online or in-store purchases.
- Supporting installment payments when applicable.
- Ensuring secure and seamless payment processing._

**Notes:**
_- Some transactions may require additional steps, such as **authentication** or **tokenization**.
- An **idempotency key** must be included to prevent duplicate transactions.
- Always validate the payment response to confirm the transaction was successfully processed.
- To specify the type of transaction, you must avoid the type within the **data.payment.payment_method** field. Possible values are_ CREDIT, DEBIT, CREDIT_AUTHORIZATION, CREDIT_PRE_AUTHORIZATION. operationId: payment_2 parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTransactionChannelEntry' requestBody: content: application/json: schema: "$ref": "#/components/schemas/PaymentDTO" required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: "$ref": "#/components/schemas/AutorizationResponseDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product not Enable content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" patch: tags: - Payments summary: Adjustment description: __Update a Payment Transaction__

This endpoint allows you to update an existing payment transaction. It’s used to modify specific attributes of a transaction, such as updating metadata, correcting information, or adjusting payment details before final settlement.

**Usage Scenarios:**
_- Updating transaction details before processing.
- Correcting payment-related information.
- Adding or modifying metadata related to the transaction._

**Notes:**
_- Only certain fields can be updated. Ensure you review the request parameters to verify which modifications are allowed.
- Some updates may require additional validation or approval._ operationId: adjustment_2 parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTransactionChannelEntry' requestBody: content: application/json: schema: "$ref": "#/components/schemas/AdjustmentDTO" required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: "$ref": "#/components/schemas/AutorizationResponseDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product not Enable content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/hub-payment-info/v1/payments/info/{payment_id}: get: summary: Get Transaction tags: - Payments operationId: get-v1-payments description: __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. parameters: - $ref: '#/components/parameters/XSellerID' responses: '200': description: OK content: application/json: schema: type: object properties: payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' status: $ref: '#/components/schemas/status' payment: $ref: '#/components/schemas/payment' records: type: array items: $ref: '#/components/schemas/record' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" parameters: - schema: type: string format: uuid example: 8719d0c4-2c3f-4360-abd9-8daf3834fe1f minLength: 36 maxLength: 36 in: path name: payment_id description: Payment identifier. required: true post: summary: Create Idempotent Record description: __Ensuring Consistency in Payment Transactions__

This endpoint allows the creation of an **idempotent record** linked to a payment transaction. Idempotency ensures that if the same request is sent multiple times with the same `idempotency_key`, the response will always be the same, preventing duplicate operations.

**Notes:**
_- It is recommended to generate a unique idempotency_key for each request to avoid duplication issues.
- If the same idempotency_key has already been used in a previous request, the response will be identical without re-executing the operation._ tags: - Payment Record Management operationId: post-v1-payments-info-payment_id-idempotency-key responses: '201': description: Created '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/badRequest' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" requestBody: content: application/json: schema: type: object properties: rel: $ref: '#/components/schemas/rel' idempotency_key: $ref: '#/components/schemas/idempotency_key' items: type: array items: type: object properties: type: type: string enum: - request - response - result description: Record type. example: request content: description: Registry contents. oneOf: - $ref: '#/components/schemas/paymentAuthorizationResponse' - $ref: '#/components/schemas/paymentCancelResponse' - $ref: '#/components/schemas/paymentCaptureResponse' - $ref: '#/components/schemas/paymentPurchaseResponse' - $ref: '#/components/schemas/requestPayment' - $ref: '#/components/schemas/requestCapture' - $ref: '#/components/schemas/requestCancel' - $ref: '#/components/schemas/cancelResult' required: - type - content required: - rel - idempotency_key - items description: '' /dpm/payments-gwproxy/v2/payments/capture: post: tags: - Payments summary: Capture description: __Capture an Authorized Payment__

The Capture endpoint is used to finalize an authorized payment, ensuring that the transaction amount is deducted from the customer’s account and settled to the merchant.

**Usage Scenarios:**
_- Completing a payment after a successful authorization.
- Splitting authorization and capture into separate steps for better control over transaction processing.
- Reducing the captured amount if needed before final settlement (if partial capture is supported)._

**Notes:**
_- A payment must be **previously authorized** before capture.
- Some updates may require additional validation or approval.
- If the transaction is not captured within the allowed timeframe, the authorization may expire, requiring a new transaction._ operationId: capture_4 parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/CaptureDTO" required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: "$ref": "#/components/schemas/CaptureResponseDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/payments-gwproxy/v2/payments/cancel: post: tags: - Payments summary: Cancel description: __Cancel a Captured Payment__

The Cancel endpoint allows merchants to reverse a previously captured payment, ensuring that the transaction amount is refunded to the customer.

**Usage Scenarios:**
_- Voiding a payment that was captured by mistake.
- Handling order cancellations that require a full refund._

**Notes:**
_- Only **captured** payments can be canceled.
- The cancellation process may vary depending on the payment method and issuer.
- Some transactions may require additional processing time before the funds are returned to the customer._ operationId: cancel_7 parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/CancelDTO" required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: "$ref": "#/components/schemas/CancelResponseDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/payments-gwproxy/v2/payments/boleto: post: summary: Create BOLETO description: __Generate Payment with Boleto__

The Boleto endpoint allows merchants to generate a bank slip (boleto) for customers to complete payments via banking channels, ATMs, or authorized locations.

**Usage Scenarios:**
_- Offering an alternative payment method for customers without credit or debit cards.
- Enabling cash-based transactions with a due date for payment._

**Notes:**
_- The boleto must include an expiration date, after which payment is no longer valid.
- Once generated, the boleto cannot be modified; a new one must be issued if changes are required.
- Payment confirmation times vary depending on the bank’s processing policies._ tags: - Payments operationId: paymentBoleto_1 parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/PaymentBoletoDTO" required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/AutorizationResponseDTO" '400': description: Bad Request content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '404': description: Not Found content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal Server Error content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/payments-gwproxy/v2/payments/qrcode/pix: post: tags: - Payments summary: Create PIX description: __Generate Payment with PIX__

At this endpoint, payment data is processed to generate a **PIX QR Code** for the transaction. Once the QR Code is created, the payment confirmation will be sent to the merchant via an HTTP notification. For more details, refer to the **“PIX Notifications”** section in **Notifications 1.1** of this document.

**Usage Scenarios:**
_- Enabling instant payments with immediate confirmation.
- Providing a fast and secure alternative to traditional bank transfers or boletos.
- Supporting e-commerce and retail businesses with 24/7 payment availability._

**Notes:**
_- PIX transactions are processed in real time and cannot be reversed once completed.
- A **unique PIX key (QR Code or transaction ID)** is required for payment._ operationId: pix parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XQrCodeExpirationTime' requestBody: content: application/json: schema: "$ref": "#/components/schemas/PixDTO" required: true responses: '200': description: QR Code sucessfully generated and awaiting payment. content: application/json: schema: type: object additionalProperties: type: object '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" # PAYMENTS - 3DS /dpm/security-gwproxy/v2/enrolments-initial: post: tags: - Payments operationId: initial description: __3D Secure (3DS) Authentication Overview__

3D Secure is an authentication protocol designed to enhance the security of online transactions by verifying the identity of cardholders before a payment is processed. It reduces fraud and provides liability protection for merchants and issuers.

**Notes:**
_There are two main versions of the protocol:
- **3DS 1.0.2 -** The original version, which redirects customers to their card issuer’s website for authentication.
- **3DS 2.x –** The enhanced version, which offers a frictionless experience by using risk-based authentication and only requiring additional steps when necessary._

This structured approach ensures that you handle both 3DS 1.0.2 and 3DS 2.x flows appropriately, guiding the customer through the necessary steps while validating their authentication status.

**Initiates the Enrolment Flow for 3DS Authentication**

This endpoint begins the 3DS authentication process for a payment transaction. Follow the steps below to properly authenticate the cardholder:

**1. Start the Enrolment Process:** Call the endpoint to initiate the process.
**2. Determine the 3DS Protocol Version:** The response from the initial enrolment call indicates the 3DS protocol version in use.

**If the protocol is 3DS 1.0.2:**
**- Redirect:** Redirect the customer to their card issuer’s authentication page using the URL provided in the response.
**- Validate:** Once the customer has authenticated with their card issuer, call the **POST _/validations_** operation and, in the request, provide the payer authentication response that you received to verify whether the customer has been successfully authenticated.

**If the protocol is 3DS 2.x:**
**- Continue Enrolment:** Call the **POST _/enrolments-continue_** operation to generate the payload needed for the customer to authenticate with their card issuer. If the card issuer does not need to authenticate the customer, the response contains the **EnrolmentContinueFrictionlessResponse** object, meaning that the authentication status can be found in the response and no further action is needed. If the card issuer does need to authenticate the customer, the response contains the **EnrolmentContinueChallengeResponse** object and you must continue to the next steps.
**- Redirect:** Redirect the customer using the redirect URL included in the response to the **POST _/enrolments-initial_** operation to take the customer to their card issuer page for authentication.
**- Validate:** Once the customer has authenticated with their card issuer, call the **POST _/validations_** operation and, in the request, provide the payer authentication response that you received to verify whether the customer has been successfully authenticated. summary: "3DS - Init Authentication" parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/EnrolmentsInitialDTO" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/InitialResponseDTO" '400': description: Bad Request content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal Server Error content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" /dpm/security-gwproxy/v2/enrolments-continue: post: tags: - Payments operationId: enrolmentsContinue summary: 3DS - Banking Login Authentication Payload description: 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. parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/EnrolmentsContinueDTO" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ContinueResponseDTO" '400': description: Bad Request content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal Server Error content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" /dpm/security-gwproxy/v2/validations: post: tags: - Payments operationId: validations summary: 3DS - Validate authentication description: 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. parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/ValidationsDTO" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ValidationsResponseDTO" '400': description: Bad Request content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal Server Error content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" # PAYMENTS - Payment Record Management /dpm/hub-payment-info/v1/payments/info/{payment_id}/{idempotency_key}: parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/IdempotencyKeyPath' - $ref: '#/components/parameters/PaymentId' get: summary: Get by Idempotent Key description: __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._ tags: - Payment Record Management responses: '200': description: OK content: application/json: schema: type: object properties: rel: $ref: '#/components/schemas/rel' idempotency_key: $ref: '#/components/schemas/idempotency_key' registered_at: $ref: '#/components/schemas/registered_at' items: type: array items: type: object properties: registered_at: $ref: '#/components/schemas/registered_at' type: type: string enum: - request - response - result description: Record type. example: request content: description: Registry contents. oneOf: - $ref: '#/components/schemas/paymentAuthorizationResponse' - $ref: '#/components/schemas/paymentCancelResponse' - $ref: '#/components/schemas/paymentCaptureResponse' - $ref: '#/components/schemas/paymentPurchaseResponse' - $ref: '#/components/schemas/requestPayment' - $ref: '#/components/schemas/requestCapture' - $ref: '#/components/schemas/requestCancel' - $ref: '#/components/schemas/cancelResult' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" operationId: get-v1-payment-info-payment_id-component_id post: summary: Create Items in Idempotent Record description: __Create an Item Inside an Idempotent Record__

This endpoint allows adding a new item to an existing idempotent record, ensuring consistency in transaction processing. The idempotency mechanism guarantees that if the same request is sent multiple times, it will always be linked to the same payment operation instead of creating duplicates.

**Notes:**
_- This endpoint is essential for maintaining structured payment records while preventing duplicate processing.
- The content field must follow the appropriate schema depending on the transaction type (e.g., authorization, capture, or cancellation)._ tags: - Payment Record Management operationId: post-v1-payments-info-payment_id-idempotency_key responses: '201': description: Created '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/badRequest' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" requestBody: content: application/json: schema: type: object properties: type: type: string enum: - request - response - result description: Record type. example: request content: description: Contents of the record. oneOf: - $ref: '#/components/schemas/paymentAuthorizationResponse' - $ref: '#/components/schemas/paymentCancelResponse' - $ref: '#/components/schemas/paymentCaptureResponse' - $ref: '#/components/schemas/paymentPurchaseResponse' - $ref: '#/components/schemas/requestPayment' - $ref: '#/components/schemas/requestCapture' - $ref: '#/components/schemas/requestCancel' - $ref: '#/components/schemas/cancelResult' required: - type - content put: summary: Update a Idempotent Record description: __Modify or replace a transaction operation associated with an idempotent key__

This endpoint allows for updating a previously registered idempotent record using the PUT method. It’s primarily used to **replace the contents**of a transaction operation while maintaining the same idempotency key, ensuring that duplicate requests don’t create multiple payments.

**Notes:**
_- Idempotency ensures **consistency** in transaction processing by preventing the same request from creating multiple identical records.
- Items is an array that allows batch submission of operations (e.g., multiple authorizations or captures under the same transaction).
- This operation is typically used when **modifying a payment operation due to errors or state changes** in the payment lifecycle._ tags: - Payment Record Management operationId: put-v1-payments-info-payment_id-idempotency_key responses: '200': description: OK '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/badRequest' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" requestBody: content: application/json: schema: type: object properties: rel: $ref: '#/components/schemas/rel' idempotency_key: $ref: '#/components/schemas/idempotency_key' items: type: array items: type: object properties: type: type: string enum: - request - response - result description: Record type. example: request content: description: Contents of the record. oneOf: - $ref: '#/components/schemas/paymentAuthorizationResponse' - $ref: '#/components/schemas/paymentCancelResponse' - $ref: '#/components/schemas/paymentCaptureResponse' - $ref: '#/components/schemas/paymentPurchaseResponse' - $ref: '#/components/schemas/requestPayment' - $ref: '#/components/schemas/requestCapture' - $ref: '#/components/schemas/requestCancel' - $ref: '#/components/schemas/cancelResult' required: - type - content required: - rel - idempotency_key - items /dpm/hub-payment-info/v1/payments/info: post: summary: Add a Payment Record description: __Registering a Payment Transaction in the System__

This endpoint allows the creation of a payment record, registering essential transaction details such as status, payment method, and order identification. tags: - Payment Record Management operationId: post-v1-payments-info-payment_id parameters: - $ref: '#/components/parameters/XSellerID' responses: '201': description: Created '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/badRequest' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/internalServerError' security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" requestBody: content: application/json: schema: type: object properties: payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' status: $ref: '#/components/schemas/status' payment: $ref: '#/components/schemas/payment' required: - payment_id - order_id - status - payment # COMBINED PAYMENTS /dpm/payments-gwproxy/v2/payments/combined: post: tags: - Combined Payments summary: Authorize description: __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._ operationId: combined_ parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTransactionChannelEntry' requestBody: content: application/json: schema: "$ref": "#/components/schemas/CombinedPaymentDTO" required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: "$ref": "#/components/schemas/CombinedResponseDTOCombinedAutorizationResponseDataDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product not Enable content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/payments-gwproxy/v2/payments/combined/capture: post: tags: - Combined Payments summary: Capture description: __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._ operationId: capture parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTransactionChannelEntry' requestBody: content: application/json: schema: "$ref": "#/components/schemas/CombinedOperationsRequestDTOCombinedCapturetDataDTO" required: true responses: '200': description: Transaction executed successfully. content: application/json: schema: "$ref": "#/components/schemas/CombinedResponseDTOCaptureResponseDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. /dpm/payments-gwproxy/v2/payments/combined/cancel: post: tags: - Combined Payments summary: Cancel description: __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._ operationId: cancel parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTransactionChannelEntry' requestBody: content: application/json: schema: "$ref": "#/components/schemas/CombinedOperationsRequestDTOCombinedCancelDataDTO" required: true responses: '200': description: Transação executada com sucesso. content: application/json: schema: "$ref": "#/components/schemas/CombinedResponseDTOCancelResponseDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. # INSTALLMENTS /dpm/payments-gwproxy/v2/payments/quotes: post: tags: - Installments summary: Get Installments description: __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 six digits) and_ `number_token`. operationId: getCuotesApi requestBody: content: application/json: schema: "$ref": "#/components/schemas/InstallmentQuotesRequestDTO" required: true responses: '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/InstallmentQuotesResponseDTO" '400': description: Bad Request content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '404': description: Not Found content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal Server Error content: "*/*": schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" #CARDS /dpm/cofre-gw-proxy/v1/tokens/card: post: tags: - Cards summary: Generate Token description: __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._ operationId: createToken parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTraceID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/TokensCardRequest" required: true responses: '200': description: Card verification performed successfully. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/VerificationCardResponse" '400': description: Invalid request. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Bad Request description_detail: 'card_number lenght should be between 13 and 19. Current length: 4' '401': description: Invalid Authentication. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Safe product not enabled. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /v2/cards/binlookup/{bin}: get: tags: - Cards summary: BIN Lookup description: __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 6 to 8 digits of a card number.
- Useful for card validation, enrichment, and routing logic._ operationId: consultaBinUsingGET parameters: - name: bin in: path description: bin required: true schema: type: string responses: '200': description: Request executed successfully content: "*/*": schema: $ref: '#/components/schemas/consultaBinResponse' '401': description: Invalid authentication. Check your credentials or contact the Getnet Relationship Center. content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" '404': description: Not found content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" '500': description: Internal server error. Please try again later. content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" deprecated: false /dpm/cofre-gw-proxy/v1/cards: get: tags: - Cards summary: Get Cards By Customer Id description: __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._ operationId: getCardList parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTraceID' - $ref: '#/components/parameters/CustomerID' - $ref: '#/components/parameters/Status' responses: '200': description: List of saved cards. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/ListCardDataResponse" '400': description: Invalid request. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Bad Request description_detail: 'card_number lenght should be between 13 and 19. Current length: 4' '401': description: Invalid Authentication. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Safe product not enabled. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" post: tags: - Cards summary: Store Card in Vault description: __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._ operationId: saveCard parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTraceID' - $ref: '#/components/parameters/XByPassParameters' requestBody: content: application/json: schema: "$ref": "#/components/schemas/SaveCardDataRequest" required: true responses: '201': description: Card identifier created successfully. Card saved in safe. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/SaveCardDataResponse" '400': description: Invalid request. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Bad Request description_detail: 'card_number lenght should be between 13 and 19. Current length: 4' '401': description: Invalid authentication. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Safe product not enabled. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not found. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/cofre-gw-proxy/v1/cards/{card_id}: get: tags: - Cards summary: Get Card by Id description: __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._ operationId: getCard parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTraceID' - $ref: '#/components/parameters/CardIDParam' responses: '200': description: Card data. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/CardDataResponse" '400': description: Invalid request. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Bad Request description_detail: 'card_number lenght should be between 13 and 19. Current length: 4' '401': description: Invalid authentication. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Safe product not enabled. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" delete: tags: - Cards summary: Delete Card by Id description: __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._ operationId: removeCard parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTraceID' - $ref: '#/components/parameters/CardIDParam' responses: '204': description: Card removed successfully. '400': description: Invalid request. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Bad Request description_detail: 'card_number lenght should be between 13 and 19. Current length: 4' '401': description: Invalid authentication. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product vault not enabled. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/cofre-gw-proxy/v1/cards/verification: post: tags: - Cards summary: Card verification description: __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._ operationId: verificationCard parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/XTraceID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/VerificationCardRequest" required: true responses: '200': description: Card verification performed successfully. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/VerificationCardResponse" '400': description: Invalid request. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Bad Request description_detail: 'card_number lenght should be between 13 and 19. Current length: 4' '401': description: Invalid Authentication. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Safe product not enabled. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /dpm/cofre-gw-proxy/v1/cards/export: get: tags: - Cards summary: Cards Export description: __List Cards Saved in the Vault for Export__

This endpoint returns all cards saved in the secure vault, based on the seller’s identification. It is commonly used for auditing, exporting card data, or syncing with external systems.

**Usage Scenarios:**
_- Exporting stored card information for backup or synchronization.
- Listing all cards associated with a seller for administrative purposes.
- Auditing stored payment methods in the vault._

**Notes:**
_- Requires only the seller’s ID (_`x-seller-id`_) for authentication and filtering.
- No additional parameters are needed to retrieve the list.
- Returns card data including masked details, brand, expiration, and status.
- Only cards saved in the vault are included—buyer-level filtering is not available in this endpoint._ operationId: getCardList_1 parameters: - $ref: '#/components/parameters/XSellerID' responses: '200': description: List of saved cards. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/ListCardDataResponse" '400': description: Invalid request. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: GatewayVerifyCardServiceError status_code: 400 details: - status: DENIED error_code: TOKENIZATION-400 description: Bad Request description_detail: 'card_number lenght should be between 13 and 19. Current length: 4' '401': description: Invalid Authentication. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Unauthorized name: GatewayAuthenticationOAuth2ServiceError status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Safe product not enabled. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: GatewayParametersServiceError status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Not Found name: GatewayVerifyCardServiceError status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error. content: application/json; charset=utf-8: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: GatewayRouterHTTPServicesError status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" # CUSTOMERS /rpy/be-customer/v1/customers: get: tags: - Customers summary: Get Customers by Seller Id description: __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)._ operationId: getCustomers parameters: - $ref: '#/components/parameters/CustomerID' - name: id in: query description: Customer identifier. required: false schema: type: string - name: document_number in: query description: Customer's document number. required: false schema: type: string - name: first_name in: query description: Customer's first name. required: false schema: type: string - name: last_name in: query description: Customer's last name. required: false schema: type: string - name: sort in: query description: Field to carry out sorting. required: false schema: type: string default: last_name example: last_name - name: sort_type in: query description: Sort type. Ascending or Descending. required: false schema: type: string default: asc example: asc, desc - name: name in: query description: Customer's Full Name. required: false schema: type: string - name: status in: query description: Customer status. required: false schema: type: string example: active, inactive - name: page in: query description: Page number where pagination starts. required: true schema: type: integer format: int32 - name: limit in: query description: Limit results per page. required: true schema: type: integer format: int32 - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Country' - $ref: '#/components/parameters/Tenant' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/ListCustomersResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" post: tags: - Customers summary: Create Customer description: __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._ operationId: postCustomers parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/CustomerDTOSubs" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CustomerDTO" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: Bad Gateway content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-customer/v1/customers/{customer_id}: get: tags: - Customers summary: Get Customer by Id description: __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._ operationId: getCustomersById parameters: - name: customer_id in: path description: Customer identifier. required: true schema: type: string - $ref: '#/components/parameters/XSellerID' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/CustomerDTOSubs" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: Bad Gateway content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" # RECURRENCE PLANS /rpy/be-plan/v1/plans: get: tags: - Recurrence Plans summary: Get Plans by Seller Id description: __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._ operationId: plansGet_1 parameters: - name: page in: query description: Page number where pagination starts. required: true schema: minimum: 1 type: integer format: int32 - name: limit in: query description: Limit of results per page. required: true schema: maximum: 9999 minimum: 0 type: integer format: int32 - $ref: '#/components/parameters/XSellerID' - name: plan_id in: query description: Plan identifier. required: false schema: type: string format: uuid - name: id in: query description: Plan identifier. required: false schema: type: string format: uuid - name: status in: query description: Plan status. required: false schema: type: string - name: name in: query description: Recurrence plan name. required: false schema: maxLength: 2147483647 minLength: 3 type: string - name: sort in: query description: Field to carry out the ordering. required: false schema: type: string default: name - name: sort_type in: query description: Sort type. Ascending or Descending ("asc" e "desc"). required: false schema: type: string - name: expand in: query description: Expand. required: false schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/PlanDataWrapper" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" post: tags: - Recurrence Plans summary: Create Recurrence Plan description: __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`_)._ operationId: plansPost_1 parameters: - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/PlanRequest" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Plan" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: Bad Gateway content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '504': description: Gateway Timeout content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-plan/v1/plans/{plan_id}: get: tags: - Recurrence Plans summary: Get Plan by Id description: __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._ operationId: plansIdGet parameters: - $ref: '#/components/parameters/PlanID' - name: expand in: query required: false schema: type: array items: type: string - $ref: '#/components/parameters/XSellerID' responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Plan" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" patch: tags: - Recurrence Plans summary: Update Plan description: __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._ operationId: plansIdPut parameters: - $ref: '#/components/parameters/PlanID' - name: username in: header description: User who is registering. This information may be used for auditing purposes. required: false schema: type: string - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/UpdatePlan" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/Plan" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-plan/v1/plans/subscriptions/migration: post: tags: - Recurrence Plans summary: Migrate Subscriptions description: __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._ operationId: plansSubscriptionsMigration parameters: - name: username in: header description: User who is registering. This information may be used for auditing purposes. required: false schema: type: string - $ref: '#/components/parameters/XSellerID' requestBody: content: application/json: schema: "$ref": "#/components/schemas/SubscriptionPlanMigration" required: true responses: '202': description: Accepted content: application/json: schema: "$ref": "#/components/schemas/SubscriptionPlanMigration" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-plan/v1/plans/{plan_id}/status/{status}: patch: tags: - Recurrence Plans summary: Update Plan status operationId: plansUpdateStatus description: __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._ parameters: - name: Content-Type in: header description: Content type. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' - $ref: '#/components/parameters/PlanID' - name: status in: path description: Plan status. required: true schema: type: string enum: - active - inactive responses: '200': description: Returns plan data. content: application/json: schema: $ref: '#/components/schemas/PlanResponse' '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" # SUBSCRIPTIONS /rpy/be-subscription/v1/subscriptions: get: tags: - Subscriptions summary: Get Subscriptions by Seller Id description: __List Subscriptions for a specific Seller__

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`_)._ operationId: subscriptionsGet parameters: - name: page in: query description: Page number where pagination begins. required: true schema: minimum: 1 type: integer format: int32 - name: limit in: query description: Limit results per page. required: true schema: minimum: 1 type: integer format: int32 - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/CustomerID' - $ref: '#/components/parameters/PlanID' - $ref: '#/components/parameters/OrderID' - $ref: '#/components/parameters/SubscriptionID' - name: id in: query description: Recurrence signature identifier. required: false schema: type: string format: uuid - name: next_scheduled_date[start] in: query description: Start date of the next appointment. required: false schema: type: string - name: next_scheduled_date[end] in: query description: End date of the next appointment. required: false schema: type: string - name: installment_start_date[start] in: query description: Search start date by payment start date. required: false schema: type: string format: date - name: installment_start_date[end] in: query description: Search end date by payment start date. required: false schema: type: string format: date - name: create_date[start] in: query description: Subscription creation start date. required: false schema: type: string - name: create_date[end] in: query description: Subscription creation end date. required: false schema: type: string - name: end_date[start] in: query description: Subscription start date. required: false schema: type: string - name: end_date[end] in: query description: Subscription end date. required: false schema: type: string - name: sort in: query description: Field to perform the sorting. required: false schema: type: string default: status - name: sort_type in: query description: Sorting type. Ascending or Descending. required: false schema: type: string default: asc - name: status in: query description: Subscription status. required: false schema: type: string - name: expand in: query description: Date and value fluctuations required: false schema: type: array items: type: string responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/FilteredResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" post: tags: - Subscriptions summary: Create Subscription description: __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._ operationId: subscriptionsPost parameters: - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' requestBody: content: application/json: schema: "$ref": "#/components/schemas/SubscriptionCreation" required: true responses: '201': description: Request made successfully content: application/json;charset=UTF8: schema: "$ref": "#/components/schemas/SubscriptionResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscription_id}: get: tags: - Subscriptions summary: Get Subscription by Id description: __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._ operationId: subscriptionGet parameters: - name: subscription_id in: path description: Buyer identifier. required: true schema: type: string - $ref: '#/components/parameters/XSellerID' - name: expand in: query description: Date and value fluctuations required: false schema: type: array items: type: string responses: '200': description: Request made successfully content: "*/*": schema: "$ref": "#/components/schemas/SubscriptionResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscription_id}/cancel: post: tags: - Subscriptions summary: Cancel Subscription description: __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._ operationId: subscriptionCancel parameters: - name: subscription_id in: path description: Buyer identifier. required: true schema: type: string - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' requestBody: content: application/json: schema: "$ref": "#/components/schemas/SubscriptionCancel" required: true responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/SubscriptionResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscription_id}/charges/projection: get: tags: - Subscriptions summary: Projection of Charges description: __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._ operationId: chargesProjection parameters: - name: subscription_id in: path description: Recurrence signature identifier. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' - name: expand in: query description: Additional information on the installment number and/or fluctuations in date and value. {installment,floating_data} required: false schema: type: string - name: limit in: query required: false schema: type: integer format: int32 responses: '200': description: Request made successfully content: application/json;charset=utf-8: schema: "$ref": "#/components/schemas/AmountProjection" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: O serviço está indisponível. Por favor tente mais tarde. content: application/json;charset=utf-8: schema: "$ref": "#/components/schemas/AmountProjection" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscription_id}/confirmPayment: post: tags: - Subscriptions summary: Confirm Payment for a Subscription description: __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.
_ operationId: confirmChargePayment parameters: - name: subscription_id in: path description: Recurrence signature identifier. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' requestBody: content: application/json: schema: "$ref": "#/components/schemas/ConfirmPayment" required: true responses: '200': description: OK content: application/json: schema: "$ref": "#/components/schemas/SubscriptionResponse" '201': description: Payment confirmed successfully. content: application/json: schema: "$ref": "#/components/schemas/SubscriptionResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscription_id}/paymentDate: patch: tags: - Subscriptions summary: Update Payment Date description: __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._ operationId: paymentDatePatch parameters: - name: subscription_id in: path description: Buyer identifier. required: true schema: type: string - $ref: '#/components/parameters/XSellerID' - name: username in: header description: User who is registering. This information can be used for audit purposes. required: false schema: type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/PaymentDate" required: true responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/SubscriptionResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Not Found content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscription_id}/paymentType/credit/card: patch: tags: - Subscriptions summary: Update Payment Data description: __Update Subscription Payement 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._ operationId: patchPaymentData parameters: - name: subscription_id in: path description: Recurrence signature identifier. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' - name: username in: header description: User who is registering. This information can be used for audit purposes. required: false schema: type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/ReplaceCreditCard" required: true responses: '200': description: Data updated successfully. content: application/json: schema: "$ref": "#/components/schemas/SubscriptionResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscriptionId}/floating: get: tags: - Subscriptions summary: Get Changes of Subscription Installments description: __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._ operationId: floatingDataGet parameters: - name: subscriptionId in: path description: Identifier of the recurrence subscription. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" post: tags: - Subscriptions summary: Set Changes of Subscription Installments description: __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._ operationId: subscriptionFloatingDataPost parameters: - name: subscriptionId in: path description: Recurrence signature identifier. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' requestBody: content: application/json: schema: type: array description: Request containing data for registration of a new signature. items: "$ref": "#/components/schemas/FloatingData" required: true responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" '201': description: Created content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '403': description: Product Recurrence is not enabled. Please contact the Getnet Relationship Center. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: The service is unavailable. Please try again later. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" delete: tags: - Subscriptions summary: Delete Changes of Subscription Installments description: __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._ operationId: floatingDataDeleteAll parameters: - name: subscriptionId in: path description: Identificador da assinatura. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' responses: '200': description: Request partially completed successfully. List fluctuations that cannot be removed and their reasons. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataRemoveResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '403': description: Product Recurrence is not enabled. Please contact the Getnet Relationship Center. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: The service is unavailable. Please try again later. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataRemoveResponse" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" patch: tags: - Subscriptions summary: Update Changes of Subscription Installments description: __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._ operationId: subscriptionFloatingDataPatch parameters: - name: subscriptionId in: path description: Recurrence subscription identifier. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' requestBody: content: application/json: schema: type: array description: Request containing data for registration of a new signature. items: "$ref": "#/components/schemas/FloatingData" required: true responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '403': description: Product Recurrence is not enabled. Please contact the Getnet Relationship Center. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: O serviço está indisponível. Por favor tente mais tarde. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscriptionId}/floating/installment/{installment}: put: tags: - Subscriptions summary: Update fluctuation of Subscription Installment description: __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._ operationId: subscriptionFloatingDataPut parameters: - name: subscriptionId in: path description: Recurrence subscription identifier. required: true schema: type: string format: uuid - name: installment in: path description: Identifier of the billing installment. required: true schema: type: integer format: int32 - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' requestBody: content: application/json: schema: "$ref": "#/components/schemas/FloatingDataUpdate" required: true responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '403': description: Product Recurrence is not enabled. Please contact the Getnet Relationship Center. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: The service is unavailable. Please try again later. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" delete: tags: - Subscriptions summary: Delete fluctuation of Subscriptions Installment description: __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._ operationId: floatingDataDelete parameters: - name: subscriptionId in: path description: Subscription identifier. required: true schema: type: string format: uuid - name: installment in: path description: Identificador da parcela da cobrança. required: true schema: type: integer format: int32 - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' responses: '200': description: Request partially completed successfully. List fluctuations that cannot be removed and their reasons. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataRemoveResponse" '204': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/FloatingDataRemoveResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '403': description: Product Recurrence is not enabled. Please contact the Getnet Relationship Center. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataRemoveResponse" '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: The service is unavailable. Please try again later. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/subscriptions/{subscriptionId}/plans/migration: post: tags: - Subscriptions summary: Migrate Subscription Plan description: __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._ operationId: migrateSubscriptionPlan parameters: - name: subscriptionId in: path description: Subscription plan change. required: true schema: type: string format: uuid - $ref: '#/components/parameters/XSellerID' - $ref: '#/components/parameters/Username' requestBody: content: application/json: schema: "$ref": "#/components/schemas/PlanMigrationRequest" required: true responses: '200': description: Request made successfully content: application/json: schema: "$ref": "#/components/schemas/SubscriptionResponse" '400': description: Invalid Requisition content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '404': description: Signature not found. content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server or service error content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '502': description: The service is unavailable. Please try again later. content: application/json: schema: "$ref": "#/components/schemas/FloatingDataResponse" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" /rpy/be-subscription/v1/charges: get: tags: - Subscriptions summary: Get All Charges description: __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._ operationId: getAllCharges parameters: - name: page in: query required: false schema: type: integer format: int32 - name: limit in: query required: false schema: type: integer format: int32 - name: retries in: query required: false schema: type: integer format: int32 - name: plan_id in: query required: false schema: type: string - name: subscription_id in: query required: false schema: type: string - name: start_date in: query required: false schema: type: string format: date - name: end_date in: query required: false schema: type: string format: date - name: sort in: query required: false schema: type: string - name: sort_type in: query required: false schema: type: string - name: status in: query required: false schema: type: string - name: scheduled_date in: query required: false schema: type: string format: date - name: charge_id in: query required: false schema: type: string - name: customer_id in: query required: false schema: type: string - name: seller_id in: query required: false schema: type: string - name: payment_type in: query description: Type of payment. Comma delimited. schema: type: string enum: - credit_card - debit_card - $ref: '#/components/parameters/XSellerID' responses: '200': description: Request executed successfully content: "*/*": schema: "$ref": "#/components/schemas/PaymentResponse" '400': description: Invalid request. content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" '401': description: Invalid authentication. Check your credentials or contact the Getnet Relationship Center. content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" '404': description: Not found content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" '422': description: Unprocessable Entity content: application/json: schema: "$ref": "#/components/schemas/DefaultErrorHttpResponse" '500': description: Internal server error. Please try again later. content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" '504': description: The server encountered a temporary error and did not complete the request. Please try again later. content: "*/*": schema: "$ref": "#/components/schemas/ErrorDetail" security: - PROD: - "digital-platform:gateway-api" - PRE: - "digital-platform:gateway-api" - SBX: - "digital-platform:gateway-api" components: securitySchemes: PROD: type: "oauth2" flows: clientCredentials: tokenUrl: "https://api.globalgetnet.com/authentication/oauth2/access_token" scopes: digital-platform:gateway-api: "Read and write access" PRE: type: "oauth2" flows: clientCredentials: tokenUrl: "https://api.pre.globalgetnet.com/authentication/oauth2/access_token" scopes: digital-platform:gateway-api: "Read and write access" SBX: type: "oauth2" flows: clientCredentials: tokenUrl: "https://api-sbx.globalgetnet.com/authentication/oauth2/access_token" scopes: digital-platform:gateway-api: "Read and write access" parameters: PaymentId: name: payment_id in: path description: "Payment ID to be used in the query" required: true style: simple explode: false example: "44c1206c-fcfc-11ea-adc1-0242ac120002" schema: type: string format: uuid DigitalServiceID: name: digital-service-id in: query description: "Array of services to be included in the response.

The possible values are:
- ANTIFRAUD = Anti-fraud service that provides anti-fraud checks on payments created using a card
- CARD_VERIFICATION = Card verification service that can be performed before a payment transaction to improve authorization rates
- CHECKOUT = Checkout service that defines your web store's checkout configuration
- PAYMENT = Payment service that allows you to use the Checkout API to create payments
- THREEDS = 3DS service that allows you to authenticate your customers using 3DS
- VAULT = Vault service that allows you to store your customers' payment methods
- TOKENIZATION = Tokenization service that allows you to tokenize data. This service is primarily used to tokenize a customer's payment method details.
- COMBINED = Additional payment service on top of 'PAYMENT' that allows you to create combined payments" schema: type: array items: type: string enum: - ANTIFRAUD - VAULT - CARD_VERIFICATION - COMBINED - THREEDS - CHECKOUT - PAYMENT - TOKENIZATION IdempotencyKey: name: idempotency-key in: header description: "Idempotent key for the transaction.

If an identical request is submitted multiple times, the key ensures that the response is always related to the same payment (instead of creating multiple identical payments)." schema: type: string format: uuidv4 example: "fd23d518-e622-4744-bc1f-3870f23610de" IdempotencyKeyPath: name: idempotency_key in: path description: "Idempotent key for the transaction.

If an identical request is submitted multiple times, the key ensures that the response is always related to the same payment (instead of creating multiple identical payments)." required: true schema: type: string format: uuidv4 example: "fd23d518-e622-4744-bc1f-3870f23610de" XSellerID: name: x-seller-id in: header description: "Seller ID.

Authorization: E-commerce identification code. Required when the client is treated as a Platform." schema: type: string format: uuidv4 example: "997f9ccd-e336-4fc3-80b8-781faca29e86" XTransactionChannelEntry: name: x-transaction-channel-entry in: header description: "Field used to identify the platform that will be sending the transaction

(The code to be informed must be previously requested from GetNet)" schema: type: string format: uuidv4 example: "XX" CardIDParam: name: card_id in: path description: "Card ID to be used in the query" example: "e02200f0-ab41-11eb-bcbc-0242ac130002" required: true schema: type: string format: uuidv4 MethodIDParam: name: method_id in: path description: "Method ID to be used in the query" example: "e02200f0-ab41-11eb-bcbc-0242ac130002" required: true schema: type: string format: uuidv4 ExpirationPolicyParam: name: expiration-policy in: header description: "Token expiration policy.

The possible values are:
- expiration = Token expires after 30 days
- no-expiration = Token does not expire

The default value is 'expiration'." required: false schema: type: string enum: - expiration - no-expiration PaymentIntentIDParam: name: payment_intent_id in: path description: "Payment intent ID to be used in the query" example: ee0b7dd5-92da-4ef4-ad3b-0ba369ad0efe required: true schema: type: string format: uuidv4 SellerID: name: seller_id in: path description: "Seller ID to be used in the query" example: "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" required: true schema: type: string format: uuidv4 ServiceID: name: service_id in: path description: "Service ID to be used in the query.

The possible values are:
- ANTIFRAUD = Anti-fraud service that provides anti-fraud checks on payments created using a card
- CARD_VERIFICATION = Card verification service that can be performed before a payment transaction to improve authorization rates
- CHECKOUT = Checkout service that defines your web store's checkout configuration
- PAYMENT = Payment service that allows you to use the Checkout API to create payments
- THREEDS = 3DS service that allows you to authenticate your customers using 3DS
- VAULT = Vault service that allows you to store your customers' payment methods
- TOKENIZATION = Tokenization service that allows you to tokenize data. This service is primarily used to tokenize a customer's payment method details.
- COMBINED = Additional payment service on top of 'PAYMENT' that allows you to create combined payments" example: "payments" required: true schema: type: string enum: - ANTIFRAUD - CHECKOUT - PAYMENT - THREEDS - VAULT - CARD_VERIFICATION - TOKENIZATION - COMBINED UpdateServiceID: name: service_id in: path description: "Service ID to be used in the query" example: "PAYMENT" required: true schema: type: string enum: - PAYMENT XTraceID: name: x-trace-id in: header description: Code sent by the Gateway to trace the transaction. required: false schema: type: string example: c7a7e64d-6e42-4425-b123-3fb0afebca6e Country: name: country in: header required: false description: Country identifier. schema: type: string default: BR Tenant: name: tenant in: header required: false description: Tenant identifier. schema: type: string default: santander CustomerID: name: customer_id in: query description: Buyer identifier. Application-defined information that consumes the Digital Platform API. required: true schema: type: string example: ec0e9f0b-d96f-405a-8e89-cb32f1da1841 Status: name: status in: query description: Status filter for returned cards. If not informed No filter, active and renewed cards will be returned. required: false schema: type: string enum: - all - active - renewed XByPassParameters: name: x-by-pass-parameters in: header description: Condition to not validate whether the product vault is enabled parameters. required: false schema: type: boolean example: false Authorization: name: Authorization in: header description: "Authorization: Bearer *AuthString*
Where *AuthString* is access token obtained from the authentication endpoint." required: false schema: type: string PlanID: name: plan_id in: path description: Plan identifier. required: true schema: type: string format: uuid OrderID: name: order_id in: query description: Código de identificação da compra utilizado pelo e-commerce. required: false schema: type: string SubscriptionID: name: subscription_id in: query description: Identificador da assinatura de recorrência. required: false schema: type: string format: uuid XQrCodeExpirationTime: name: x-qrcode-expiration-time in: header description: "It is possible to customize the expiration time of the QR Code by entering the desired time in seconds, if it is not informed the operation will go with the default value of 180s, The maximum value for expiration time is 1800s" schema: type: number default: "180" Username: name: username in: header description: User who is registering. This information can be used for audit purposes. required: false schema: type: string examples: invalid_api_key: value: Invalid API Key invalid_api_token: value: Invalid Token vault_product_not_enabled: value: code: product_not_enabled message: Product is not enabled. details: [] transaction_expired: value: code: transaction_expired message: Transaction Expired details: [] invalid_token: value: code: invalid_token message: Invalid Token details: [] invalid_transaction_status: value: code: invalid_transaction_status message: Invalid Transaction Status details: [] transaction_not_found: value: code: transaction_not_found message: Transaction not found details: [] 3ds_product_is_not_enabled: value: code: product_is_not_enabled message: 3DS product not enabled details: [] mpi_error: value: code: mpi_error message: Message from provider details: [] token_not_found: value: code: token_not_found message: Token not found details: [] seller_not_found: value: code: seller_not_found message: Seller not found details: [] card_not_found: value: code: card_not_found message: Card not found details: [] product_not_enabled: value: code: product_not_enabled message: Product is not enabled details: [] payment_method_not_found: value: code: payment_method_not_found message: Payment method not found details: [] installment_quote_not_found: value: code: installment_quote_not_found message: Installment payment quote not found details: [] vault_product_is_not_enabled: value: code: product_is_not_enabled message: Vault product not enabled details: [] invalid_token_method_type: value: code: invalid_token_method_type message: Invalid token method type details: [] card_expiration_month_not_valid: value: code: card_expiration_not_valid message: Card expiration month not valid; it must be a future date details: [] card_expiration_year_not_valid: value: code: card_expiration_not_valid message: Card expiration year not valid; it must be a future date details: [] digital_service_not_found: value: code: digital_service_not_found message: Digital service not found details: [] payment_type_is_not_active: value: code: payment_type_is_not_active message: Payment type not active details: [] payment_brand_not_allowed: value: code: payment_brand_not_allowed message: The payment brand is not allowed to be used details: [] installment_number_not_supported: value: code: installment_number_not_supported message: Installment number not supported details: [] installment_type_not_available: value: code: installment_type_not_available message: Installment type not available details: [] installment_plan_not_contracted: value: code: installment_plan_not_contracted message: Installment plan not contracted details: [] installment_option_not_available: value: code: installment_option_not_available message: Installment option not available details: [] payment_does_not_exist: value: code: payment_does_not_exist message: Payment does not exist details: [] combined_payment_is_not_active: value: code: combined_payment_is_not_active message: Combined payment not active details: [] payment_amount_error: value: code: payment_amount_error message: Payment amount not the same as transaction amount details: [] cancelling_when_status_denied: value: code: invalid_status message: It's not possible to cancel a payment with status Denied details: [] cancelling_when_status_cancelled: value: code: invalid_status message: It's not possible to cancel a payment with status Cancelled details: [] refund_cancelled_and_mode_manual: value: code: invalid_status message: It's not possible to refund a payment with status Cancelled and capture_mode manual details: [] refund_denied_and_mode_manual: value: code: invalid_status message: It's not possible to refund a payment with status Denied and capture_mode manual details: [] refund_authorized_and_mode_manual: value: code: invalid_status message: It's not possible to refund a payment with status Authorized and capture_mode manual details: [] invalid_refund_amount: value: code: invalid_refund_amount message: The amount must be less than or equal to the original amount details: [] refund_already_completed: value: code: refund_already_completed message: The refund has already been completed details: [] capture_when_status_cancelled: value: code: invalid_status message: It's not possible to capture a payment with status Cancelled details: [] capture_when_status_denied: value: code: invalid_status message: It's not possible to capture a payment with status Denied details: [] invalid_capture_mode_to_capture: value: code: invalid_capture_mode message: It's not possible to capture a payment with capture_mode automatic details: [] checkout_product_not_enabled: value: code: product_is_not_enabled message: Checkout product not enabled details: [] amount_value_invalid: value: code: business_error message: Amount value must be greater than zero. details: [] checkout_configuration_not_found: value: code: checkout_configuration_not_found message: Checkout configuration not found. details: [] currency_not_allowed: value: code: currency_not_allowed message: Currency not allowed details: [] payment_intent_not_found: value: code: payment_intent_not_found message: Payment intent not found details: [] payment_intent_already_paid: value: code: payment_intent_already_paid message: Payment Intent has already been paid. details: [] payment_data_not_provided: value: code: payment_data_not_provided message: The 'payment.' parameter must be provided details: [] 3ds_not_enabled: value: code: 3ds_not_enabled message: 3DS is not enabled, 'authentication' field is forbidden details: [] country_code_invalid_or_not_found: value: code: country_code_invalid_or_not_found message: country_code invalid or not found details: [] card_not_accepted: value: code: card_not_accepted message: Card not accepted for this operation, domestic interchange only details: [] bin_card_invalid: value: code: bin_card_invalid message: Bin card invalid for this operation details: [] bin_not_found: value: code: bin_not_found message: The Bin was not found details: [] request_installment_quote_with_one_plan: summary: "Request contains 1 installment plan" description: "The response contains installment quotes for a single installment plan consisting of 6 installments with no interest" value: installment_schema: ['plan_ahora'] installment_type: ['no_interest'] number_installments: [6] amount: 12000 bin: 60107000 request_installment_quote_with_many_plans: summary: "Request contains multiple installment plans" description: "The response contains installment quotes for 2 installment plans consisting of 6 installments with interest" value: installment_schema: ['plan_emisor', 'plan_emissor'] installment_type: ['with_interest'] number_installments: [6] amount: 12000 bin: 60107000 request_installment_quote_with_many_installments: summary: "Request contains multiple options for the number of installments" description: "Response contains installment quotes for a single installment plan consisting of either 3, 6, 9, or 12 installments with no interest" value: installment_schema: ['plan_ahora'] installment_type: ['no_interest'] number_installments: [3,6,9,12] amount: 12000 bin: 60107000 schemas: payment: title: payment type: object properties: payment_method: $ref: '#/components/schemas/payment_method' save_card_data: type: boolean example: false default: false description: Determine whether the card should be saved for future purchases. Only for customers using the GetNet vault. transaction_type: type: string description: Transaction type. Payment in cash or in installments to the retailer or in installments to the issuer. example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: number example: 1 description: Number of installments. soft_descriptor: $ref: '#/components/schemas/soft_descriptor' dynamic_mcc: type: number example: 1234 description: 'Field used to signal the transaction with another Merchant Category Code (Establishment Category Code) different from the registered one. If an invalid MCC is sent, the default will be used. Send numeric data only.' card: type: object description: Card data set. required: - number - brand - expiration_month - expiration_year properties: number: type: string maxLength: 23 example: '517' description: Card number masked. brand: $ref: '#/components/schemas/brand' expiration_month: type: string minLength: 2 maxLength: 2 example: '09' description: Card expiration month. expiration_year: type: string example: '30' minLength: 2 maxLength: 2 description: Card expiration year cardholder_name: type: string example: Roland Deschain maxLength: 26 description: |- Bearer's name printed on the card. Mandatory field for using Anti-Fraud required: - payment_method - amount - transaction_type - number_installments - card seller_id: title: seller_id type: string example: 9406df6c-3100-49ba-b4df-d81c1ad8a62b minLength: 36 maxLength: 36 format: uuid description: ECommerce identification code request_id: title: request_id type: string example: daac03dc-73db-453f-9bea-b1391669d5d3 minLength: 36 maxLength: 36 format: uuid description: Request identifier. Unique for each request payment_id: title: payment_id type: string description: Payment identifier example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 format: uuid minLength: 36 maxLength: 36 order_id: title: order_id type: string example: ORDER-10187383 description: Purchase identification code used by e-commerce (code or order number). amount: type: number title: amount description: Purchase value in cents example: 8900 currency: title: currency type: string example: BRL description: 'Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html")' received_at: title: received_at type: string example: '2020-06-30T18:32:51.222Z' description: Transaction date transaction_id: title: transaction_id type: string example: '3729756321501820' description: Transaction identifier generated by the eCommerce platform authorized_at: title: authorized_at type: string example: '2020-06-30T18:32:51.815Z' description: Transaction authorization date acquirer: title: acquirer type: string example: GETNET description: Adquirente. default: GETNET soft_descriptor: title: soft_descriptor type: string example: 'MEUECOMM*ORDER10187383' description: "Text displayed on the buyer's card invoice, This field is optional, if nothing is entered, it will be considered the business name registered for the establishment. Only alphanumeric data and the following special characters are allowed in this field: % $ , . / & ( ) + = = < > - * Spaces will be replaced by the character '*' The transaction will not be denied if non-allowed characters are sent. Any information that exceeds the maximum size will be disregarded." brand: title: brand type: string example: VISA enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD maxLength: 50 description: |- Bcard walker. Automatically populated by the API if not informed. Mandatory field for using Anti-Fraud authorization_code: title: authorization_code type: string example: '017060' minLength: 6 maxLength: 6 description: Authorization Code generated by the Issuer when the transaction is carried out successfully acquirer_transaction_id: title: acquirer_transaction_id type: string example: '000152147981' description: NSU of the GetNet transaction (Acquirer) eci: title: eci type: string description: |- Code indicating whether the transaction was processed with Bearer Authentication. 00, 01 and 02 for Mastercard and 05, 06 and 07 for Visa and other brands example: '07' minLength: 2 maxLength: 2 total_installment_amount: title: total_installment_amount example: 8900 type: number description: 'For installment transactions, this contains the total amount to be paid (amount plus interest, taxes, fees, etc.).' first_installment_amount: title: first_installment_amount example: 1485 type: number description: 'For installment transactions, this contains the value of the first installment to be paid.' other_installment_amount: title: other_installment_amount type: number example: 1483 description: 'For installment transactions, this contains the value of the remaining installments to be paid.' payment_method: title: payment_method type: string example: CREDIT enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION description: Payment Method, should equals Authorization status: type: string example: APPROVED description: Transaction Status enum: - APPROVED - DENIED - ERROR - ACCEPTED idempotency_key: type: string title: idempotency_key format: (a-Z | 0-9 | .-_) example: 63c7f8ee-51a6-470d-bb76-ef762b62bfb7 minLength: 1 maxLength: 64 description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. reason_code: title: reason_code type: string minLength: 2 maxLength: 2 example: '00' description: "Return code from the sender or the getnet capture system." reason_message: title: reason_message type: string example: TRANSACTION EXECUTED SUCCESSFULLY description: "Return message from the sender or the getnet capture system." custom_key: title: custom_key type: string minLength: 3 maxLength: 32 example: 20200630-8900 description: Customer key used to identify a cancellation request. (Key must be unique per transaction). customer_id: type: string description: 'Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification.' maxLength: 36 plan_id: description: Recurrence plan identifier. type: string minLength: 36 maxLength: 36 format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd md: type: string description: "ID defined by the merchant to identify the enrolment response" example: "NmQyZTQzODAtZDhhMy00Y2NiLTkxMzgtYzI4OTE4MjgxOGE0" tx_id: type: integer description: "Transaction ID used by the 3DS provider" example: 9349151 xid: type: string description: "Transaction ID returned by the card issuer.\n\nThe value is 28 bytes (unique 20 byte value that has been Base64-encoded)." example: "VDdnR0kyU1g4ZXlxMkhWTlp0VnA=" status3DS: $ref: "#/components/schemas/StatusTransaction" protocol: type: string description: "3DS protocol used during processing" example: "3DS2.2.0" operation: type: string description: "Card operation type" example: CREDIT enum: - CREDIT - DEBIT default: CREDIT cavv: type: string description: "Unique token returned by the card issuer indicating that the transaction has been authenticated.\n\nThe value is the Cardholder Authentication Verification Value (CAVV) for Visa cards and the Account Authentication Value (AAV) for Mastercard cards." example: "2" ds_trans_id: description: "Unique directory server transaction ID. Applies only when the value of 'protocol' is '3DS2.2.0' and the card brand is Mastercard." type: string format: uuid example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 redirect_html_template: type: string description: "HTML template for redirecting the customer to the card issuer's authentication flow" example: "\n\n\n\n\n3D Secure Processing\n\n\n\n

3D Secure Processing

\n\n

\n $\"Please$

\n $\"MasterCard$

\n\n

\n\n\n" requestPayment: type: object title: requestPayment properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' request_id: $ref: '#/components/schemas/request_id' order_id: $ref: '#/components/schemas/order_id' data: type: object description: Data set to be encrypted required: - payment properties: amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' customer_id: type: string maxLength: 100 description: Buyer identifier example: 6df370e7-8f97-4e7a-a36e-16ad2db6c5fc payment: $ref: '#/components/schemas/payment' sub_merchant: type: object description: 'Set of data relating to payment facilitator. If provided, all attributes are mandatory.' properties: identification_code: type: string example: '9058344' maxLength: 15 description: Subcommerce identifier. document_type: type: string enum: - CPF - CNPJ example: CNPJ maxLength: 4 minLength: 3 description: Document type. document_number: type: string example: '20551625000159' minLength: 11 maxLength: 14 description: Subcommerce document (without mask). address: type: string example: 'Torre Negra, 44' maxLength: 40 description: Sub-commerce street. city: type: string maxLength: 13 example: City description: City of subcommerce. state: type: string example: RS minLength: 2 maxLength: 2 description: State of subcommerce postal_code: type: string example: '90520000' maxLength: 8 description: Postal code (CEP) of the subcommerce required: - identification_code - document_type - document_number - address - city - state - postal_code additional_data: type: object required: - idempotency_key - order_id - data requestCapture: type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' payment_method: type: string example: CREDIT_AUTHORIZATION enum: - CREDIT_AUTHORIZATION description: Payment Method amount: type: number example: 8900 description: Value equal to or less than the original transaction in cents required: - payment_id - payment_method - idempotency_key title: requestCapture requestCancel: type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' payment_method: $ref: '#/components/schemas/payment_method' amount: type: number example: 8900 description: "Value equal to or less than the original transaction. Only use in the case of partial cancellations in D+N. If not informed, the value of the original transaction will be considered." custom_key: $ref: '#/components/schemas/custom_key' required: - payment_id - payment_method - custom_key - idempotency_key title: requestCancel paymentAuthorizationResponse: title: paymentAuthorizationResponse type: object description: Credit Authorization Response Dataset properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' status: type: string example: AUTHORIZED description: Transaction status payment_method: type: string example: CREDIT_AUTHORIZATION description: Payment method enum: - CREDIT_AUTHORIZATION received_at: $ref: '#/components/schemas/received_at' transaction_id: $ref: '#/components/schemas/transaction_id' original_transaction_id: type: string example: '-1' description: Original transaction identifier authorized_at: $ref: '#/components/schemas/authorized_at' reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' acquirer: $ref: '#/components/schemas/acquirer' soft_descriptor: $ref: '#/components/schemas/soft_descriptor' brand: $ref: '#/components/schemas/brand' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' eci: $ref: '#/components/schemas/eci' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' record: title: Record Object type: object description: '' properties: rel: $ref: '#/components/schemas/rel' registered_at: $ref: '#/components/schemas/registered_at' idempotency_key: $ref: '#/components/schemas/idempotency_key' href: type: string format: uri description: URI to query a component related to the item. paymentCancelResponse: title: paymentCancelResponse type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' status: type: string example: CANCELED description: Transaction status canceled_at: type: string example: '2020-07-01T02:15:03.603Z' description: Cancellation date reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' custom_key: $ref: '#/components/schemas/custom_key' protocol: $ref: '#/components/schemas/protocol' x-examples: {} paymentCaptureResponse: title: paymentCaptureResponse type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' status: type: string example: CAPTURED description: Transaction status captured_at: type: string example: '2020-06-30T22:33:41.172' description: Capture date. reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' paymentPurchaseResponse: title: paymentPurchaseResponse type: object description: Credit and debit response dataset. x-examples: {} properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' status: type: string example: APPROVED description: Transaction Status enum: - APPROVED - AUTHORIZED - DENIED payment_method: type: string example: CREDIT description: Payment Method enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION received_at: $ref: '#/components/schemas/received_at' transaction_id: $ref: '#/components/schemas/transaction_id' original_transaction_id: type: string example: '6534812321501821' description: Original transaction identifier authorized_at: $ref: '#/components/schemas/authorized_at' reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' acquirer: $ref: '#/components/schemas/acquirer' soft_descriptor: $ref: '#/components/schemas/soft_descriptor' brand: $ref: '#/components/schemas/brand' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' eci: $ref: '#/components/schemas/eci' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' cancelResult: title: cancelResult type: object properties: payment_id: $ref: '#/components/schemas/payment_id' protocol: $ref: '#/components/schemas/protocol' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' currency: $ref: '#/components/schemas/currency' amount: $ref: '#/components/schemas/amount' status_processing_cancel_code: type: string description: Cancellation request status code. status_processing_cancel_message: type: string description: Cancellation request status message. protocol3DS: title: protocol type: string example: '202006302344230001' description: Cancellation Protocol registered_at: title: registered_at type: string format: date-time example: '2011-10-05T14:48:00.000Z' description: Registration date and time. rel: title: rel type: string example: AUTHORIZATION enum: - AUTHORIZATION - CANCEL - CAPTURE - PURCHASE description: Relationship of item to payment. notFound: title: notFound type: object properties: message: type: string example: Not Found description: Error message name: type: string example: GatewayTokenizationServiceError description: Module or service that returned the error status_code: type: number example: 404 description: HTTP Status Code details: type: array description: Error details items: type: object properties: status: type: string example: DENIED description: Status error_code: type: string example: TOKENIZATION-404 description: Error code payment_id: title: payment_id type: string description: Payment identifier example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 format: uuid minLength: 36 maxLength: 36 description: type: string example: Not Found description: Short description of the error description_detail: type: string description: Detailed description of the error example: 'Not found number_token, verify or renew your number_token or seller_id.' badRequest: title: badRequest type: object properties: message: type: string example: Bad Request description: Error Message name: type: string example: GatewayPaymentServiceError description: Module or service that returned the error status_code: type: number example: 400 description: HTTP Status Code details: type: array description: Error details items: type: object properties: status: type: string example: DENIED description: Status error_code: type: string example: GENERIC-400 description: Error code payment_id: title: payment_id type: string description: Payment identifier example: 2c341d28-491b-4cf8-aec7-eeb60136b7a5 format: uuid minLength: 36 maxLength: 36 description: type: string example: payment_method is invalid description: Short description of the error description_detail: type: string example: The payment_method attribute is required. Please check your request and try again description: Detailed error description internalServerError: title: internalServerError type: object properties: message: type: string example: Internal Server Error description: Error message name: type: string example: GatewayRouterHTTPServicesError description: Module or service that returned the error status_code: type: number example: 500 description: HTTP Status Code details: type: array description: Error details items: type: object properties: status: type: string example: ERROR description: Status error_code: type: string example: GENERIC-500 description: Error code description: type: string example: Internal Server Error description: Short description of the error description_detail: type: string description: Detailed description of the error example: The server encountered an unexpected error CreditCancel: type: object properties: canceled_at: type: string description: canceledAt. message: type: string description: message. description: credit_cancel. DefaultErrorHttpResponse: type: object properties: message: maxLength: 250 type: string description: Detailed error message. name: maxLength: 250 type: string description: Name of the module or system in which the error occurred. status_code: type: integer description: HTTP status code of the error. format: int32 details: type: array description: Error details. items: "$ref": "#/components/schemas/ErrorDetail" payments: type: array description: Error details. items: "$ref": "#/components/schemas/ErrorDetail" combined_id: type: string description: combinedId. order_id: type: string description: orderId. seller_id: type: string description: sellerId. ErrorDetail: type: object properties: status: type: string description: Error situation. error_code: type: string description: Error code. description: type: string description: Description of the error. description_detail: type: string description: Detailed description of the error. brand: type: string description: Brand. payment_id: type: string description: payment_id. seller_id: type: string description: seller_id. amount: type: string description: amount. currency: type: string description: currency. order_id: type: string description: order_id. credit_cancel: "$ref": "#/components/schemas/CreditCancel" payment_tag: type: string description: payment_tag. status_code: type: string description: statusCode. message: type: string description: message. name: type: string description: name. acquirer_transaction_id: type: string description: acquirer_transaction_id. authorization_code: type: string description: authorization_code. transaction_id: type: string description: transaction_id. reason_code: type: string description: reason_code. reason_message: type: string description: reason_message. merchant_advice_code: type: string description: merchant_advice_code. description: Detalhes do erro. OrderItemReleaseDTO: type: object properties: id: type: string amount: type: integer format: int32 ReleaseDTO: type: object properties: release_payment_date: type: string subseller_id: type: string order_item_release: "$ref": "#/components/schemas/OrderItemReleaseDTO" AddressDTO: type: object properties: street: type: string number: type: string complement: type: string district: type: string city: type: string state: type: string country: type: string postal_code: type: string CardDTO: type: object required: - expiration_month - expiration_year - cardholder_name properties: number: type: string description: Card number (send only when the field number_token is not sent). maxLength: 36 example: 4012001037141112 expiration_month: type: string description: Two-digit card expiry month. maxLength: 2 example: 09 expiration_year: type: string description: Two-digit card expiry year. maxLength: 2 example: 30 cardholder_name: type: string description: Buyer's name printed on the card.
Mandatory field for Antifraude maxLength: 26 example: Roland Deschain security_code: type: string description: Security code. CVV or CVC.
Mandatory field for Antifraude minLength: 3 maxLength: 4 example: 517 brand: type: string description: Card flag. Automatically populated by the API if not informed.
Mandatory field for Antifraude enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD maxLength: 50 example: Visa number_token: type: string description: Tokenized card number (send only when the number field is not sent). maxLength: 128 minLength: 128 example: e71084449bc70e344f77d4c382704ea2868b5e9775dced7ffcd40b3f66b167f51e352a2f289b518a11180c81478dfbdbeffd8a41f0b34564f2f0e41be8a88e11 description: Card data set. CustomerDTOSubs: type: object description: Buyer dataset. required: - seller_id - first_name - last_name - document_type - document_number properties: seller_id: "$ref": "#/components/schemas/seller_id" customer_id: "$ref": "#/components/schemas/customer_id" first_name: description: Buyer's first name. type: string maxLength: 40 example: John last_name: description: Buyer's last name. type: string maxLength: 80 example: da Silva document_type: description: Buyer's document type. type: string enum: - CPF - CNPJ - DNI_AR - CUIL - CUIT - RUT - CI_CL - MX_CURP - MX_RFC x-enumDescriptions: CPF: Cadastro de Pessoa Física (BR) CNPJ: Cadastro Nacional de Pessoa Jurídica (BR) DNI_AR: Documento Nacional de Identidad (AR) CUIL: Código Único de Identificación Laboral (AR) CUIT: Código Único de Identificación Tributaria (AR) RUT: Rol Único Tributário (CL) CI_CL: Cédula de Identidad (CL) MX_CURP: Clave Única de Registro de Población (MX) MX_RFC: Registro Federal de Contribuyentes (MX) example: CPF document_number: description: Buyer's document number. (without mask) type: string minLength: 11 maxLength: 15 example: '12345678912' birth_date: description: Buyer's date of birth. type: string format: YYYY-MM-DD example: '1976-02-21' minLength: 10 maxLength: 10 phone_number: description: Buyer's phone number. (without mask) type: string maxLength: 15 example: '5551999887766' cellphone_number: description: Buyer's cell phone number. (without mask) type: string example: '5551999887766' maxLength: 15 email: description: Buyer's email. type: string format: email example: customer@email.com.br observation: description: Notes. type: string example: The customer is interested in plan x. address: $ref: '#/components/schemas/Address' CustomerDTO: description: Set of data referring to the buyer. properties: first_name: type: string description: Buyer's first name.
Required field for Antifraud maxLength: 40 example: John last_name: type: string description: Buyer's last name.
Required field for Anti-fraud maxLength: 80 example: da Silva name: maxLength: 40 type: string description: Buyer's full name. Required for ticket. example: João da Silva document_type: type: string description: Type of the buyer's identification document. Mandatory for boleto.
Mandatory field for Antifraud maxLength: 26 example: CPF enum: - CPF - CNPJ document_number: type: string description: Purchaser's document number without punctuation. (without mask)
Required field for Antifraud minLength: 11 maxLength: 15 example: '12345678912' email: type: string description: Buyer's email.
Required field for Antifraud format: email example: customer@email.com.br phone_number: type: string description: Buyer's phone. (without mask)
Required field for Antifraud maxLength: 15 example: '5551999887766' billing_address: "$ref": "#/components/schemas/Address" InternalDTO: type: object properties: parameters: type: object additionalProperties: type: object card_brand: type: string recurring: "$ref": "#/components/schemas/RecurringDTO" OrderDTO: required: - order_id type: object properties: order_id: maxLength: 36 type: string description: Purchase identification code used by the e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 sales_tax: type: number description: Tax value in percentage. example: 12 product_type: type: string description: Identifier of the type of product sold among the options example: service enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service description: Set of data for identifying the purchase InstallmentCuotesDTO: type: object required: - quote_id properties: quote_id: description: "Quote ID to be used in the query" example: "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" type: string schema: type: string description: Name of the installment plan offered by Getnet example: "plan_ahora" RecurringDTO: type: object properties: payments_identification: type: string sequence: type: string billing_period: type: string transaction_identifier: type: string SubMerchantDTO: type: object description: In order for Getnet to comply with the rules of the Flags and Arrangements, the Federal Laws and determinations of BACEN (Central Bank of Brazil) for the identification of the final entities (sub-commerces) that make the financial transactions, the Payment Facilitators must send the data of identification of its clients with each transaction sent to Getnet. required: - identification_code - document_type - document_number - address - city - state - postal_code properties: identification_code: type: string description: ID do Sub-trade. maxLength: 15 example: 9058345 document_type: type: string enum: - CPF - CNPJ description: Sub-trade document type example: CNPJ document_number: type: string description: CNPJ or CPF of the Sub-trade. minLength: 11 maxLength: 14 example: 77415914000148 address: type: string description: Sub-commerce address. (No commas allowed) example: Dark Tower, 207 city: type: string description: city of Sub-commerce example: city state: type: string description: State (UF) of Sub-commerce example: RS postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask) of Sub-commerce example: 90520000 TokenizationDTO: type: object required: - type - cryptogram properties: type: type: string description: tokenization type example: TAVV enum: - UCAF - TAVV cryptogram: type: string description: Value of the cryptogram generated by the TSP (Token Service Provider) example: "0006010865799300000620111679930000000000" eci: type: string description: ECI Indicator (Electronic Commerce Indicator) example: '00' requestor_id: type: string description: Indicates the identifier of the Token requester. example: 1234567 description: Type of cryptogram used by the TSP (Token Service Provider). Values can be - TAVV For Visa and ELO cards; - UCAF For Mastercard brand cards. ReceiverDTO: type: object properties: account_number: type: string account_type: type: string first_name: type: string middle_name: type: string last_name: type: string addr_street: type: string addr_city: type: string addr_state: type: string addr_country: type: string addr_postal_code: type: string nationality: type: string phone: type: string date_of_birth: type: string id_type: type: string id_num: type: string FundTransferDTO: type: object properties: pay_action: type: string receiver: "$ref": "#/components/schemas/ReceiverDTO" WalletCreditDTO: type: object description:

Fields for compliance with digital wallet rules of the SDWO arrangement - (Staged Digital Wallet Operator). The Model is about digital wallets (Wallets) that accredit merchants to accept their means of payment, similar to the Payment Facilitators model. As for settlement, amounts from payments through the Wallets are sent to the EC Wallet and, secondly, it transfers them to its final sub-trades. Today the model is structured for Visa, Mastercard and Elo. The transactions of a Scaled Digital Wallet (SDWO) basically have two models:

Cash-In: flagged transaction not linked to a purchase:
Topping up Wallet Funds using a Card. E.g.: top up wallet balance via card
Transfer to another person's balance using card

Purchase (also known as back-to-back):
Payment of printed QR Code / wallet owner using card. Ex.: QR Code of the digital wallet printed at the counter and paid by card
Online payment through the logged-in area of the wallet using a card

For Cash-in transactions, in addition to filling in the wallet subgroup tags, it is also necessary to send the dynamic_mcc and soft_descriptor fields present in the payment subgroups present in the “payments” tab of this documentation. For Back-to-Back transactions, in addition to filling in the wallet subgroup tags, dynamic_mcc, with the number that best describes the activity of the sub-merchant that carried out the transaction and soft_descriptor, it is also necessary to fill in the sub_merchant subgroup, informing the respective data of the sub-merchant that carried out the transaction.

For each type of use case, it is necessary to fill in some data available in the list below, in which it is possible to check their respective rules and obligations.

For the Elo brand, as of the October 2023 Release, it is no longer allowed to send cash-in transactions for cash and installment credit. Only cash-in transactions can be sent to Elo Cards in the Debit and Prepaid mode. In addition, it is now mandatory to send the CPF/CNPJ of the transfer recipient, soft descriptor with the addition of the name of the receiving account holder, as well as the sending of MCC 6051 for cash-in transactions. If sent incorrectly or cash-in for disallowed modalities or missing mandatory information, the transaction will be denied or rejected by the brand/issuer.

properties: type: type: string description: Wallet Type:

01: MasterPass Wallet
02: Visa Checkout
10: Generic Tokenized Wallet
55: Local Brazil Wallet (SDWO)

maxLength: 2 enum: - '01' - '02' - '10' - '55' example: '55' id: type: string description: Wallet Identification.

- MasterPass:
101 = Wallet Remote
102 = Wallet Remote NFC Payment
- Generic Tokenized Wallet
000 = Unspecified
101 = Wallet Remote
102 = Wallet Remote NFC Payment
103 = Apple Pay
216 = Android Pay
217 = Samsung Pay
327 = MDES for merchants (M4M)
example: '000' default: 'BRL' maxLength: 5 enum: - "000" - "101" - "102" - "103" - "216" - "217" - "327" merchant_id: type: string description: >- Identification number of the Digital Wallet registered with the flags.
Visa = MVV (Merchant Value Verification) with 6 positions
Mastercard = WID (Wallet ID) with 3 positions
Elo = WID (Wallet ID) with 11 positions
example: '327' maxLength: 12 fund_transfer: type: object description: Data for SDWO (Staged Digital Wallet Operator) array transactions properties: pay_action: type: string description: Financing Type.

FT Funding Transfer – Which must be marked in Funding transactions Cash-in SDWO for all flags.

FP Funding and Purchase – Which must be marked in transactions of Back-to-Back SDWO for all brands.

BP Billpay – Bill payment marking in the Visa CBPS program. enum: - FT - FP - BP example: 'FT' maxLength: 2 receiver: type: object description: 'Dados Receiver Account' properties: account_number: type: string description: >- Receiver Account Number which can be filled in with one of following values "#NA" or "9999999999999995". necessary the fulfillment only for the Mastercard brand, for Cash-in SDWO transactions, for other brands or padding is optional. example: '9999999999999995' maxLength: 20 account_type: type: string description: Account Type which must be filled with 00.

- 00 - Other (Default, currently the only allowed value)
- 01 — RTN + Bank Account
- 02 — IBAN
- 03 — Card Account (for getnet currently only available type)
- 04 — E-mail
- 05 — Phone Number
- 06 — Bank account number (BAN) + Code
Bank Identification (BIC)
- 07 — Wallet ID
- 08 — Social Network ID
Completion required only for the Mastercard brand for Cash-in SDWO transactions, for other brands, filling is optional enum: - "00" - "01" - "02" - "03" - "04" - "05" - "06" - "07" - "08" example: '00' maxLength: 2 first_name: type: string description: >- Receiver First Name which must be filled in with the first transfer recipient's name. Ex Jane. necessary the padding just for the Mastercard brand for transactions of Cash-in SDWO, for the others flags filling is optional example: 'Jane' maxLength: 35 middle_name: type: string description: >- Receiver Middle Name that must be filled in with the abbreviation the transfer recipient's middle name. Eg: T. Padding is optional for all flags. minLength: 1 maxLength: 1 example: 'T' last_name: type: string description: >- Receiver Last Name that must be filled in with last name (last name) of the transfer recipient. For example: Smith. Completion only for the Mastercard brand for Cash-in SDWO transactions, for other brands filling is optional example: 'Smith' maxLength: 35 addr_street: type: string description: >- Receiver Addr Street which must be filled in with the address of the recipient of the transfer (street and number). Eg: 1 Main ST. Padding is optional for all flags. example: 1 Main ST maxLength: 50 addr_city: type: string description: >- Receiver Addr City which must be filled in with the city of recipient of the transfer. For example: SAO PAULO. Filling it is optional for all flags. example: SAO PAULO maxLength: 25 addr_state: type: string description: >- Receiver Addr State that must be filled in with the state of the recipient of the transfer. Eg: SP. the filling is optional for all flags. example: SP maxLength: 3 addr_country: type: string description: >- Receiver Addr Country which must be filled in with the country of recipient of the transfer. Following the ISO 3166-1 alpha 3 standard. fulfillment only for the Mastercard brand for Cash-in SDWO transactions, for other brands or padding is optional example: BRA maxLength: 3 addr_postal_code: type: string description: >- Receiver Addr Postal Code that must be filled in with the postal code (ZIP code) of the recipient of the transfer. Ex: 01408000. Filling is optional for all flags. example: '1408000' maxLength: 10 nationality: type: string description: >- Receiver Nationality which must be filled in with the transfer recipient's nationality. Following the ISO 3166-1 alpha 3 standard. padding is optional for all flags. example: BRA maxLength: 3 phone: type: string description: >- Receiver Phone which must be filled in with the number of Transfer recipient's phone number, including code from the country. Ex: 5511977778888. Completion is optional for all flags. example: '5511977778888' maxLength: 20 date_of_birth: type: string description: >- Receiver Date Of Birth which must be filled in with the date of birth of recipient of the transfer with the YYYYMMDD format. Ex 19901230. Filling is optional for all flags. example: '19901230' maxLength: 8 id_type: type: string description: >- Receiver Id Type that must be filled in with the type of document used by the recipient of the transfer (CPF or CNPJ). In this case, fill in 03. The filling out for Mastercard, Visa and Elo brands to Cash-in SDWO transactions, for other brands the filling in is optional.
- 00 = Passport
- 01 = National Identification Card
- 02 = Driver's License
- 03 = Issued by the Government
- 04 = Other
enum: - '00' - '01' - '02' - '03' - '04' example: '03' maxLength: 2 id_num: type: string description: >- Receiver Id Number that must be filled in with the CPF number or CNPJ of the transfer recipient. Ex 12345678900000. Completion required for Mastercard, Visa and Elo brands for Cash-in SDWO transactions, for other brands the filling is optional. example: '12345678900000' maxLength: 25 CreditResponseDTO: type: object properties: delayed: type: boolean authorization_code: type: string authorized_at: type: string reason_code: type: string reason_message: type: string acquirer: type: string soft_descriptor: type: string brand: type: string terminal_nsu: type: string acquirer_transaction_id: type: string transaction_id: type: string first_installment_amount: type: string other_installment_amount: type: string total_installment_amount: type: string DetailsResponseDTO: type: object properties: status: type: string description: type: string brand: type: string error_code: type: string description_detail: type: string payment_id: type: string authorization_code: type: string terminal_nsu: type: string acquirer_transaction_id: type: string PaymentResponseDTO: type: object properties: seller_id: type: string amount: type: integer format: int32 currency: type: string order_id: type: string status: type: string received_at: type: string message: type: string name: type: string payment_id: type: string status_code: type: integer format: int32 credit: "$ref": "#/components/schemas/CreditResponseDTO" debit: "$ref": "#/components/schemas/CreditResponseDTO" details: type: array items: "$ref": "#/components/schemas/DetailsResponseDTO" BoletoDTO: description: Data for generating the billet type: object properties: our_number: maxLength: 12 minLength: 12 type: string description: Named by banks as "Our Number". is the identification billet only in the billing system and does not have a mask. It's composed by rules that vary depending on the bank and collection service. Per For example, in the case of Santander there are two ways of numbering: 1) If the customer informs the number, the customer is in charge of informing the dv (check digit); 2) If the customer omits the number, the Bank is in charge of generating a sequel, without a DV. example: '1946598.0' document_number: maxLength: 15 minLength: 15 type: string description: Your Number. Number controlled by the customer, it is usually managed by the system that is generating the ticket. (without mask) example: '170500000019763' expiration_date: type: string description: Ticket expiration date. If not informed, it will be considered the pre-registered standard number of days for expiration. format: mm/dd/yyyy example: 11/16/2030 instructions: maxLength: 1000 type: string description: Instructions to be printed on the ticket. The line break can be performed in two ways. 1) Automatic line wrapping: it will be A line break is made in up to 100 characters without the words being truncated; 2) Manual line break: line break using the "
" escape character. Example: "This is a break test line.
The second line will be printed now.
And finally, the third line."; example: Do not receive after expiration provider: maxLength: 40 type: string description: Provider bank. example: santander default: santander enum: - santander guarantor_name: type: string description: Name of the guarantor. example: Ze small default: Ze small guarantor_document_type: type: string description: Type of document of the guarantor. example: CPF guarantor_document_number: type: string description: Number of the guarantor's document. example: '78009200021' default: '78009200021' CaptureDTO: type: object properties: idempotency_key: "$ref": "#/components/schemas/idempotency_key" request_id: "$ref": "#/components/schemas/request_id" payment_id: "$ref": "#/components/schemas/payment_id" additional_data: type: object description: Additional authorization data. Required field for payment split. required: - billing_address - shippings - customer properties: split: "$ref": "#/components/schemas/split_data" device: "$ref": "#/components/schemas/DeviceDTO" customer: "$ref": "#/components/schemas/CustomerDTOAddData" order: "$ref": "#/components/schemas/OrderDTO" amount: $ref: '#/components/schemas/amount' payment_method: $ref: '#/components/schemas/payment_method' data: "$ref": "#/components/schemas/DataDTO" DataDTO: type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Purchase amount in cents example: 118708 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html").
Mandatory field for Antifraud example: "BRL" enum: - BRL customer_id: type: string description: Buyer identifier. Information defined by the application that consumes the Digital Platform api.
Mandatory field for Antifraud example: test payment: "$ref": "#/components/schemas/PaymentDataDTO" sub_merchant: "$ref": "#/components/schemas/SubMerchantDTO" additional_data: type: object description: Additional authorization data. Required field for payment split. required: - billing_address - shippings - customer properties: split: "$ref": "#/components/schemas/split_data" device: "$ref": "#/components/schemas/DeviceDTO" customer: "$ref": "#/components/schemas/CustomerDTOAddData" order: "$ref": "#/components/schemas/OrderDTO" installment: "$ref": "#/components/schemas/InstallmentCuotesDTO" airline: "$ref": "#/components/schemas/Airlines" is_pre_paid: type: boolean network_token: type: string description: Card token that will be used to generate the cryptogram. example: 1b110aaa71934ae492bff48baab9af81 DataAdjustmentDTO: type: object required: - amount - payment properties: amount: type: integer format: int32 description: Purchase amount in cents example: 118708 payment: "$ref": "#/components/schemas/PaymentDataAdjustmentDTO" additional_data: type: object description: Additional authorization data. Required field for payment split. properties: installment: "$ref": "#/components/schemas/InstallmentCuotesDTO" DataBoletoDTO: type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Purchase amount in cents example: 118708 currency: type: string description: Currency identification (See code at "https://www.currency-iso.org/en/home/tables/table-a1.html").
Mandatory field for Antifraud example: "BRL" enum: - BRL - USD - MXN - CLP - ARS customer_id: type: string description: Buyer identifier. Information defined by the application that consumes the Digital Platform api.
Mandatory field for Antifraud example: test payment: "$ref": "#/components/schemas/PaymentBoletoDataDTO" boleto: "$ref": "#/components/schemas/BoletoDataDTO" customer: "$ref": "#/components/schemas/CustomerDTO" order: "$ref": "#/components/schemas/OrderDTO" additional_data: type: object description: Additional authorization data. Required field for payment split. required: - billing_address - shippings - customer properties: split: "$ref": "#/components/schemas/split_data" device: "$ref": "#/components/schemas/DeviceDTO" customer: "$ref": "#/components/schemas/CustomerDTOAddData" order: "$ref": "#/components/schemas/OrderDTO" installment: "$ref": "#/components/schemas/InstallmentCuotesDTO" is_pre_paid: type: boolean network_token: type: string description: Card token that will be used to generate the cryptogram. example: 1b110aaa71934ae492bff48baab9af81 PaymentDataDTO: type: object description: Dataset containing order items. required: - payment_id - payment_method - transaction_type - number_installments - card properties: payment_id: type: string description: Payment identification code. maxLength: 36 example: 173f9e8d-4e0b-4503-8016-5cdafba89bee payment_method: type: string description: Transaction type. example: CREDIT enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION save_card_data: type: boolean description: Identifies whether the card should be saved for future purchases. example: false transaction_type: type: string description: 'Transaction type. Payment in full, in installments without interest, paid in installments with interest.' example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: integer description: Number of installments for an installment credit transaction. example: 1 soft_descriptor: type: string maxLength: 22 description:

Text displayed on the buyer's card invoice, this field is optional, if nothing is informed, the trade name registered for the establishment will be considered. Only alphanumeric data and the following special characters: % $ , . / & ( ) + = < > - * Spaces will be replaced by the character ''*'' The transaction will not be denied if non-allowed characters are sent. Any information that exceeds the maximum size will be disregarded.

Mandatory for Payment and SDWO facilitators. In addition to the above, the following additional rules of the Flags must be followed:

Identification of the Payment Facilitator, with 3, 7 or 12 characters
Separator characters "*" (asterisk)
Sub-trade identification
Example 1: FAC*SUCOMERCIO
Example 2: FACILIT*SUBCOMERCIO
Example 3: FACILITADOR1*SUBCOMERC
Example 4: for SDWO back-to-back: Carteira*Subcomercio
Exemple 5: for SDWO cash-in just fill in the wallet name: Digital Wallet

example: LOJA*TESTE*COMPRA-123 dynamic_mcc: type: number maxLength: 4 minLength: 4 description: Field used to signal the transaction with another Merchant Category Code (Merchant Category Code) different from the registered one. If an invalid MCC is sent, the default will be used. Send numeric data only.

Mandatory for Payment Facilitators and SDWO.

For SDWO cash-in transactions, use MCC 6051 for Visa, Mastercard and Elo brands. example: 1799 card: "$ref": "#/components/schemas/CardDTO" tokenization: "$ref": "#/components/schemas/TokenizationDTO" wallet: "$ref": "#/components/schemas/WalletCreditDTO" xid: type: string description: Field available from version 2.0 onwards. MPI identifier for each authenticated transaction. The field content can be a HEXA or Base64 value, according to the MPI used. maxLength: 40 example: test ucaf: type: string description: Field available from version 2.0 onwards. Authentication code encrypted by the Flag. The field content can be a HEXA or Base64 value, according to the MPI used. maxLength: 40 example: string eci: type: string description: Field available from version 2.0 onwards. ECI code of the 3D Secure Authenticated transaction. Generated by an External MPI. maxLength: 2 example: "00" tdsdsxid: type: string description: 3DS server version 2 transaction identifier. example: string tdsver: type: string description: Indicates the 3DS version used in authentication, example: 2.1.0 PaymentDataAdjustmentDTO: type: object description: Dataset containing order items. required: - payment_id - payment_method properties: payment_id: type: string description: Payment identification code. maxLength: 36 example: 173f9e8d-4e0b-4503-8016-5cdafba89bee payment_method: type: string description: Transaction type. example: CREDIT_PRE_AUTHORIZATION enum: - CREDIT_PRE_AUTHORIZATION PaymentBoletoDataDTO: type: object description: Dataset containing order items. required: - payment_id - payment_method - transaction_type - number_installments - card properties: payment_id: type: string description: Payment identification code. maxLength: 36 example: 173f9e8d-4e0b-4503-8016-5cdafba89bee payment_method: type: string description: Transaction type. example: BOLETO enum: - BOLETO BoletoDataDTO: description: Data for generating the bill type: object properties: our_number: maxLength: 12 minLength: 12 type: string description: Referred to by banks as "Our Number". It is the unique identification of the bill in the billing system and does not have a mask. It consists of rules that vary depending on the bank and the billing service. For example, in the case of Santander there are two ways to numerar: 1) If the customer informs the number, the customer is responsible for informing the dv (verification digit); 2) If the customer omits the number, the Bank is responsible for generating a sequence number, without a DV. example: '1946598.0' document_number: maxLength: 15 minLength: 15 type: string description: Your Number. Number controlled by the customer, usually managed by the system that is generating the bill. (no mask) example: '170500000019763' expiration_date: type: string description: Due date of the bill. If not provided, the default number of days pre-registered for the due date will be considered. format: dd/mm/yyyy example: 16/11/2030 instructions: maxLength: 1000 type: string description: Instructions to be printed on the bill. Line breaks can be done in two ways. 1) Automatic line break: a line break will be made up to 100 characters without the words being truncated; 2) Manual line break: a line break using the escape character "
". Example: "This is a line break test.
The second line will now be printed.
And finally, the third line."; example: Not receiving after due date provider: maxLength: 40 type: string description: Provider bank. example: santander default: santander enum: - santander guarantor_name: type: string description: Guarantor's name. example: João da Silva default: João da Silva guarantor_document_type: type: string description: Guarantor document type. example: CPF guarantor_document_number: type: string description: Guarantor document number. example: '78009200021' default: '78009200021' CancelRequestDTO: type: object properties: marketplace_subseller_payments: type: array items: "$ref": "#/components/schemas/MarketplaceSubsellerPayment" payment_id: type: string amount: type: integer format: int32 cancel_amount: type: integer format: int32 combined_id: type: string is_combined: type: boolean internal: "$ref": "#/components/schemas/InternalDTO" cancel_custom_key: type: string MarketplaceSubsellerPayment: type: object properties: subseller_sales_amount: type: integer format: int32 subseller_id: type: string order_items: type: array items: "$ref": "#/components/schemas/OrderItem" OrderItem: type: object properties: amount: type: integer format: int32 currency: type: string id: type: string description: type: string tax_percent: type: number format: double tax_amount: type: integer format: int32 CancelDTO: type: object required: - idempotency_key - payment_id - payment_method properties: idempotency_key: "$ref": "#/components/schemas/idempotency_key" request_id: "$ref": "#/components/schemas/request_id" payment_id: "$ref": "#/components/schemas/payment_id" additional_data: type: object description: Additional cancellation data.
Required field for Payment Split. properties: split: "$ref": "#/components/schemas/split_data" amount: type: integer format: int32 description: Value (less than or equal) of the purchase in cents. Partial cancellation (of lower value) is allowed only from the day following the transaction (D+N) example: 118708 payment_method: "$ref": "#/components/schemas/payment_method" custom_key: "$ref": "#/components/schemas/custom_key" CaptureResponseDTO: type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' status: type: string reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' captured_at: type: string CancelResponseDTO: type: object properties: idempotency_key: "$ref": "#/components/schemas/idempotency_key" seller_id: "$ref": "#/components/schemas/seller_id" request_id: "$ref": "#/components/schemas/request_id" payment_id: "$ref": "#/components/schemas/payment_id" order_id: "$ref": "#/components/schemas/order_id" amount: "$ref": "#/components/schemas/amount" currency: "$ref": "#/components/schemas/currency" status: type: string reason_code: "$ref": "#/components/schemas/reason_code" reason_message: "$ref": "#/components/schemas/reason_message" canceled_at: type: string example: '2020-07-01T02:15:03.603Z' description: Cancellation date custom_key: "$ref": "#/components/schemas/custom_key" PaymentDTO: type: object properties: idempotency_key: "$ref": "#/components/schemas/idempotency_key" request_id: "$ref": "#/components/schemas/request_id" order_id: "$ref": "#/components/schemas/order_id" data: "$ref": "#/components/schemas/DataDTO" description: Data to carry out an authorization. AdjustmentDTO: type: object properties: idempotency_key: "$ref": "#/components/schemas/idempotency_key" request_id: "$ref": "#/components/schemas/request_id" data: "$ref": "#/components/schemas/DataAdjustmentDTO" PaymentBoletoDTO: type: object required: - idempotency_key - request_id properties: idempotency_key: "$ref": "#/components/schemas/idempotency_key" request_id: "$ref": "#/components/schemas/request_id" order_id: "$ref": "#/components/schemas/order_id" data: "$ref": "#/components/schemas/DataBoletoDTO" description: Data to carry out an authorization. AutorizationResponseDTO: type: object properties: idempotency_key: type: string seller_id: type: string request_id: type: string payment_id: type: string order_id: type: string amount: type: string currency: type: string status: type: string payment_method: type: string received_at: type: string transaction_id: type: string original_transaction_id: type: string authorized_at: type: string reason_code: type: string reason_message: type: string acquirer: type: string soft_descriptor: type: string brand: type: string authorization_code: type: string acquirer_transaction_id: type: string eci: type: string payment_received_timestamp: type: string card_id: type: string boleto: "$ref": "#/components/schemas/BoletoResponseDTO" merchant_advice_code: type: string additional_data: type: object additionalProperties: type: object BolepixDTO: type: object properties: cod_qrcode: type: string cod_url_qrcode: type: string BoletoResponseDTO: type: object properties: boleto_id: type: string bank: type: string status_code: type: string status_label: type: string typeful_line: type: string bar_code: type: string issue_date: type: string expiration_date: type: string our_number: type: string document_number: type: string pix: "$ref": "#/components/schemas/BolepixDTO" _links: type: array items: "$ref": "#/components/schemas/LinkBoletoDTO" LinkBoletoDTO: type: object properties: href: type: string rel: type: string type: type: string InstallmentQuotesRequestDTO: type: object properties: amount: "$ref": "#/components/schemas/amount" bin: type: string description: First six numbers of the card. minLength: 6 maxLength: 9 example: '123412' number_token: maxLength: 128 type: string description: Token of the card that will be used in transactions. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c IncreaseRateDTO: type: object properties: value: type: integer format: int32 rate: type: number format: double InstallmentQuotesResponseDTO: type: object properties: amount: type: integer format: int32 options: type: array items: "$ref": "#/components/schemas/OptionResponseDTO" InterestRateDTO: type: object properties: type: type: string value: type: integer format: int32 rate: type: number format: double InterestTaxRateDTO: type: object properties: type: type: string value: type: integer format: int32 rate: type: number format: double OptionResponseDTO: type: object required: - quote_id properties: quote_id: "$ref": "#/components/schemas/quote_id" schema: type: string type: type: string number: type: integer format: int32 installment_amount: type: integer format: int32 total_amount: type: integer format: int32 increase_rate: "$ref": "#/components/schemas/IncreaseRateDTO" interest_rate: "$ref": "#/components/schemas/InterestRateDTO" interest_tax_rate: "$ref": "#/components/schemas/InterestTaxRateDTO" promo_id: type: string Data: type: object properties: additional_data: type: object additionalProperties: type: object ConfirmRequestDTO: type: object properties: marketplace_subseller_payments: type: array items: "$ref": "#/components/schemas/MarketplaceSubsellerPayment" amount: type: integer format: int32 internal: "$ref": "#/components/schemas/InternalDTO" ConfirmResponseDTO: type: object properties: seller_id: type: string amount: type: integer format: int32 currency: type: string order_id: type: string status: type: string payment_id: type: string credit_confirm: "$ref": "#/components/schemas/CreditConfirmDTO" CreditConfirmDTO: type: object properties: confirm_date: type: string message: type: string ValidateCustomerDTO: type: object properties: first_name: type: string last_name: type: string document_number: type: string type: type: string CancelCustomKeyResponseDTO: type: object properties: seller_id: type: string payment_id: type: string cancel_request_at: type: string cancel_request_id: type: string cancel_custom_key: type: string terminal_nsu: type: string acquirer_transaction_id: type: string transaction_date: type: string currency: type: string transaction_type: type: string number_installments: type: integer format: int32 amount: type: integer format: int32 cancel_amount: type: integer format: int32 status_processing_cancel_code: type: string status_processing_cancel_message: type: string TokensCardRequest: required: - card_number type: object properties: card_number: maxLength: 19 minLength: 13 type: string description: Card Number. example: '5155901222280001' customer_id: maxLength: 100 type: string description: Buyer identifier. Application-defined information that consumes the Digital Platform API. example: customer_21081826 TokensCardResponse: required: - number_token type: object properties: number_token: maxLength: 128 type: string description: Token of the card that will be used in transactions. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c CardDataResponse: type: object properties: card_id: maxLength: 36 type: string description: Card identifier saved in the safe, can be used to retrieve a valid number_token for future purchases, as well as can be used to remove saved cards. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 last_four_digits: maxLength: 4 type: string description: Last four digits of the card. example: '1212' bin: maxLength: 4 type: string description: First six digits of the card. example: '121212' expiration_month: maxLength: 2 type: integer description: Two-digit card expiration month. format: int32 example: 12 expiration_year: maxLength: 2 type: integer description: Two-digit card expiration year. format: int32 example: 28 brand: maxLength: 50 type: string description: Card banner. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: maxLength: 26 type: string description: Buyer's name printed on the card. example: JOAO DA SILVA customer_id: maxLength: 100 type: string description: Buyer identifier. example: customer_21081826 number_token: maxLength: 128 type: string description: Card token that will be used in transactions. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c used_at: maxLength: 24 type: string description: Date of last use. example: '2017-04-19T16:30:30Z' created_at: maxLength: 24 type: string description: Creation date. example: '2017-04-19T16:30:30Z' updated_at: maxLength: 24 type: string description: Update date. example: '2017-04-19T16:30:30Z' status: maxLength: 20 type: string description: Card status in the safe. example: active enum: - active - blocked - canceled - renewed transaction_id: maxLength: 32 type: string description: Card Verification Transaction ID example: '123456' ListCardDataResponse: type: object properties: cards: type: array items: "$ref": "#/components/schemas/CardDataResponse" SaveCardDataRequest: required: - customer_id - expiration_month - expiration_year - number_token type: object properties: number_token: maxLength: 2147483647 minLength: 10 type: string description: Tokenized card number. Generated via the /v1/tokens/card endpoint. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c brand: maxLength: 50 type: string description: Card Brand. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: maxLength: 26 minLength: 0 type: string description: Buyer's name printed on the card. example: JOAO DA SILVA expiration_month: maxLength: 2 minLength: 2 pattern: 0[1-9]|1[0-2] type: string description: Two-digit card expiration month. example: '12' expiration_year: maxLength: 2 minLength: 2 type: string description: Two-digit card expiration year. example: '28' customer_id: maxLength: 100 minLength: 0 type: string description: Buyer identifier. example: customer_21081826 cardholder_identification: type: string description: Identification of the buyer, such as CPF or ID. (without mask). example: '12345678912' verify_card: type: boolean description: Performs a transaction that verifies that the card entered does not is cancelled, blocked or restricted. example: false enum: - true - false security_code: maxLength: 4 minLength: 3 type: string description: Security code. CVV or CVC. example: '123' transaction_id: type: string description: Number of the card's first transaction. example: '3123131241412' SaveCardDataResponse: type: object properties: card_id: maxLength: 36 type: string description: Card identifier saved in the safe, can be used to retrieve a valid number_token for future purchases, as well as can be used to remove saved cards. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 number_token: maxLength: 128 type: string description: Card token that will be used in transactions. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c VerificationCardRequest: required: - expiration_month - expiration_year - number_token type: object properties: number_token: maxLength: 2147483647 minLength: 10 type: string description: Tokenized card number. Generated via the /v1/tokens/card endpoint. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c brand: maxLength: 50 type: string description: Card Brand. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: maxLength: 26 type: string description: Buyer's name printed on the card. example: JOAO DA SILVA expiration_month: maxLength: 2 minLength: 2 pattern: 0[1-9]|1[0-2] type: string description: Two-digit card expiration month. example: '12' expiration_year: maxLength: 2 minLength: 2 type: string description: Two-digit card expiration year. example: '28' security_code: maxLength: 4 minLength: 3 type: string description: Security code. CVV or CVC. example: '123' VerificationCardResponse: type: object properties: status: maxLength: 20 type: string description: Card verification status, where VERIFIED is the call sign that the card has been validated successfully. example: VERIFIED enum: - '"VERIFIED","NOT VERIFIED","DENIED","ERROR"' verification_id: maxLength: 36 type: string description: Identification of the verification request on the digital platform. example: ae267804-503c-4163-b1b1-f5da5120b74e authorization_code: maxLength: 18 type: string description: Authorization number generated by the verification system card. example: '6964722471672911' transaction_id: maxLength: 20 type: string description: Transaction number generated by the card verification system. example: '1002217281190421' CustomerResponse: type: object properties: customer_id: maxLength: 100 minLength: 0 type: string first_name: maxLength: 40 minLength: 0 type: string last_name: maxLength: 80 minLength: 0 type: string document_type: type: string enum: - CPF - CNPJ - PASSPORT_BR - DNI_AR - CUIL - CUIT - PASSPORT_AR - RUT - CI_CL document_type_name: type: string document_number: maxLength: 30 minLength: 3 pattern: "(^$|.{3,30})" type: string document_country: type: string phone_number: type: string celphone_number: type: string email: type: string status: type: string enum: - active - inactive ListCustomersResponse: required: - limit - page - total type: object properties: customers: type: array items: "$ref": "#/components/schemas/CustomerResponse" page: type: integer format: int32 limit: type: integer format: int32 total: type: integer format: int32 Address: description: Set of data referring to the buyer's address properties: street: type: string description: Backyard. maxLength: 60 example: Av. Brazil number: type: string description: Street number. maxLength: 10 example: '1000' complement: type: string description: Address complement. maxLength: 60 example: Sala 1 district: type: string description: Neighborhood. maxLength: 40 example: Sao Geraldo city: type: string description: City. maxLength: 40 example: Porto Alegre state: type: string description: State (UF). maxLength: 20 example: RS country: type: string description: Country. maxLength: 20 example: Brazil postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask) maxLength: 8 example: '90230060' FloatingDataPlan: required: - amount - installment type: object properties: installment: minimum: 1 type: integer format: int32 amount: minimum: 0 type: integer format: int32 Period: required: - billing_cycle - type type: object properties: type: maxLength: 15 type: string description: Type of periodicity. example: monthly enum: - yearly - monthly - bimonthly - quarterly - semesterly - specific billing_cycle: maximum: 9999 minimum: 0 type: integer description: "Plan duration based on frequency type. For example,\ \ for a 12-month plan, where billing will be done monthly\ \ (type = monthly) the value to be assigned is 12." example: 12 specific_cycle_in_days: maximum: 30 minimum: 1 type: number description: "Specific billing cycle in days. When the type of periodicity\ \ is specific (type = specific) the number of days must be assigned\ \ in which the billing cycle will be carried out. For example, if the duration\ the one in the plan is 12 (billing_cycle = 12) e o ciclo específico for 10 (specific_cycle_in_days\ \ = 10), This means that the charge will occur every 10 days in total\ \ of 12 charges." description: Plan period. PlanRequest: required: - seller_id - amount - currency - name - payment_types - period type: object properties: seller_id: "$ref": "#/components/schemas/seller_id" name: description: Plan name. type: string example: flex plan description: description: Plan description. type: string example: flex plan amount: "$ref": "#/components/schemas/amount" currency: "$ref": "#/components/schemas/currency" sales_tax: description: Tax amount. type: integer default: 0 product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service payment_types: type: array items: type: string enum: - credit_card - debit_card period: "$ref": "#/components/schemas/Period" floating_data: maxItems: 2147483647 minItems: 1 type: array items: "$ref": "#/components/schemas/FloatingDataPlan" description: Request containing data to register a new plan. Plan: required: - amount - currency - name - payment_types - period - seller_id type: object properties: seller_id: type: string format: uuid plan_id: type: string format: uuid name: type: string description: type: string amount: type: integer format: int32 currency: maxLength: 3 minLength: 0 type: string sales_tax: type: integer format: int32 product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service payment_types: type: array items: type: string enum: - credit_card - debit_card status: type: string enum: - active - inactive create_date: type: string format: date-time period: "$ref": "#/components/schemas/Period" floating_data: maxItems: 2147483647 minItems: 1 type: array items: "$ref": "#/components/schemas/FloatingDataPlan" PlanData: required: - amount - currency - description - from - name - payment_types - period - plan_id - seller_id - to type: object properties: from: type: string format: uuid to: type: string format: uuid subscriptions: maxItems: 2147483647 minItems: 1 type: array items: type: string format: uuid id: type: string plan_id: type: string amount: type: integer format: int32 create_date: type: string currency: maxLength: 3 minLength: 0 type: string description: type: string name: type: string payment_types: type: array items: type: string enum: - credit_card - debit_card period: "$ref": "#/components/schemas/Period" product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service sales_tax: type: integer format: int32 seller_id: type: string status: type: string enum: - active - inactive floating_data: type: array items: "$ref": "#/components/schemas/FloatingDataPlan" tenant_data: "$ref": "#/components/schemas/TenantData" TenantData: type: object properties: country: type: string tenant: type: string PlanDataWrapper: type: object properties: limit: type: integer format: int32 page: type: integer format: int32 plans: type: array items: "$ref": "#/components/schemas/PlanData" total: type: integer format: int64 UpdatePlan: required: - amount - currency - name - payment_types - period - status type: object properties: name: description: Plan name. type: string example: flex plan description: description: Plan description. type: string example: flex plan amount: "$ref": "#/components/schemas/amount" currency: "$ref": "#/components/schemas/currency" payment_types: type: array items: type: string enum: - credit_card - debit_card sales_tax: description: Tax amount. type: integer default: 0 product_type: description: Identifier of the type of product sold among the options. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service period: "$ref": "#/components/schemas/Period" status: type: string enum: - active - inactive floating_data: maxItems: 2147483647 minItems: 1 type: array items: "$ref": "#/components/schemas/FloatingDataPlan" description: Plan details to be changed. PlanPartialUpdateRequest: required: - description - name type: object properties: name: description: Plan name. type: string example: flex plan description: description: Plan description. type: string example: flex plan amount: "$ref": "#/components/schemas/amount" floating_data: maxItems: 2147483647 minItems: 1 type: array items: "$ref": "#/components/schemas/FloatingDataPlan" description: Dataset of the plan to be updated. SubscriptionPlanMigration: required: - from - to type: object properties: from: type: string format: uuid description: Identifier of the original plan, that is, the original plan_id of the Subscription. to: type: string format: uuid description: Identifier of the target plan, that is, the plan_id to which you want to migrate the Subscription. subscriptions: maxItems: 2147483647 minItems: 1 type: array description: List of Subscription identifiers that will be migrated to the destination Plan (to field). If this list is not informed, then the service will migrate all Subscriptions from the source Plan (from field) to the destination Plan (to field). items: type: string format: uuid description: Dataset for requesting a plan change. FilteredResponse: required: - limit - page - total type: object properties: subscriptions: type: array items: "$ref": "#/components/schemas/SubscriptionResponse" page: type: integer format: int32 limit: type: integer format: int32 total: type: integer format: int32 SubscriptionResponse: required: - create_date - order_id - payment_date - seller_id - status type: object properties: seller_id: type: string format: uuid order_id: maxLength: 36 minLength: 0 type: string installment_start_date: type: string format: date create_date: type: string format: date-time end_date: type: string format: date-time payment_date: maximum: 31 minimum: 1 type: integer format: int32 next_scheduled_date: type: string format: date-time subscription: "$ref": "#/components/schemas/SubscriptionDetailResponse" customer: "$ref": "#/components/schemas/CustomerResponse" plan: "$ref": "#/components/schemas/PlanResponse" device: "$ref": "#/components/schemas/Device" floating_data: type: array items: "$ref": "#/components/schemas/FloatingData" status: type: string enum: - processing - success - expired - canceled - delayed - failed - suspended - created status_details: maxLength: 500 minLength: 0 type: string payment: "$ref": "#/components/schemas/PaymentResponse" Device: type: object properties: ip_address: type: string device_id: type: string SubscriptionDetailResponse: required: - subscription_id type: object properties: subscription_id: type: string format: uuid payment_type: "$ref": "#/components/schemas/PaymentTypeResponse" shippings: type: array items: "$ref": "#/components/schemas/Shipping" PaymentResponse: type: object properties: seller_id: type: string format: uuid order_id: type: string payment_id: type: string format: uuid amount: type: integer format: int32 currency: type: string status: type: string enum: - pending - canceled - approved - denied - authorized - confirmed - expired - unprocessed payment_received_timestamp: type: string format: date-time credit: "$ref": "#/components/schemas/PaymentDataResponse" debit: "$ref": "#/components/schemas/PaymentDataResponse" error: "$ref": "#/components/schemas/PaymentError" PaymentTypeResponse: type: object properties: credit: "$ref": "#/components/schemas/CreditResponse" debit: "$ref": "#/components/schemas/PaymentResponse" PlanResponse: type: object properties: seller_id: maxLength: 36 minLength: 36 type: string description: E-commerce identification code. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 plan_id: maxLength: 36 minLength: 36 type: string description: Plan identifier. format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd name: type: string description: Plan name. example: Plano flex description: type: string description: Description of the plan. example: Flex plan amount: type: integer description: Plan value. example: 19990 currency: maxLength: 3 minLength: 3 type: string description: Currency identification (See code in "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL payment_types: type: string description: Types of payments accepted. example: "" enum: - credit_card - debit_card sales_tax: type: integer description: Tax value. product_type: type: string description: Identifier of the type of product sold among the options. example: service enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service create_date: maxLength: 24 type: string description: Plan creation date. format: YYYY-MM-DDTHH:MM:SSZ example: 2017-04-19T16:30:30Z status: maxLength: 20 type: string description: Plan status. example: active enum: - active - inactive period: $ref: '#/components/schemas/Period' floating_data: type: array description: "Preconfigured list of installments that will have a different value\ \ when the Subscription is created. This functionality can be used\ \ to create tasting installments with zero value, one input value\ \ or discounted installments. The use of this functionality and its purpose\ \ expected will depend on the enablement of a specific product at Getnet." items: $ref: '#/components/schemas/FloatingDataWithDetails' CreditResponse: type: object properties: number_installments: type: integer format: int32 billing_address: "$ref": "#/components/schemas/Address" soft_descriptor: type: string transaction_type: type: string enum: - FULL - INSTALL_WITH_INTEREST - INSTALL_NO_INTEREST tokenization: "$ref": "#/components/schemas/Tokenization" card: "$ref": "#/components/schemas/CreditCardResponse" wallet: "$ref": "#/components/schemas/Wallet" PeriodResponse: required: - billing_cycle - type type: object properties: type: type: string enum: - yearly - monthly - bimonthly - quarterly - semesterly - specific billing_cycle: minimum: 0 type: integer format: int32 specific_cycle_in_days: type: integer format: int32 FloatingData: required: - installment type: object properties: installment: type: integer format: int32 example: 2 description: Number of the installment to which the change will be applied. minimum: 1 new_amount: type: integer example: 19990 description: New charge amount. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New billing date example: '2020-06-10' maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: Date the billing was originally scheduled, before it was changed, according to the plan associated with the subscription. example: '2020-06-10' maxLength: 12 original_amount: type: integer example: 19990 description: Original billing amount, before it was changed, according to the plan associated with the subscription. minimum: 0 Tokenization: required: - type type: object properties: type: type: string enum: - UCAF - TAVV - ELO cryptogram: type: string eci: type: string requestor_id: type: string Wallet: required: - id - type type: object properties: type: type: string id: type: string CreditCardResponse: required: - bin - cardholder_name - expiration_month - expiration_year type: object properties: brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro bin: maxLength: 9 minLength: 6 type: string expiration_month: maxLength: 2 minLength: 2 type: string expiration_year: maxLength: 2 minLength: 2 type: string cardholder_name: maxLength: 100 minLength: 0 type: string card_id: maxLength: 36 minLength: 0 type: string PaymentDataResponse: required: - acquirer_transaction_id - authorization_code - reason_code - reason_message - transaction_id type: object properties: delayed: type: boolean authorization_code: type: string authorization_timestamp: type: string format: date-time reason_code: type: string reason_message: type: string acquirer: type: string soft_descriptor: type: string brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro terminal_nsu: type: string acquirer_transaction_id: type: string transaction_id: type: string PaymentError: type: object properties: status_code: type: integer format: int32 name: type: string message: type: string details: type: array items: "$ref": "#/components/schemas/PaymentErrorDetail" PaymentErrorDetail: type: object properties: acquirer_transaction_id: type: string description: type: string description_detail: type: string error_code: type: string payment_id: type: string status: type: string terminal_nsu: type: string Shipping: type: object properties: first_name: maxLength: 40 minLength: 0 type: string last_name: maxLength: 40 minLength: 0 type: string email: type: string phone_number: maxLength: 15 minLength: 0 type: string shipping_amount: type: integer format: int32 address: "$ref": "#/components/schemas/Address" CreditCardCreation: required: - number_token type: object properties: brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro number_token: type: string bin: maxLength: 9 minLength: 6 type: string expiration_month: maxLength: 2 minLength: 2 type: string expiration_year: maxLength: 2 minLength: 2 type: string cardholder_name: maxLength: 100 minLength: 0 type: string card_id: maxLength: 36 minLength: 0 type: string security_code: pattern: "(^$|.{3,4})" type: string last_four_digits: maxLength: 4 minLength: 0 type: string CreditCreation: required: - card - number_installments - transaction_type type: object properties: transaction_type: type: string enum: - FULL - INSTALL_WITH_INTEREST - INSTALL_NO_INTEREST billing_address: "$ref": "#/components/schemas/Address" soft_descriptor: maxLength: 22 minLength: 0 type: string card: "$ref": "#/components/schemas/CreditCardCreation" wallet: "$ref": "#/components/schemas/Wallet" tokenization: "$ref": "#/components/schemas/Tokenization" number_installments: type: integer format: int32 PaymentCreation: required: - card - transaction_type type: object properties: transaction_type: type: string enum: - FULL - INSTALL_WITH_INTEREST - INSTALL_NO_INTEREST billing_address: "$ref": "#/components/schemas/Address" soft_descriptor: maxLength: 22 minLength: 0 type: string card: "$ref": "#/components/schemas/CreditCardCreation" wallet: "$ref": "#/components/schemas/Wallet" tokenization: "$ref": "#/components/schemas/Tokenization" PaymentTypeCreation: type: object properties: credit: "$ref": "#/components/schemas/CreditCreation" debit: "$ref": "#/components/schemas/PaymentCreation" SubscriptionCreation: required: - customer_id - plan_id - seller_id type: object properties: seller_id: "$ref": "#/components/schemas/seller_id" customer_id: "$ref": "#/components/schemas/customer_id" plan_id: "$ref": "#/components/schemas/plan_id" order_id: "$ref": "#/components/schemas/order_id" installment_start_date: description: Subscription billing start date. Until that date, the Subscription will remain Scheduled, that is, with the status created. The use of this field and its expected purpose will depend on enabling a specific product on Getnet. type: string format: YYYY-MM-DD example: '2020-09-14' maxLength: 10 subscription: "$ref": "#/components/schemas/SubscriptionDetailCreation" device: "$ref": "#/components/schemas/Device" description: Request containing data for registering a new subscription. SubscriptionDetailCreation: type: object properties: payment_type: "$ref": "#/components/schemas/PaymentTypeCreation" shippings: type: array items: "$ref": "#/components/schemas/Shipping" PaymentDate: required: - day type: object properties: day: description: Payment date of the new charge. type: integer minimum: 1 maximum: 31 example: 25 description: Data set for updating payment date. SubscriptionCancel: required: - seller_id - status_details type: object properties: seller_id: "$ref": "#/components/schemas/seller_id" status_details: description: Details of the recurrence subscription status. type: string example: Subscription Plan flex successfully created maxLength: 500 FloatingDataProjection: type: object properties: new_date: type: string format: date new_amount: type: integer format: int32 Projection: required: - amount - date type: object properties: installment: type: integer format: int32 date: type: string format: date amount: type: integer format: int32 floating_data: "$ref": "#/components/schemas/FloatingDataProjection" AmountProjection: required: - amount type: object properties: amount: type: integer format: int32 projection: type: array items: "$ref": "#/components/schemas/Projection" ConfirmPayment: required: - charge_id - seller_id - status_details type: object properties: seller_id: "$ref": "#/components/schemas/seller_id" status_details: description: Details of the recurrence subscription status. type: string example: Subscription Plan flex successfully created maxLength: 500 charge_id: description: Identifier of the charge. type: string minLength: 36 maxLength: 36 format: uuidv4v4 example: 52bc81b2-f079-4f7b-b63a-f653ff29d794 description: Request containing data to confirm payment of a subscription charge. ReplaceCreditCard: required: - number_token type: object properties: number_token: type: string description: Tokenized card number. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Buyer's name printed on card. Required if card details were not permanently stored with the token. maxLength: 26 example: JOAO DA SILVA brand: type: string description: Flag. (Also used in anti-fraud). Required if card details were not permanently stored with the token. example: mastercard enum: - Mastercard - Visa - Amex - link - Hipercard maxLength: 50 expiration_month: type: string description: Two-digit card expiry month. Required if card details were not permanently stored with the token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Two-digit card expiry year. Required if card details were not permanently stored with the token. minLength: 2 maxLength: 2 example: '28' bin: type: string description: First six numbers of the card. minLength: 6 maxLength: 9 example: '123412' wallet: "$ref": "#/components/schemas/Wallet" tokenization: "$ref": "#/components/schemas/Tokenization" description: Data set for updating subscription payment data. FloatingDataResponse: required: - subscription_id type: object properties: subscription_id: type: string format: uuid floating_data: type: array items: "$ref": "#/components/schemas/FloatingData" FloatingDataRemoveResponse: type: object properties: subscription_id: type: string format: uuid description: Recurrence signature identifier. minLength: 36 maxLength: 36 example: 9aca75f2-bb03-42d7-aa09-7e46409ded26 floating_data: type: array description: List of charges with date and/or amount changes items: "$ref": "#/components/schemas/FloatingDataWithDetails" FloatingDataWithDetails: required: - installment type: object properties: installment: minimum: 1 type: integer description: Number of the installment to which the change will be applied. format: int32 example: 2 amount: minimum: 0 type: integer description: "New charge amount for a given portion of the plan.\ \ When a Subscription is created with this Plan it will have this character\ static, for example for installment 2 apply the amount of R$ 10.00. That\ \ value can be zero, greater or less than the original value of the Plan." example: 19990 FloatingDataUpdate: type: object properties: new_amount: type: integer example: 19990 description: New charge amount. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: New billing date example: '2020-06-10' maxLength: 12 description: Request containing data for registering a new subscription. PlanMigrationRequest: required: - from - to type: object properties: from: type: string format: uuid description: Identifier of the original plan, that is, the original plan_id of the Subscription. to: type: string format: uuid description: Identifier of the target plan, that is, the plan_id to which you want to migrate the Subscription. description: Subscription plan migration data. Order: required: - order_id type: object properties: order_id: type: string sales_tax: type: integer format: int32 product_type: type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service Card: required: - bin - cardholder_name - expiration_month - expiration_year - number_token type: object properties: card_id: type: string bin: type: string number_token: type: string cardholder_name: type: string security_code: type: string brand: type: string enum: - Mastercard - Visa - Amex - Elo - Hipercard - Maestro expiration_month: type: string expiration_year: type: string PaymentResponseCharge: required: - amount - charge_id - customer_id - seller_id - subscription_id type: object properties: seller_id: type: string charge_id: type: string subscription_id: type: string customer_id: type: string amount: type: integer format: int32 order: "$ref": "#/components/schemas/Order" plan: "$ref": "#/components/schemas/PlanCharge" credit: "$ref": "#/components/schemas/Card" payment: "$ref": "#/components/schemas/PaymentDataResponse" charge_status: type: string enum: - processing - paid - canceled - undo_failed - scheduled - payment_pending - denied - suspended - free PlanCharge: required: - period - plan_id type: object properties: plan_id: type: string amount: type: integer format: int32 name: type: string floating_data: type: array items: "$ref": "#/components/schemas/FloatingDataPlan" period: "$ref": "#/components/schemas/Period" consultaBinResponse: title: consultaBinResponse type: object properties: results: type: array items: $ref: '#/components/schemas/results' status: type: string description: BIN Status return message. xml: name: consultaBinResponse attribute: false wrapped: false results: title: results type: object properties: bin: type: integer description: BIN of the query. brand: type: string description: Flag name. brand_code: type: integer description: Flag code. brazilian_issued: type: string description: Informs whether the issuer is from Brazil. country: type: string description: Country name. country_code: type: string description: Country numeric code. country_code_iso: type: string description: ISO_3166-1 country code. issuer: type: string description: Issuer name. product: type: string description: Product linked to BIN. type: type: string description: "BIN type (credit, debit, prepaid)." enum: - credit - debit - prepaid description: BIN information list. xml: name: results attribute: false wrapped: false split_data: type: object required: - subseller_list_payment properties: subseller_list_payment: type: array description: List of Stores and their due amounts for payment. items: type: object required: - subseller_id - document_number - subseller_sale_amount - items properties: subseller_id: maxLength: 25 minLength: 0 type: string description: Subseller ID registered on the marketplace platform (MGM). example: "700104158" document_type: maxLength: 4 minLength: 3 type: string description: Sub-trade document type. example: CNPJ enum: - CPF - CNPJ document_number: maxLength: 15 minLength: 11 type: string description: Sub-trade document number without punctuation. (without mask) example: '12345678912' subseller_sale_amount: type: integer description: Part of the Store Value in relation to the Order (in cents). example: 118708 items: type: array description: List of Subtrade items. items: type: object required: - id - description - amount properties: id: maxLength: 25 minLength: 1 type: string description: Item/Product Identifier. example: "MR1" description: type: string description: Item/Product Description. example: Product MR1. amount: type: integer description: Item/Product value (in cents). example: 118708 transaction_rate_percent: type: number description: 'Fee to be charged on the item in percentage if not send the rate will be set the same as the registration.
If transaction_rate_percent is informed, the transaction_rate_amount should not be sent.
Note: If transaction_rate_percent and transaction_rate_amount are sent for the same item the values will be added together.' example: 1.2 transaction_rate_amount: type: integer description: 'Fee to be charged on the item in value (in cents) if you do not send the fee will be set the same as the registration.
If transaction_rate_amount is informed, the transaction_rate_percent must not be sent.
Note: If transaction_rate_percent and transaction_rate_amount are sent to the same item the values will be added.' example: 235 payment_plan: type: integer description: Subseller Payment Plan. example: 3 description: Data for split payment. Required field for payment split. DeviceDTO: type: object description: Set of data referring to the device used by the buyer. properties: ip_address: type: string description: string IP address (IPv4) of the buyer's device. This attribute must be captured by your application, from the device of the buyer (mobile; browser; etc.) and sent in the payload, in order to enrich our preventive analyses.
Required field for Antifraud example: "10.0.0.1" device_id: type: string description: Identification hash (Device Fingerprint) of the device. More information in the Antifraude topic.
Required field for Antifraud example: "ae44e06c-3e85-44af-8542-bcaccd54ef2e" CustomerDTOAddData: type: object properties: document_type: type: string example: CPF description: Type of the buyer's identification document. Mandatory for billet.
Suggested Values CPF, CNPJ, RNE, RG, CNAE, PASSPORT ou Document in accordance with current legislation in the country of origin

Mandatory field for Antifraude document_number: type: string example: 2441356709 description: Purchaser's document number without punctuation. (without mask)
Mandatory field for Antifraud email: type: string example: aceiti@getnet.com.br description: Purchaser's email.
Mandatory field for Antifraud name: type: string example: Jose da Silva description: Purchaser's name.
Mandatory field for Antifraud phone_number: type: string example: 11999999999 description: Purchaser's phone number.
Mandatory field for Antifraud billing_address: "$ref": "#/components/schemas/BillingAddressDTO" shippings: "$ref": "#/components/schemas/ShippingsDTO" BillingAddressDTO: type: object properties: street: type: string description: Street.
Mandatory field for Antifraud number: type: string description: Street number.
Mandatory field for Antifraud district: type: string description: District.
Mandatory field for Antifraud city: type: string description: City.
Mandatory field for Antifraud state: type: string description: State (UF).
Mandatory field for Antifraud country: type: string description: Country.
Report in the ISO 3166-1 alpha-3 standard
Example "BRA", "USA" and "ARG"
Mandatory field for Antifraud postal_code: type: string description: Postal Code, CEP in Brazil or ZIP in the United States. (without mask)
Mandatory field for Antifraud complement: type: string description: Address complement.
Mandatory field for Antifraud type: type: string enum: - RESIDENCIAL - INSTALACAO - CORRESPONDENCIA - FISCAL - COBRANCA ShippingsDTO: type: object properties: address: type: string description: Set of data referring to the buyer's address street: type: string number: type: string district: type: string city: type: string country: type: string postal_code: type: string complement: type: string type: type: string PixDTO: required: - amount - currency - idempotency_key type: object properties: amount: "$ref": "#/components/schemas/amount" currency: "$ref": "#/components/schemas/currency" order_id: "$ref": "#/components/schemas/order_id" customer_id: type: string description: 'Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification. ' maxLength: 36 idempotency_key: maxLength: 64 minLength: 1 type: string description: Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d30a21 Payment: type: object properties: payment_id: type: string description: Payment Identifier. maxLength: 36 minLength: 36 format: uuidv4 example: cd966c8a-cda4-4ea6-8d20-bfdd1c3da312 status: type: string description: Transaction status. For more information about status return, see Notifications 1.1 maxLength: 8 example: WAITING enum: - PENDING - WAITING - EXPIRED - ERROR - APPROVED - DENIED description: type: string description: 'Text with a message describing the result of the request. ' example: The QR Code was successfully generated and awaiting payment. additional_data: type: object description: 'Group of additional information about the result of the request of QR Code or PIX transaction. ' properties: transaction_id: type: string description: 'Identifier of the transaction started after the generation of the QR Code PIX with the institution. ' example: 9000TRXIDdnmnefxzmvfckki qr_code: type: string description: 'Payload of generated QR Code PIX. With this text it will be possible present it in graphic mode or the customer can pay it via function "Copy and Paste" by PIX. ' example: 00020101021226740014br.gov.bcb.pix210812345678 22041234230812345678242000112233445566778899520400005303986540690005802BR5913JOHN DOE6008SAO PAULO62190515RP12345678-201980720014br.gov.bcb.pix2550bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8=630434D1 creation_date_qrcode: type: string description: Creation date of the generated QR Code. format: YYYY-MM-DDTHH:MM:SSZ example: '2022-06-08T10:55:07.890' expiration_date_qrcode: type: string description: Expiration date of the generated QR Code. format: YYYY-MM-DDTHH:MM:SSZ example: '2022-06-08T10:56:07.890' psp_code: type: string description: 'Recipient`s PSP code. PSP (Payment Service Provider, which is the financial institution responsible for the payment or the receipt of values on Pix. ' example: 45454 idempotency_key: maxLength: 64 minLength: 1 type: string description: Chave of idempotency, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data. example: 1eb2412c-165a-41cd-b1d9-76c575d30a21 quote_id: type: string description: "Quote ID to be used in the query" format: "uuidv4" example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e" CombinedPaymentDTO: type: object properties: request_id: title: request_id type: string example: daac03dc-73db-453f-9bea-b1391669d5d3 minLength: 36 maxLength: 36 format: uuid description: Request identifier. Unique for each request order_id: $ref: '#/components/schemas/order_id' data: "$ref": "#/components/schemas/CombinedDataDTO" additional_data: type: object additionalProperties: type: object CombinedDataDTO: required: - payments type: object properties: amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' customer_id: "$ref": "#/components/schemas/customer_id" payments: type: array items: "$ref": "#/components/schemas/CombinedPaymentDataDTO" sub_merchant: "$ref": "#/components/schemas/SubMerchantDTO" additional_data: type: object additionalProperties: type: object CombinedPaymentDataDTO: type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' payment_id: $ref: '#/components/schemas/payment_id' amount: $ref: '#/components/schemas/amount' payment_method: $ref: '#/components/schemas/payment_method' save_card_data: type: boolean example: false default: false description: Determine whether the card should be saved for future purchases. Only for customers using the GetNet vault. transaction_type: type: string description: Transaction type. Payment in cash or in installments to the retailer or in installments to the issuer. example: FULL enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: number example: 1 description: Number of installments. soft_descriptor: $ref: '#/components/schemas/soft_descriptor' dynamic_mcc: type: number example: 1234 description: 'Field used to signal the transaction with another Merchant Category Code (Establishment Category Code) different from the registered one. If an invalid MCC is sent, the default will be used. Send numeric data only.' card: "$ref": "#/components/schemas/CardDTO" tokenization: "$ref": "#/components/schemas/TokenizationDTO" wallet: "$ref": "#/components/schemas/WalletCreditDTO" xid: type: string description: Field available from version 2.0 onwards. MPI identifier for each authenticated transaction. The field content can be a HEXA or Base64 value, according to the MPI used. maxLength: 40 example: test ucaf: type: string description: Field available from version 2.0 onwards. Authentication code encrypted by the Flag. The field content can be a HEXA or Base64 value, according to the MPI used. maxLength: 40 example: string eci: type: string description: Field available from version 2.0 onwards. ECI code of the 3D Secure Authenticated transaction. Generated by an External MPI. maxLength: 2 example: "00" tdsdsxid: type: string description: 3DS server version 2 transaction identifier. example: string tdsver: type: string description: Indicates the 3DS version used in authentication, example: 2.1.0 is_pre_paid: type: boolean network_token: type: string description: Card token that will be used to generate the cryptogram. example: 1b110aaa71934ae492bff48baab9af81 payment_tag: type: string description: Required for split billing_address: "$ref": "#/components/schemas/BillingAddressDTO" installment: "$ref": "#/components/schemas/InstallmentCuotesDTO" cross_border_data: "$ref": "#/components/schemas/CrossBorderDataDTO" CrossBorderDataDTO: type: object properties: first_name: description: Buyer's first name. type: string maxLength: 40 example: John last_name: description: Buyer's last name. type: string maxLength: 80 example: da Silva type: type: string description: Field that informs the type of buyer, being \"INDIVIDUAL\" for a natural person and \"COMPANY\" for a legal entity. enum: - INDIVIDUAL - COMPANY document_number: type: string email: type: string description: Required for FX (cross border) CombinedResponseDTOCombinedAutorizationResponseDataDTO: type: object properties: seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' combined_id: type: string description: Combined payment identification code. example: 66f36211-3a61-41fa-8747-052c451e89ad payments: type: array items: "$ref": "#/components/schemas/CombinedAutorizationResponseDataDTO" CombinedAutorizationResponseDataDTO: type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' payment_id: $ref: '#/components/schemas/payment_id' status: type: string payment_method: $ref: '#/components/schemas/payment_method' received_at: $ref: '#/components/schemas/received_at' transaction_id: $ref: '#/components/schemas/transaction_id' original_transaction_id: type: string example: '6534812321501821' description: Original transaction identifier authorized_at: $ref: '#/components/schemas/authorized_at' reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' acquirer: $ref: '#/components/schemas/acquirer' soft_descriptor: $ref: '#/components/schemas/soft_descriptor' brand: $ref: '#/components/schemas/brand' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' eci: $ref: '#/components/schemas/eci' payment_received_timestamp: type: string format: date-time card_id: maxLength: 36 type: string description: Card identifier saved in the safe, can be used to retrieve a valid number_token for future purchases, as well as can be used to remove saved cards. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 merchant_advice_code: type: string description: merchant_advice_code. amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' CombinedOperationsRequestDTOCombinedCapturetDataDTO: type: object properties: request_id: $ref: '#/components/schemas/request_id' payments: type: array items: "$ref": "#/components/schemas/CombinedCapturetDataDTO" additional_data: type: object additionalProperties: type: object CombinedCapturetDataDTO: type: object properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' payment_id: $ref: '#/components/schemas/payment_id' amount: $ref: '#/components/schemas/amount' payment_method: $ref: '#/components/schemas/payment_method' CombinedResponseDTOCaptureResponseDTO: type: object properties: seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' combined_id: type: string description: Combined payment identification code. example: 66f36211-3a61-41fa-8747-052c451e89ad payments: type: array items: "$ref": "#/components/schemas/CaptureResponseDTO" CombinedOperationsRequestDTOCombinedCancelDataDTO: type: object properties: request_id: $ref: '#/components/schemas/request_id' payments: type: array items: "$ref": "#/components/schemas/CombinedCancelDataDTO" additional_data: type: object additionalProperties: type: object CombinedCancelDataDTO: type: object properties: idempotency_key: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' amount: $ref: '#/components/schemas/amount' payment_method: $ref: '#/components/schemas/payment_method' custom_key: $ref: '#/components/schemas/custom_key' payment_tag: type: string description: Required for split CombinedResponseDTOCancelResponseDTO: type: object properties: seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' combined_id: type: string description: Combined payment identification code. example: 66f36211-3a61-41fa-8747-052c451e89ad payments: type: array items: "$ref": "#/components/schemas/CancelResponseDTO" CombinedReleaseDTO: type: object properties: release_payment_date: type: string previous_release_payment_date: type: string subseller_id: maxLength: 25 minLength: 0 type: string description: Subseller ID registered on the marketplace platform (MGM). example: "700104158" order_item_release: type: array items: "$ref": "#/components/schemas/OrderItemReleaseDTO" combined_id: type: string MgmReleaseSubSellerPaymentResponse: type: object properties: success: type: boolean errors: type: array items: "$ref": "#/components/schemas/Errors" item_id: type: string Errors: type: object properties: cod_error: type: integer format: int32 message: type: string ValidationsDTO: type: object properties: token: type: string EnrolmentsInitialDTO: type: object properties: currency: type: string md: "$ref": "#/components/schemas/md" term_url: type: string amount: type: integer format: int32 payment_method: "$ref": "#/components/schemas/PaymentMethod" description: type: string operation: type: string extra_fields: "$ref": "#/components/schemas/ExtraFields" PaymentMethod: required: - expiration_month - expiration_year - number_token - security_code type: object properties: number_token: type: string security_code: type: string expiration_month: type: string expiration_year: type: string ExtraFields: type: object properties: billing_address: type: object description: "Data structure containing shipping address details" required: - street - number - country - postal_code properties: street: type: string description: "Name of a street or thoroughfare" maxLength: 60 example: Av. Brasil number: type: string description: "Number that identifies the position of a building on a street" maxLength: 10 example: '1000' complement: type: string description: "Additional address information" maxLength: 60 example: Sala 1 district: type: string description: "Name of a district, for example, a part of a town or region" maxLength: 40 example: São Geraldo city: type: string description: "Name of a built-up area with defined boundaries and a local government.\n\nThe value is based on the ISO 3166-2, according to the country defined within the address details." maxLength: 40 example: Porto Alegre state: type: string description: "Name of an organized political community or area forming a part of a federation.\n\nThe value is based on the ISO 3166-2, according to the country defined within the address details." maxLength: 20 example: RS country: type: string description: "Country code.\n\nThe value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/)." maxLength: 2 example: BR postal_code: type: string description: "Postal or ZIP code.\n\nThe value consists of a group of letters and/or numbers that is added to a postal address to assist in sorting the mail." maxLength: 8 example: '90230060' reference: type: string description: "Reference point details that can be used to help locate the address" maxLength: 80 example: 'Near the hospital' shipping_address: type: object description: "Data structure containing shipping address details" required: - street - number - country - postal_code properties: street: type: string description: "Name of a street or thoroughfare" maxLength: 60 example: Av. Brasil number: type: string description: "Number that identifies the position of a building on a street" maxLength: 10 example: '1000' complement: type: string description: "Additional address information" maxLength: 60 example: Sala 1 district: type: string description: "Name of a district, for example, a part of a town or region" maxLength: 40 example: São Geraldo city: type: string description: "Name of a built-up area with defined boundaries and a local government.\n\nThe value is based on the ISO 3166-2, according to the country defined within the address details." maxLength: 40 example: Porto Alegre state: type: string description: "Name of an organized political community or area forming a part of a federation.\n\nThe value is based on the ISO 3166-2, according to the country defined within the address details." maxLength: 20 example: RS country: type: string description: "Country code.\n\nThe value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/)." maxLength: 2 example: BR postal_code: type: string description: "Postal or ZIP code.\n\nThe value consists of a group of letters and/or numbers that is added to a postal address to assist in sorting the mail." maxLength: 8 example: '90230060' reference: type: string description: "Reference point details that can be used to help locate the address" maxLength: 80 example: 'Near the hospital' InitialResponseDTO: type: object properties: transaction_id: type: string md: "$ref": "#/components/schemas/md" tx_id: type: integer format: int32 xid: type: string description: "Transaction ID returned by the card issuer.\n\nThe value is 28 bytes (unique 20 byte value that has been Base64-encoded)." example: "VDdnR0kyU1g4ZXlxMkhWTlp0VnA=" protocol: type: string description: "3DS protocol used during processing" example: "3DS2.2.0" status: $ref: "#/components/schemas/StatusTransaction" operation: type: string description: "Card operation type" example: CREDIT enum: - CREDIT - DEBIT default: CREDIT tds_method_content: type: string description: "Complete HTML fragment that needs to be rendered in customer's browser" example: "" redirect_html_template: type: string description: "HTML template for redirecting the customer to the card issuer's authentication flow" example: "\n\n\n\n\n3D Secure Processing\n\n\n\n

3D Secure Processing

\n\n

\n $\"Please$

\n $\"MasterCard$

\n\n

\n\n\n" extra_fields: "$ref": "#/components/schemas/ExtraFields" StatusTransaction: type: string description: "Status of the transactions generated by the enrolment process" example: Pending enum: - Authenticated - Denied - Pending - Pending Challenge - Pending Enrolment Continue ValidationsResponseDTO: type: object properties: transaction_id: "$ref": "#/components/schemas/transaction_id" md: "$ref": "#/components/schemas/md" tx_id: "$ref": "#/components/schemas/tx_id" xid: "$ref": "#/components/schemas/xid" status: "$ref": "#/components/schemas/status3DS" protocol: "$ref": "#/components/schemas/protocol3DS" operation: "$ref": "#/components/schemas/operation" eci: "$ref": "#/components/schemas/eci" cavv: "$ref": "#/components/schemas/cavv" ds_trans_id: "$ref": "#/components/schemas/ds_trans_id" EnrolmentsContinueDTO: type: object properties: transaction_id: "$ref": "#/components/schemas/transaction_id" xid: "$ref": "#/components/schemas/xid" ContinueResponseDTO: type: object properties: transaction_id: "$ref": "#/components/schemas/transaction_id" md: "$ref": "#/components/schemas/md" tx_id: "$ref": "#/components/schemas/tx_id" xid: "$ref": "#/components/schemas/xid" status: "$ref": "#/components/schemas/status3DS" protocol: "$ref": "#/components/schemas/protocol3DS" operation: "$ref": "#/components/schemas/operation" redirect_html_template: "$ref": "#/components/schemas/redirect_html_template" ds_trans_id: "$ref": "#/components/schemas/ds_trans_id" eci: "$ref": "#/components/schemas/eci" cavv: "$ref": "#/components/schemas/cavv" Airlines: type: object required: - agency_invoice_number description: "Data structure containing airline details. Applies only for airline transactions." properties: passenger_code: type: string description: "File key of the Passenger Name Record (PNR).\n\nThis field is required for transactions using an AirPlus UATP card." maxLength: 255 example: "1234567890" company_id: type: string description: "" maxLength: 255 example: "1220" airline_code: type: string description: "3-digit IATA (International Air Transport Association) code used to identify the carrier" minLength: 3 maxLength: 3 example: "022" travel_agency_code: type: string description: "IATA number or ARC (Airlines Reporting Corporation) number of the travel agency that issued the ticket" minLength: 1 maxLength: 8 example: "s517" ticket_number: type: array items: type: string description: "Unique ticket number.\n\nThe ticket number is used for all legs of the trip." minLength: 1 maxLength: 13 example: ["125769"] # /dpm/payments-gwproxy/v2/payments/{payment_id}/release: # post: # tags: # - Payments Idempotency # summary: Release # description: Release a payment. # operationId: release_3 # parameters: # - $ref: '#/components/parameters/XSellerID' # - $ref: '#/components/parameters/PaymentId' # requestBody: # content: # application/json: # schema: # "$ref": "#/components/schemas/ReleaseDTO" # required: true # responses: # '200': # description: Transaction executed successfully. # content: # application/json: # schema: # type: object # additionalProperties: # type: object # '400': # description: Invalid Requisition # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Bad Request # name: Module or service that returned the error # status_code: 400 # details: # - status: DENIED # error_code: Error code # description: Bad Request # description_detail: Detailed error description # '401': # description: Invalid Authentication # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Unauthorized # name: Module or service that returned the error # status_code: 401 # details: # - status: DENIED # error_code: AUTHENTICATION-401 # description: Unauthorized # description_detail: Invalid client credentials # '402': # description: Unprocessable Entity # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Unprocessable Entity # name: Module or service that returned the error # status_code: 422 # details: # - status: DENIED # error_code: Error code # description: Unprocessable Entity # description_detail: Detailed error description # '404': # description: Not Found # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Not Found # name: Module or service that returned the error # status_code: 404 # details: # - status: DENIED # error_code: TOKENIZATION-404 # description: Not Found # description_detail: card_id Not Found # '500': # description: Internal server or service error # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Internal Server Error # name: Module or service that returned the error # status_code: 500 # details: # - status: ERROR # error_code: GENERIC-500 # description: Internal Server Error # description_detail: The server encountered an unexpected error. # security: # - PROD: # - "digital-platform:gateway-api" # - PRE: # - "digital-platform:gateway-api" # - SBX: # - "digital-platform:gateway-api" # /dpm/payments-gwproxy/v2/payments/combined/release: # post: # tags: # - Combined Payments # summary: Release combined payment # description: Release a combined list of payment. # operationId: release_1 # parameters: # - $ref: '#/components/parameters/XSellerID' # - $ref: '#/components/parameters/XTransactionChannelEntry' # requestBody: # content: # application/json: # schema: # "$ref": "#/components/schemas/CombinedReleaseDTO" # required: true # responses: # '200': # description: Transação executada com sucesso. # content: # application/json: # schema: # type: array # items: # "$ref": "#/components/schemas/MgmReleaseSubSellerPaymentResponse" # '400': # description: Invalid Requisition # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Bad Request # name: Module or service that returned the error # status_code: 400 # details: # - status: DENIED # error_code: Error code # description: Bad Request # description_detail: Detailed error description # '401': # description: Invalid Authentication # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Unauthorized # name: Module or service that returned the error # status_code: 401 # details: # - status: DENIED # error_code: AUTHENTICATION-401 # description: Unauthorized # description_detail: Invalid client credentials # '402': # description: Unprocessable Entity # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Unprocessable Entity # name: Module or service that returned the error # status_code: 422 # details: # - status: DENIED # error_code: Error code # description: Unprocessable Entity # description_detail: Detailed error description # '404': # description: Not Found # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Not Found # name: Module or service that returned the error # status_code: 404 # details: # - status: DENIED # error_code: TOKENIZATION-404 # description: Not Found # description_detail: card_id Not Found # '500': # description: Internal server or service error # content: # application/json: # schema: # "$ref": "#/components/schemas/DefaultErrorHttpResponse" # example: # message: Internal Server Error # name: Module or service that returned the error # status_code: 500 # details: # - status: ERROR # error_code: GENERIC-500 # description: Internal Server Error # description_detail: The server encountered an unexpected error.