From 51a2017c725e8515ac2fea990a4de4dfac3bed0c Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 26 Jul 2023 10:54:25 -0300 Subject: [PATCH 01/40] new transaction intent endpoints --- reference/api/transaction_intent.yaml | 1139 +++++++++++++++++++++++++ 1 file changed, 1139 insertions(+) create mode 100644 reference/api/transaction_intent.yaml diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml new file mode 100644 index 0000000000..840cf7a55c --- /dev/null +++ b/reference/api/transaction_intent.yaml @@ -0,0 +1,1139 @@ +openapi: 3.0.0 +servers: + - url: https://api.mercadopago.com +info: + title: Mercado Pago API Reference + version: "1.0" +paths: + /online-payments/v1/transaction-intents/{id}: + get: + tags: + - $ref: "#/tags/checkout-api" + summary: Get transaction intent by ID + x-summary-i18n: + eng: Get transaction intent by ID + spa: Obtener transaction intent por ID + por: Obter transaction intent por ID + description: Consult by ID retrieves an existing Transaction Intent + x-description-i18n: + eng: + spa: + por: + parameters: + - name: id + in: path + required: true + schema: + type: string + example: "00001njp2i" + description: Transaction Intent's Id + x-description-i18n: + eng: + spa: + por: + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: ["visa", "master"] + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ["ticket", "account_money"] + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: + type: object + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system + x-description-i18n: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. From 58ed87b47369a3fbe1d31d390ea89cd9b4cdc6c2 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 26 Jul 2023 11:03:06 -0300 Subject: [PATCH 02/40] fixed translation keys --- reference/api/transaction_intent.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 840cf7a55c..c1d61a46d1 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -16,9 +16,9 @@ paths: por: Obter transaction intent por ID description: Consult by ID retrieves an existing Transaction Intent x-description-i18n: - eng: - spa: - por: + eng: Consult by ID retrieves an existing Transaction Intent + spa: Consultar por ID recupera una Transaction Intent existente. + por: Consultar por ID recupera uma Transaction Intent existente parameters: - name: id in: path @@ -28,9 +28,9 @@ paths: example: "00001njp2i" description: Transaction Intent's Id x-description-i18n: - eng: - spa: - por: + eng: Transaction Intent's Id + spa: ID de la Transaction Intent + por: ID da Transaction Intent responses: "200": description: success From 7772ed7315c6e61dc2c5e81cebbfbe25297081e4 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 26 Jul 2023 16:09:47 -0300 Subject: [PATCH 03/40] fixed endpoint name --- reference/api/transaction_intent.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index c1d61a46d1..69ac59085f 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -5,10 +5,10 @@ info: title: Mercado Pago API Reference version: "1.0" paths: - /online-payments/v1/transaction-intents/{id}: + /v1/transaction-intents/{id}: get: tags: - - $ref: "#/tags/checkout-api" + - $ref: '#/tags/checkout-api' summary: Get transaction intent by ID x-summary-i18n: eng: Get transaction intent by ID @@ -171,7 +171,7 @@ paths: properties: enabled: type: array - example: ["visa", "master"] + example: visa, master description: Payment methods included items: type: object @@ -220,7 +220,7 @@ paths: type: array items: type: string - example: ["ticket", "account_money"] + example: ticket, account_money description: Methods of payment not included x-description-i18n: eng: Methods of payment not included From d965dfc4288127f16b792153deddd792e959757d Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Mon, 31 Jul 2023 15:33:02 -0300 Subject: [PATCH 04/40] post method added --- reference/api/transaction_intent.yaml | 1821 +++++++++++++++++++++++++ 1 file changed, 1821 insertions(+) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 69ac59085f..7dcde6c040 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -1137,3 +1137,1824 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. + post: + tags: + - $ref: "#/tags/checkout-api" +<<<<<<< HEAD + summary: Create a Transaction Intent + x-summary-i18n: + eng: Create a Transaction Intent + spa: Crear una Transaction Intent + por: Criar Transaction Intent + description: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process + x-description-i18n: + eng: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process + spa: Crea una nueva Transaction Intent en modo Builder. Con el ID de esta Transaction Intent es posible editarla a través del endpoint Patch y procesarla a través del endpoint Process + por: Cria uma nova Transaction Intent em modo Builder. Com o ID desta Transaction Intent é possível editá-lo através do Endpoint Patch, e processá-lo através do Endpoint Process +======= + summary: Creates a new Transaction Intent in mode Builder. + x-summary-i18n: + eng: Creates a new Transaction Intent in mode Builder. + spa: Crea una nueva Transaction Intent en modo Builder. + por: Cria uma nova Transaction Intent em modo Builder. + description: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process + x-description-i18n: + eng: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process + spa: Crea una nueva Transaction Intent en modo Builder. + por: Cria uma nova Transaction Intent em modo Builder. +>>>>>>> d3b7c548d647135094cdef34b1eda6b5f7e1db63 + parameters: + - in: header + name: X-Product-ID + schema: + type: string + example: "876542356788-mp" + required: false + description: Alphanumeric ID of the product + x-description-i18n: + eng: Alphanumeric ID of the product + spa: ID alfanumérico del producto + por: ID alfanumérico do produto + requestBody: + description: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. + x-description-i18n: + eng: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. + spa: Body completo para una solicitud de Transaction Intent en modo builder. El cuerpo mínimo para esta solicitud es una orden con el correo electrónico del pagador y el monto del pedido. + por: Body completo para uma solicitação de Transaction Intent em modo builder. O corpo mínimo para esta solicitação é um pedido com o e-mail do pagador e o valor do pedido. + content: + application/json: + schema: + type: object + properties: + active_to_date: + type: string + description: Close processing limit for transaction intent + x-description-i18n: + eng: Close processing limit for transaction intent + spa: Fecha límite de procesamiento para la intención de transacción + por: Data limite de processamento para a intenção de transação + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + options: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: ["credit_card", "debit_card"] + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: ["visa", "master"] + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ["ticket", "account_money"] + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: ["wallet_purchase", "onboarding_credits"] + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: + type: object + properties: + notification_url: + type: string + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + x-description-i18n: + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system + x-description-i18n: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + description: Order with all information to execute the transaction + x-description-i18n: + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação + type: object + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + required: true + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. From 8c053fa7ed800d57c82a0e7023033c464e7f0d4b Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Mon, 31 Jul 2023 15:39:13 -0300 Subject: [PATCH 05/40] fixed post method --- reference/api/transaction_intent.yaml | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 7dcde6c040..3719b0f2e9 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -1140,7 +1140,6 @@ paths: post: tags: - $ref: "#/tags/checkout-api" -<<<<<<< HEAD summary: Create a Transaction Intent x-summary-i18n: eng: Create a Transaction Intent @@ -1151,18 +1150,6 @@ paths: eng: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process spa: Crea una nueva Transaction Intent en modo Builder. Con el ID de esta Transaction Intent es posible editarla a través del endpoint Patch y procesarla a través del endpoint Process por: Cria uma nova Transaction Intent em modo Builder. Com o ID desta Transaction Intent é possível editá-lo através do Endpoint Patch, e processá-lo através do Endpoint Process -======= - summary: Creates a new Transaction Intent in mode Builder. - x-summary-i18n: - eng: Creates a new Transaction Intent in mode Builder. - spa: Crea una nueva Transaction Intent en modo Builder. - por: Cria uma nova Transaction Intent em modo Builder. - description: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process - x-description-i18n: - eng: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process - spa: Crea una nueva Transaction Intent en modo Builder. - por: Cria uma nova Transaction Intent em modo Builder. ->>>>>>> d3b7c548d647135094cdef34b1eda6b5f7e1db63 parameters: - in: header name: X-Product-ID From 4c24e3ed00f56c05a2f09bde09d5a223653c5f74 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 2 Aug 2023 15:05:44 -0300 Subject: [PATCH 06/40] new post path added --- reference/api/transaction_intent.yaml | 1817 ++++++++++++++++++++++++- 1 file changed, 1813 insertions(+), 4 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 3719b0f2e9..52ff71ec62 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -8,7 +8,7 @@ paths: /v1/transaction-intents/{id}: get: tags: - - $ref: '#/tags/checkout-api' + - $ref: "#/tags/checkout-api" summary: Get transaction intent by ID x-summary-i18n: eng: Get transaction intent by ID @@ -29,7 +29,7 @@ paths: description: Transaction Intent's Id x-description-i18n: eng: Transaction Intent's Id - spa: ID de la Transaction Intent + spa: ID de la Transaction Intent por: ID da Transaction Intent responses: "200": @@ -66,7 +66,7 @@ paths: por: Estado atual da transação enum: - new--novo - - transaction_in_process--transação em processo + - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -1143,7 +1143,7 @@ paths: summary: Create a Transaction Intent x-summary-i18n: eng: Create a Transaction Intent - spa: Crear una Transaction Intent + spa: Crear una Transaction Intent por: Criar Transaction Intent description: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process x-description-i18n: @@ -2945,3 +2945,1812 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. + /v1/transaction-intents/process: + post: + tags: + - $ref: '#/tags/checkout-api' + summary: Create and Process a new Transaction Intent + x-summary-i18n: + eng: Create and Process a new Transaction Intent + spa: Crear y procesar una nueva Transaction Intent. + por: Criar e processar uma nova Transaction Intent + description: Creates and Process a new Transaction Intent + x-description-i18n: + eng: This endppoint allows you to creates and rocess a new Transaction Intent + spa: Este endpoint permite crear y procesar una nueva Transaction Intent + por: Este endpoint permite criar e processar uma nova Transaction Intent + parameters: + - in: header + name: X-Product-ID + schema: + type: string + example: "876542356788-mp" + required: false + description: Alphanumeric ID of the product + x-description-i18n: + eng: Alphanumeric ID of the product + spa: ID alfanumérico del producto + por: ID alfanumérico do produto + requestBody: + description: Complete body for a Transaction Intent. + x-description-i18n: + eng: Complete body for a Transaction Intent. + spa: Body completo para una solicitud. + por: Body completo para uma solicitação. + content: + application/json: + schema: + type: object + properties: + active_to_date: + type: string + description: Close processing limit for transaction intent + x-description-i18n: + eng: Close processing limit for transaction intent + spa: Fecha límite de procesamiento para la intención de transacción + por: Data limite de processamento para a intenção de transação + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + options: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: [ "credit_card", "debit_card" ] + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: [ "visa", "master" ] + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: [ "ticket", "account_money" ] + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: [ "wallet_purchase", "onboarding_credits" ] + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: + type: object + properties: + notification_url: + type: string + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + x-description-i18n: + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system + x-description-i18n: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + description: Order with all information to execute the transaction + x-description-i18n: + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação + type: object + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + required: true + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. \ No newline at end of file From 4300fb94dece03e443135e2824f14af6b0817526 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Thu, 3 Aug 2023 12:17:32 -0300 Subject: [PATCH 07/40] added a mandatory field --- reference/api/transaction_intent.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 52ff71ec62..3c9a7f4edb 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -3008,6 +3008,7 @@ paths: por: Configuração do vendedor sobre opções disponíveis na transação properties: payment_methods: + required: true type: object properties: coupons: From da90492a12cc8fc6ef83876070c2ded4b58e3429 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Thu, 3 Aug 2023 16:38:12 -0300 Subject: [PATCH 08/40] added put method --- reference/api/transaction_intent.yaml | 2061 +++++++++++++++++++------ 1 file changed, 1579 insertions(+), 482 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 3c9a7f4edb..b778e525a6 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -2948,7 +2948,7 @@ paths: /v1/transaction-intents/process: post: tags: - - $ref: '#/tags/checkout-api' + - $ref: "#/tags/checkout-api" summary: Create and Process a new Transaction Intent x-summary-i18n: eng: Create and Process a new Transaction Intent @@ -3047,7 +3047,7 @@ paths: type: array items: type: string - example: [ "credit_card", "debit_card" ] + example: ["credit_card", "debit_card"] description: List of Payment Types included x-description-i18n: eng: List of Payment Types included @@ -3073,7 +3073,7 @@ paths: properties: enabled: type: array - example: [ "visa", "master" ] + example: ["visa", "master"] description: Payment methods included items: type: object @@ -3122,7 +3122,7 @@ paths: type: array items: type: string - example: [ "ticket", "account_money" ] + example: ["ticket", "account_money"] description: Methods of payment not included x-description-i18n: eng: Methods of payment not included @@ -3143,7 +3143,7 @@ paths: eng: Identifier of the purpose of the transaction, which allows load a predefined list of options spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: [ "wallet_purchase", "onboarding_credits" ] + example: ["wallet_purchase", "onboarding_credits"] integration: type: object description: Configuration of the seller on integration @@ -3153,56 +3153,56 @@ paths: por: Configuração do vendedor sobre a integração properties: notifications: - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento - properties: - default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + type: object + properties: + notification_url: + type: string + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + x-description-i18n: + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou integrator_id: type: number example: 34567 @@ -3214,476 +3214,1573 @@ paths: order: description: Order with all information to execute the transaction x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação type: object properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - reason: - type: string - example: "my_order_description" - description: Reason for the order or transaction - x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: required: true type: string - example: "50.00" - description: Total amount to be paid + description: Buyer's email x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago - items: - type: array - items: - type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - payer: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: type: object - description: Buyer's information + description: Type and number of legal document that identifies the person in the country x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país properties: - email: - required: true - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country - x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name + number: + description: Number of the document x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: + eng: Number of the document + spa: Número del documento + por: Número do documento type: string - example: "Doe" - description: Buyer's surname + example: "12345678098" + type: + description: Type of the document x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador properties: - street_name: + amount: type: string - example: "Street MercadoLivre" - description: Street name + example: "50.00" + description: Total amount to be paid with this payment method x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: type: string - example: "100" - description: Street number + example: "bapropagos" + description: Identifier of the chosen payment method x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - marketplace: - type: object - description: Marketplace settings - x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector - properties: - fee: + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: type: string - example: "5" - description: Percentage of commission charged to the collector + description: For offline payments, URL that allows you to continue the payment flow x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - payment_method: - properties: - credit_cards: - type: array - items: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: + refund_id: type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + example: 123456789 + description: ID of the refund x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - debit_cards: - type: array - items: - properties: - amount: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: type: string example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Amount of the refund x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - tickets: - type: array - items: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento properties: - amount: + code: type: string - example: "50.00" - description: Total amount to be paid with this payment method + example: "400" + description: Status code x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: type: string - example: "pec" - description: Identifier of the chosen payment method + example: "acquirer rejected" + description: Status message x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - atms: - type: array - items: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento type: object properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method + refund_id: + type: number + example: 123456789 + description: ID of the refund x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction + example: "50.00" + description: Amount of the refund x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - bank_transfers: - type: array - items: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento properties: - amount: + code: type: string - example: "50.00" - description: Total amount to be paid with this payment method + example: "400" + description: Status code x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction + example: "acquirer rejected" + description: Status message x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. + /v1/transaction-intents/{id}/cancel: + put: + tags: + - $ref: '#/tags/checkout-api' + summary: Cancel a Transaction Intent + x-summary-i18n: + eng: Cancel a Transaction Intent + spa: Cancelar una Transaction Intent + por: Cancelar uma Transaction Intent + description: This endpoint allows to cancel one Transaction Intent + x-description-i18n: + eng: This endpoint allows to cancel one Transaction Intent + spa: Este endpoint permite cancelar una Transaction Intent + por: Este endpoint permite cancelar uma Transaction Intent + parameters: + - in: path + name: id + schema: + type: string + required: true + required: false + description: Alphanumeric ID of the Transaction Intent to get + x-description-i18n: + eng: Alphanumeric ID of the Transaction Intent to get + spa: ID alfanumérico de la Transaction Intent a obtener + por: ID alfanumérico da Transaction Intent a ser obtida responses: "200": description: success From 780ad24048271340e361fd34d3f6afffc02a74ce Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Fri, 4 Aug 2023 11:11:44 -0300 Subject: [PATCH 09/40] added refund endpoint --- reference/api/transaction_intent.yaml | 3552 ++++++++++++++----------- 1 file changed, 2016 insertions(+), 1536 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index b778e525a6..ea069e3d57 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -5,32 +5,107 @@ info: title: Mercado Pago API Reference version: "1.0" paths: - /v1/transaction-intents/{id}: - get: + /v1/transaction-intents/: + post: tags: - - $ref: "#/tags/checkout-api" - summary: Get transaction intent by ID + - $ref: '#/tags/checkout-api' + summary: Create Transaction Intent x-summary-i18n: - eng: Get transaction intent by ID - spa: Obtener transaction intent por ID - por: Obter transaction intent por ID - description: Consult by ID retrieves an existing Transaction Intent + eng: Create Transaction Intent + spa: Crear Transaction Intent + por: Criar Transaction Intent + description: This endpoint allows to create a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Patch, and Process it through the Endpoint Process x-description-i18n: - eng: Consult by ID retrieves an existing Transaction Intent - spa: Consultar por ID recupera una Transaction Intent existente. - por: Consultar por ID recupera uma Transaction Intent existente + eng: This endpoint allows to create a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Patch, and Process it through the Endpoint Process + spa: Este endpoint permite crear una nueva Transaction Intent en modo Builder. Con el ID de esta Transaction Intent es posible editarla a través del endpoint Patch y procesarla a través del endpoint Process + por: Este endpoint permite criar uma nova Transaction Intent em modo Builder. Com o ID desta Transaction Intent é possível editá-lo através do Endpoint Patch, e processá-lo através do Endpoint Process parameters: - - name: id - in: path + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + - in: header + name: X-Product-ID schema: type: string - example: "00001njp2i" - description: Transaction Intent's Id - x-description-i18n: - eng: Transaction Intent's Id - spa: ID de la Transaction Intent - por: ID da Transaction Intent + example: "876542356788-mp" + required: false + description: Alphanumeric ID of the product + x-description-i18n: + eng: Alphanumeric ID of the product + spa: ID alfanumérico del producto + por: ID alfanumérico do produto + - in: header + name: X-Platform-ID + schema: + type: string + required: false + description: Alphanumeric ID of the platform + x-description-i18n: + eng: Alphanumeric ID of the platform + spa: ID alfanumérico de la plataforma + por: ID alfanumérico da plataforma + - in: header + name: X-Integrator-ID + schema: + type: string + required: false + description: Alphanumeric ID of the integrator + x-description-i18n: + eng: Alphanumeric ID of the integrator + spa: ID alfanumérico del integrador + por: ID alfanumérico do integrador + requestBody: + description: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. + x-description-i18n: + eng: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. + spa: Body completo para una solicitud de Transaction Intent en modo builder. El cuerpo mínimo para esta solicitud es una orden con el correo electrónico del pagador y el monto del pedido. + por: Body completo para uma solicitação de Transaction Intent em modo builder. O corpo mínimo para esta solicitação é um pedido com o e-mail do pagador e o valor do pedido. + content: + application/json: + schema: + type: object + properties: + order: + description: Order with all information to execute the transaction + x-description-i18n: + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação + type: object + properties: + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + required: true + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador responses: "200": description: success @@ -242,65 +317,46 @@ paths: spa: Configuración del seller sobre la integración por: Configuração do vendedor sobre a integração properties: - notifications: - type: object - properties: - notification_url: - type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento - properties: - default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou order: type: object description: Common Order attributes for request and response @@ -325,12 +381,12 @@ paths: eng: ID of the order previously created in the integrator's system spa: ID en sistema externo del integrador por: ID da ordem criada anteriormente no sistema do integrador - reason: + description: type: string example: "my_order_description" - description: Reason for the order or transaction + description: description for the order or transaction x-description-i18n: - eng: Reason for the order or transaction + eng: description for the order or transaction spa: Motivo de la orden o transacción por: Motivo da ordem ou transação amount: @@ -540,22 +596,6 @@ paths: eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - marketplace: - type: object - description: Marketplace settings - x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector - properties: - fee: - type: string - example: "5" - description: Percentage of commission charged to the collector - x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector sponsor_id: type: number example: 123456789 @@ -1137,880 +1177,169 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. - post: + /v1/transaction-intents/{id}: + get: tags: - $ref: "#/tags/checkout-api" - summary: Create a Transaction Intent + summary: Get transaction intent by ID x-summary-i18n: - eng: Create a Transaction Intent - spa: Crear una Transaction Intent - por: Criar Transaction Intent - description: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process + eng: Get transaction intent by ID + spa: Obtener transaction intent por ID + por: Obter transaction intent por ID + description: Consult by ID retrieves an existing Transaction Intent x-description-i18n: - eng: Creates a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Pacht, and Process it through the Endpoint Process - spa: Crea una nueva Transaction Intent en modo Builder. Con el ID de esta Transaction Intent es posible editarla a través del endpoint Patch y procesarla a través del endpoint Process - por: Cria uma nova Transaction Intent em modo Builder. Com o ID desta Transaction Intent é possível editá-lo através do Endpoint Patch, e processá-lo através do Endpoint Process + eng: Consult by ID retrieves an existing Transaction Intent + spa: Consultar por ID recupera una Transaction Intent existente. + por: Consultar por ID recupera uma Transaction Intent existente parameters: - - in: header - name: X-Product-ID + - name: id + in: path + required: true schema: type: string - example: "876542356788-mp" - required: false - description: Alphanumeric ID of the product - x-description-i18n: - eng: Alphanumeric ID of the product - spa: ID alfanumérico del producto - por: ID alfanumérico do produto - requestBody: - description: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. - x-description-i18n: - eng: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. - spa: Body completo para una solicitud de Transaction Intent en modo builder. El cuerpo mínimo para esta solicitud es una orden con el correo electrónico del pagador y el monto del pedido. - por: Body completo para uma solicitação de Transaction Intent em modo builder. O corpo mínimo para esta solicitação é um pedido com o e-mail do pagador e o valor do pedido. - content: - application/json: - schema: - type: object - properties: - active_to_date: - type: string - description: Close processing limit for transaction intent - x-description-i18n: - eng: Close processing limit for transaction intent - spa: Fecha límite de procesamiento para la intención de transacción - por: Data limite de processamento para a intenção de transação - format: date-time - example: "2023-09-06T10:00:00.000-03:00" - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - options: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - payment_methods: - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: ["credit_card", "debit_card"] - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included + example: "00001njp2i" + description: Transaction Intent's Id + x-description-i18n: + eng: Transaction Intent's Id + spa: ID de la Transaction Intent + por: ID da Transaction Intent + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento - properties: - enabled: - type: array - example: ["visa", "master"] - description: Payment methods included - items: - type: object - properties: - id: - type: string - description: Payment method identifier - x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento - example: "credit_card" - installments: - type: object - description: Configuration of the number of installments to offer for the payment method - x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento - properties: - default: - description: Default number of installments to offer - x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão - type: string - example: "3" - max: - description: Maximum number of installments to offer - x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer - type: string - example: "6" - min: - description: Minimum number of installments to offer - x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer - type: string - example: "1" - disabled: - type: array - items: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: type: string - example: ["ticket", "account_money"] - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: ["wallet_purchase", "onboarding_credits"] - integration: - type: object - description: Configuration of the seller on integration - x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração - properties: - notifications: - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento - properties: - default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system - x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador - order: - description: Order with all information to execute the transaction - x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação - type: object - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - reason: - type: string - example: "my_order_description" - description: Reason for the order or transaction - x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - required: true - type: string - example: "50.00" - description: Total amount to be paid - x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago - items: - type: array - items: - type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - required: true - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country - x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name - x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: - type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name - x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: - type: string - example: "100" - description: Street number - x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code - x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - marketplace: - type: object - description: Marketplace settings - x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector - properties: - fee: - type: string - example: "5" - description: Percentage of commission charged to the collector - x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon + example: "100.00" + description: Total value of coupon x-description-i18n: eng: Total value of coupon spa: Valor total del cupón por: Valor total do cupom - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + types: type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Configuration by payment method type x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - responses: - "200": - description: success - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: "00001njp2i" - description: ID of a created Transaction Intent - x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada - created_date: - type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent - x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação - format: date-time - status: - type: string - example: "authorized" - description: Current status of the transaction intent - x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação - enum: - - new--novo - - transaction_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelado - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow - x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - option: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento properties: enabled: type: array @@ -2085,46 +1414,65 @@ paths: spa: Configuración del seller sobre la integración por: Configuração do vendedor sobre a integração properties: - notification_url: - type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas - return_url_default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - return_url_pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - return_url_failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" + notifications: + type: object + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador order: type: object description: Common Order attributes for request and response @@ -2149,12 +1497,12 @@ paths: eng: ID of the order previously created in the integrator's system spa: ID en sistema externo del integrador por: ID da ordem criada anteriormente no sistema do integrador - description: + reason: type: string example: "my_order_description" - description: description for the order or transaction + description: Reason for the order or transaction x-description-i18n: - eng: description for the order or transaction + eng: Reason for the order or transaction spa: Motivo de la orden o transacción por: Motivo da ordem ou transação amount: @@ -2364,14 +1712,30 @@ paths: eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + marketplace: + type: object + description: Marketplace settings x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões amount_details: type: object properties: @@ -2948,13 +2312,13 @@ paths: /v1/transaction-intents/process: post: tags: - - $ref: "#/tags/checkout-api" + - $ref: '#/tags/checkout-api' summary: Create and Process a new Transaction Intent x-summary-i18n: eng: Create and Process a new Transaction Intent - spa: Crear y procesar una nueva Transaction Intent. - por: Criar e processar uma nova Transaction Intent - description: Creates and Process a new Transaction Intent + spa: Crear y procesar una nueva Transaction Intent + por: Criar e processar nova Transaction Intent + description: This endppoint allows you to creates and process a new Transaction Intent x-description-i18n: eng: This endppoint allows you to creates and rocess a new Transaction Intent spa: Este endpoint permite crear y procesar una nueva Transaction Intent @@ -2964,13 +2328,32 @@ paths: name: X-Product-ID schema: type: string - example: "876542356788-mp" required: false description: Alphanumeric ID of the product x-description-i18n: eng: Alphanumeric ID of the product spa: ID alfanumérico del producto por: ID alfanumérico do produto + - in: header + name: X-Platform-ID + schema: + type: string + required: false + description: Alphanumeric ID of the platform + x-description-i18n: + eng: Alphanumeric ID of the platform + spa: ID alfanumérico de la plataforma + por: ID alfanumérico da plataforma + - in: header + name: X-Integrator-ID + schema: + type: string + required: false + description: Alphanumeric ID of the integrator + x-description-i18n: + eng: Alphanumeric ID of the integrator + spa: ID alfanumérico del integrador + por: ID alfanumérico do integrador requestBody: description: Complete body for a Transaction Intent. x-description-i18n: @@ -3047,7 +2430,7 @@ paths: type: array items: type: string - example: ["credit_card", "debit_card"] + example: [ "credit_card", "debit_card" ] description: List of Payment Types included x-description-i18n: eng: List of Payment Types included @@ -3073,7 +2456,7 @@ paths: properties: enabled: type: array - example: ["visa", "master"] + example: [ "visa", "master" ] description: Payment methods included items: type: object @@ -3122,7 +2505,7 @@ paths: type: array items: type: string - example: ["ticket", "account_money"] + example: [ "ticket", "account_money" ] description: Methods of payment not included x-description-i18n: eng: Methods of payment not included @@ -3143,7 +2526,7 @@ paths: eng: Identifier of the purpose of the transaction, which allows load a predefined list of options spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: ["wallet_purchase", "onboarding_credits"] + example: [ "wallet_purchase", "onboarding_credits" ] integration: type: object description: Configuration of the seller on integration @@ -3153,56 +2536,56 @@ paths: por: Configuração do vendedor sobre a integração properties: notifications: - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento - properties: - default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + type: object + properties: + notification_url: + type: string + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + x-description-i18n: + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou integrator_id: type: number example: 34567 @@ -3214,452 +2597,554 @@ paths: order: description: Order with all information to execute the transaction x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação type: object properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - reason: - type: string - example: "my_order_description" - description: Reason for the order or transaction - x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - required: true - type: string - example: "50.00" - description: Total amount to be paid - x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago - items: - type: array - items: - type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - required: true - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: + id: type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country + example: 123456789 + description: ID of the order previously created in the integrator's system x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: type: string - example: "John" - description: Buyer's name + example: "my_order_id" + description: Reference of the order x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name - x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: - type: string - example: "100" - description: Street number - x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code - x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + example: "my_order_description" + description: Reason for the order or transaction x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - marketplace: - type: object - description: Marketplace settings - x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector - properties: - fee: - type: string - example: "5" - description: Percentage of commission charged to the collector - x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - payment_method: - properties: - credit_cards: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: type: array items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: + id: type: string - example: "23" - description: In case it is required, identifier of the card issuer entity + example: "x76ax" + description: Item identification code x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity + example: 4 + description: Number of item included in the order x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction + example: "100.00" + description: Unit price of the item x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - atms: - type: array - items: - type: object - properties: - amount: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: type: string - example: "50.00" - description: Total amount to be paid with this payment method + example: "30x30x30" + description: Dimensions of the item - length x width x height. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - bank_transfers: - type: array - items: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + required: true + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: type: object properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido coupons: description: Coupons can be used as a methods of payment in the transaction x-description-i18n: @@ -3684,6 +3169,1001 @@ paths: eng: Total value of coupon spa: Valor total del cupón por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. + /v1/transaction-intents/{id}/cancel: + put: + tags: + - $ref: '#/tags/checkout-api' + summary: Cancel a Transaction Intent + x-summary-i18n: + eng: Cancel a Transaction Intent + spa: Cancelar una Transaction Intent + por: Cancelar Transaction Intent + description: This endpoint allows to cancel a Transaction Intent + x-description-i18n: + eng: This endpoint allows to cancel a Transaction Intent + spa: Este endpoint permite cancelar una Transaction Intent + por: Este endpoint permite cancelar uma Transaction Intent + parameters: + - in: path + name: id + schema: + type: string + required: true + required: true + description: Alphanumeric ID of the Transaction Intent to get + x-description-i18n: + eng: Alphanumeric ID of the Transaction Intent to get + spa: ID alfanumérico de la Transaction Intent a obtener + por: ID alfanumérico da Transaction Intent a ser obtida responses: "200": description: success @@ -3895,46 +4375,46 @@ paths: spa: Configuración del seller sobre la integración por: Configuração do vendedor sobre a integração properties: - notification_url: - type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas - return_url_default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - return_url_pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - return_url_failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou order: type: object description: Common Order attributes for request and response @@ -4755,27 +5235,27 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. - /v1/transaction-intents/{id}/cancel: + /v1/transaction-intents/{id}/refund: put: tags: - $ref: '#/tags/checkout-api' - summary: Cancel a Transaction Intent + summary: Refund Transaction Intent x-summary-i18n: - eng: Cancel a Transaction Intent - spa: Cancelar una Transaction Intent - por: Cancelar uma Transaction Intent - description: This endpoint allows to cancel one Transaction Intent + eng: Refund Transaction Intent + spa: Reembolsar Transaction Intent + por: Reembolsar Transaction Intent + description: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint. x-description-i18n: - eng: This endpoint allows to cancel one Transaction Intent - spa: Este endpoint permite cancelar una Transaction Intent - por: Este endpoint permite cancelar uma Transaction Intent + eng: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint. + spa: Si una Transaction intent es procesada correctamente y el cliente desea realizar una cancelación, será posible efectuar un reembolso a través de este endpoint. + por: Caso uma Transaction Intent seja devidamente processada e o cliente desejar efetuar um cancelamento, será possível efetuar um reembolso por meio deste endpoint parameters: - in: path name: id schema: type: string required: true - required: false + required: true description: Alphanumeric ID of the Transaction Intent to get x-description-i18n: eng: Alphanumeric ID of the Transaction Intent to get @@ -4808,7 +5288,7 @@ paths: format: date-time status: type: string - example: "authorized" + example: "reverted" description: Current status of the transaction intent x-description-i18n: eng: Current status of the transaction intent @@ -5402,7 +5882,7 @@ paths: por: Valor do reembolso status: type: string - example: "pending" + example: "refunded" description: Status of the payment x-description-i18n: eng: Status of the payment From 47a34d79f73e589c7afb453f84e6874b7a168662 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 8 Aug 2023 11:17:03 -0300 Subject: [PATCH 10/40] updated yaml files --- reference/api/transaction_intent.yaml | 53 +++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 4 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index ea069e3d57..cccb280667 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -1189,9 +1189,20 @@ paths: description: Consult by ID retrieves an existing Transaction Intent x-description-i18n: eng: Consult by ID retrieves an existing Transaction Intent - spa: Consultar por ID recupera una Transaction Intent existente. + spa: Consultar por ID recupera una Transaction Intent existente por: Consultar por ID recupera uma Transaction Intent existente parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - name: id in: path required: true @@ -2324,10 +2335,22 @@ paths: spa: Este endpoint permite crear y procesar una nueva Transaction Intent por: Este endpoint permite criar e processar uma nova Transaction Intent parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - in: header name: X-Product-ID schema: type: string + example: "876542356788-mp" required: false description: Alphanumeric ID of the product x-description-i18n: @@ -4153,6 +4176,17 @@ paths: spa: Este endpoint permite cancelar una Transaction Intent por: Este endpoint permite cancelar uma Transaction Intent parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - in: path name: id schema: @@ -5244,12 +5278,23 @@ paths: eng: Refund Transaction Intent spa: Reembolsar Transaction Intent por: Reembolsar Transaction Intent - description: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint. + description: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint x-description-i18n: - eng: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint. - spa: Si una Transaction intent es procesada correctamente y el cliente desea realizar una cancelación, será posible efectuar un reembolso a través de este endpoint. + eng: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint + spa: Si una Transaction intent es procesada correctamente y el cliente desea realizar una cancelación, será posible efectuar un reembolso a través de este endpoint por: Caso uma Transaction Intent seja devidamente processada e o cliente desejar efetuar um cancelamento, será possível efetuar um reembolso por meio deste endpoint parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - in: path name: id schema: From 5eeac454c749ea61fc1e8017057fb0d0fa4f6bb8 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 8 Aug 2023 15:52:37 -0300 Subject: [PATCH 11/40] added patch method --- reference/api/transaction_intent.yaml | 1819 +++++++++++++++++++++++++ 1 file changed, 1819 insertions(+) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index cccb280667..6f4f2729b8 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -2320,6 +2320,1825 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. + patch: + tags: + - $ref: '#/tags/checkout-api' + summary: Modify Transaction Intent + x-summary-i18n: + eng: Modify Transaction Intent + spa: Modifificar Transaction Intent + por: Modifificar Transaction Intent + description: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it's possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intent's body before its processing. It's important to note that it's not necessary to send all fields filled; only those you want to modify or add + x-description-i18n: + eng: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it's possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intent's body before its processing. It's important to note that it's not necessary to send all fields filled; only those you want to modify or add + spa: Este endpoint permite la modificación de una Transaction Intent creada en el modo Builder. Utilizando el ID de la Transaction Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos; solo aquellos que desea modificar o agregar + por: Este endpoint possibilita a modificação de uma Transaction Intent criada no modo Builder. Utilizando o ID da Transaction Intent, é possível realizar edições por meio do endpoint PATCH. Isso permite a alteração ou adição de campos no corpo da intenção antes de seu processamento. É importante observar que não é obrigatório enviar todos os campos preenchidos, apenas aqueles que você deseja modificar ou acrescentar + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + - name: id + in: path + required: true + schema: + type: string + example: "00001njp2i" + description: Transaction Intent's Id + x-description-i18n: + eng: Transaction Intent's Id + spa: ID de la Transaction Intent + por: ID da Transaction Intent + requestBody: + description: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. + x-description-i18n: + eng: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. + spa: Cuerpo completo de una TI, que se puede cambiar. No es necesario enviar todos los campos completados, solo aquellos que desee modificar o incluir. + por: Corpo completo de uma TI, que pode ser alteradado. Não é necessário enviar todos os campos preenchidos, somente aqueles que deseja alterar ou incluir. + content: + application/json: + schema: + type: object + properties: + active_to_date: + type: string + description: Close processing limit for transaction intent + x-description-i18n: + eng: Close processing limit for transaction intent + spa: Fecha límite de procesamiento para la intención de transacción + por: Data limite de processamento para a intenção de transação + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + options: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: [ "credit_card", "debit_card" ] + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: [ "visa", "master" ] + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: [ "ticket", "account_money" ] + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: [ "wallet_purchase", "onboarding_credits" ] + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: + type: object + properties: + notification_url: + type: string + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + x-description-i18n: + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system + x-description-i18n: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + description: Order with all information to execute the transaction + x-description-i18n: + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação + type: object + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + required: true + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. /v1/transaction-intents/process: post: tags: From 9868dafb1bbdb9b0326f211ca67863942545bcc1 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 8 Aug 2023 15:53:44 -0300 Subject: [PATCH 12/40] fixed titles typos --- reference/api/transaction_intent.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 6f4f2729b8..932ff495b8 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -2326,8 +2326,8 @@ paths: summary: Modify Transaction Intent x-summary-i18n: eng: Modify Transaction Intent - spa: Modifificar Transaction Intent - por: Modifificar Transaction Intent + spa: Modificar Transaction Intent + por: Modificar Transaction Intent description: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it's possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intent's body before its processing. It's important to note that it's not necessary to send all fields filled; only those you want to modify or add x-description-i18n: eng: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it's possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intent's body before its processing. It's important to note that it's not necessary to send all fields filled; only those you want to modify or add From 38dd4dabbff6ed283577bd5591937dd6d74f89df Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 9 Aug 2023 12:43:31 -0300 Subject: [PATCH 13/40] fixed description typo --- reference/api/transaction_intent.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 932ff495b8..0857ea8ed1 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -2328,10 +2328,10 @@ paths: eng: Modify Transaction Intent spa: Modificar Transaction Intent por: Modificar Transaction Intent - description: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it's possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intent's body before its processing. It's important to note that it's not necessary to send all fields filled; only those you want to modify or add + description: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It iss important to note that it is not necessary to send all fields filled, only those you want to modify or add x-description-i18n: - eng: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it's possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intent's body before its processing. It's important to note that it's not necessary to send all fields filled; only those you want to modify or add - spa: Este endpoint permite la modificación de una Transaction Intent creada en el modo Builder. Utilizando el ID de la Transaction Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos; solo aquellos que desea modificar o agregar + eng: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It is important to note that it is not necessary to send all fields filled, only those you want to modify or add + spa: Este endpoint permite la modificación de una Transaction Intent creada en el modo Builder. Utilizando el ID de la Transaction Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos, solo aquellos que desea modificar o agregar por: Este endpoint possibilita a modificação de uma Transaction Intent criada no modo Builder. Utilizando o ID da Transaction Intent, é possível realizar edições por meio do endpoint PATCH. Isso permite a alteração ou adição de campos no corpo da intenção antes de seu processamento. É importante observar que não é obrigatório enviar todos os campos preenchidos, apenas aqueles que você deseja modificar ou acrescentar parameters: - in: header From 7dc619a3c904b9a088f92f5047f910d9822958cd Mon Sep 17 00:00:00 2001 From: Bautista Carvalho Date: Wed, 9 Aug 2023 16:18:05 -0300 Subject: [PATCH 14/40] change aspas --- reference/api/transaction_intent.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 0857ea8ed1..14484f21cf 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -3,7 +3,7 @@ servers: - url: https://api.mercadopago.com info: title: Mercado Pago API Reference - version: "1.0" + version: '1.0' paths: /v1/transaction-intents/: post: From c3e2f6a98bc723a32cb3065227223beabc12b4ce Mon Sep 17 00:00:00 2001 From: Bautista Carvalho Date: Wed, 9 Aug 2023 16:36:08 -0300 Subject: [PATCH 15/40] delete / --- reference/api/transaction_intent.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 14484f21cf..c5707d6186 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -5,7 +5,7 @@ info: title: Mercado Pago API Reference version: '1.0' paths: - /v1/transaction-intents/: + /v1/transaction-intents: post: tags: - $ref: '#/tags/checkout-api' From 1bd4d0adc62dab91845314db9d468c43f454211e Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Fri, 11 Aug 2023 15:13:10 -0300 Subject: [PATCH 16/40] description improvements --- reference/api/transaction_intent.yaml | 108 +++++++++++++------------- 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 0857ea8ed1..0d8aac79ea 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -14,11 +14,11 @@ paths: eng: Create Transaction Intent spa: Crear Transaction Intent por: Criar Transaction Intent - description: This endpoint allows to create a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Patch, and Process it through the Endpoint Process + description: This endpoint enables the creation of a new Transaction Intent in Builder mode. Upon obtaining the ID of this Transaction Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint x-description-i18n: - eng: This endpoint allows to create a new Transaction Intent in mode Builder. With the ID of this TI it is possible to edit it through the Endpoint Patch, and Process it through the Endpoint Process - spa: Este endpoint permite crear una nueva Transaction Intent en modo Builder. Con el ID de esta Transaction Intent es posible editarla a través del endpoint Patch y procesarla a través del endpoint Process - por: Este endpoint permite criar uma nova Transaction Intent em modo Builder. Com o ID desta Transaction Intent é possível editá-lo através do Endpoint Patch, e processá-lo através do Endpoint Process + eng: This endpoint enables the creation of a new Transaction Intent in Builder mode. Upon obtaining the ID of this Transaction Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint + spa: Este endpoint permite la creación de una nueva Transaction Intent en modo Builder. Al obtener el ID de esta Transaction Intent, es posible realizar ediciones a través del endpoint Patch y llevar a cabo el procesamiento utilizando el endpoint Process + por: Este endpoint possibilita a criação de uma nova Transaction Intent no modo Builder. Ao obter o ID desta Transaction Intent, é possível efetuar edições por meio do Endpoint Patch e realizar o processamento utilizando o Endpoint Process parameters: - in: header name: Authorization @@ -26,22 +26,22 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application's private key must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application's private key must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Acess Token - Chave privada do aplicativo deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: header name: X-Product-ID schema: type: string example: "876542356788-mp" required: false - description: Alphanumeric ID of the product + description: Alphanumeric product ID, for example, 876542356788-mp. x-description-i18n: - eng: Alphanumeric ID of the product - spa: ID alfanumérico del producto - por: ID alfanumérico do produto + eng: Alphanumeric product ID, for example, 876542356788-mp. + spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. + por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. - in: header name: X-Platform-ID schema: @@ -50,8 +50,8 @@ paths: description: Alphanumeric ID of the platform x-description-i18n: eng: Alphanumeric ID of the platform - spa: ID alfanumérico de la plataforma - por: ID alfanumérico da plataforma + spa: Identificación alfanumérica de la plataforma. + por: Identificação alfanumérica da plataforma. - in: header name: X-Integrator-ID schema: @@ -60,52 +60,52 @@ paths: description: Alphanumeric ID of the integrator x-description-i18n: eng: Alphanumeric ID of the integrator - spa: ID alfanumérico del integrador - por: ID alfanumérico do integrador + spa: Identificación alfanumérica del integrador + por: Identificação alfanumérica do integrador requestBody: - description: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. + description: Complete body for a Transaction Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. x-description-i18n: - eng: Complete body for a Transaction Intent request in mode builder. Minimum body for this request is an order with the payer's email and the order amount. - spa: Body completo para una solicitud de Transaction Intent en modo builder. El cuerpo mínimo para esta solicitud es una orden con el correo electrónico del pagador y el monto del pedido. - por: Body completo para uma solicitação de Transaction Intent em modo builder. O corpo mínimo para esta solicitação é um pedido com o e-mail do pagador e o valor do pedido. + eng: Complete body for a Transaction Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. + spa: Body completo para una solicitud de Transaction Intent en modo Builder. El requisito mínimo para este body es una solicitud que contenga la dirección de correo electrónico del pagador y el monto del pedido. + por: Body completo para uma requisição de Transaction Intent no modo Builder. O requisito mínimo para esse body consiste em um pedido contendo o endereço de e-mail do pagador e o valor do pedido. content: application/json: schema: type: object properties: order: - description: Order with all information to execute the transaction + description: Order containing all the essential information for the execution of a transaction. x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação + eng: Order containing all the essential information for the execution of a transaction. + spa: Orden que contiene toda la información esencial para la ejecución de una transacción. + por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object properties: amount: required: true type: string example: "50.00" - description: Total amount to be paid + description: Total amount to be paid. For example, "50.00". x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago + eng: Total amount to be paid. For example, "50.00". + spa: Monto total que se desea cobrar. Por ejemplo, "50.00". + por: Valor total a ser pago. Por exemplo, "50.00". payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: required: true type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. responses: "200": description: success @@ -117,19 +117,19 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent + description: ID of a created Transaction Intent. x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent + description: Date of creation of the transaction intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação + eng: Date of creation of the transaction intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la intención de transacción. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da intenção de transação. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string @@ -140,23 +140,23 @@ paths: spa: Estado actual de la intención de transacción por: Estado atual da transação enum: - - new--novo + - new--nova - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente - reverted--revertida - failed--falhou - - cancelled--cancelado + - cancelled--cancelada - authorized--autorizada init_point: type: string example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow + description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento + eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789. configuration: type: object description: Configuration parameters defined by the seller before starting the transaction @@ -167,11 +167,11 @@ paths: properties: option: type: object - description: Seller's configuration on options available in the transaction + description: Seller's configuration regarding the available options in the transaction. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller's configuration regarding the available options in the transaction. + spa: Configuración del seller con respecto a las opciones disponibles en la transacción. + por: Configuração do vendedor que abrange as opções disponíveis durante o processo de transação. properties: purpose: type: string From d0a95bf5f9bf9ef508daf8c51c853dd51a137100 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Fri, 11 Aug 2023 16:02:46 -0300 Subject: [PATCH 17/40] more description fixes --- reference/api/transaction_intent.yaml | 172 +++++++++++++------------- 1 file changed, 88 insertions(+), 84 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 0d8aac79ea..a2883d0505 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -175,120 +175,124 @@ paths: properties: purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Transaction purpose identifier that enables loading a list of predefined options. x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Transaction purpose identifier that enables loading a list of predefined options. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. example: wallet_purchase, onboarding_credits payment_methods: type: object properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a payment method during the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a payment method during the transaction. + spa: Los cupones se pueden utilizar como método de pago durante la transacción. + por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: type: array items: type: string example: credit_card, debit_card - description: List of Payment Types included + description: List of Payment Types included. For example, credit_card, debit_card. x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. disabled: type: array items: type: string example: "credit_card" - description: Types of payment methods not included + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: visa, master - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier. x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier. + spa: Identificador del medio de pago. + por: Identificador do meio de pagamento. example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a oferecer. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a oferecer. type: string example: "1" disabled: @@ -296,67 +300,67 @@ paths: items: type: string example: ticket, account_money - description: Methods of payment not included + description: Payment methods not included. x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. default: type: string example: "credit_card" - description: Payment method to offer by default + description: Types of payment methods to be offered by default. x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do vendedor sobre a integração. properties: notification_url: type: string description: URL to which notifications will be sent example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. return_url_default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" return_url_success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. return_url_pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. return_url_failure: - description: URL to redirect the buyer in case of failed payment + description: Redirection URL for the event of buyer payment failure. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: Redirection URL for the event of buyer payment failure. + spa: URL de redirección para el caso de fallo en el pago del comprador. + por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object description: Common Order attributes for request and response From 12b4bae6526f02fa144c27f43fc0c0cec5f01276 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Fri, 11 Aug 2023 16:25:10 -0300 Subject: [PATCH 18/40] fixes --- reference/api/transaction_intent.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 921558a49c..e7aee3610d 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -137,8 +137,8 @@ paths: description: Current status of the transaction intent x-description-i18n: eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação + spa: Status actual de la intención de transacción + por: Status atual da transação enum: - new--nova - transaction_in_process--transação em processo From 2d5ba23c6318ef200686bf2a6a0d2cd8f027d97d Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Mon, 14 Aug 2023 14:49:01 -0300 Subject: [PATCH 19/40] authorize endpoint added --- reference/api/transaction_intent.yaml | 1783 ++++++++++++++++++++++++- 1 file changed, 1782 insertions(+), 1 deletion(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index e7aee3610d..21164cdfb5 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -8199,4 +8199,1785 @@ paths: type: string enum: - 500--Unexpected Error. - - 503--Service Unavailable. \ No newline at end of file + - 503--Service Unavailable. + /v1/transaction-intents/authorize: + post: + tags: + - $ref: '#/tags/checkout-api' + summary: Authorize payments for a Transaction Intent + x-summary-i18n: + eng: Authorize payments for a Transaction Intent + spa: Autorizar pagos de una Transaction Intent + por: Autorizar pagamentos de uma Transaction Intent + description: This endpoint enables the authorization of payments for an existing Transaction Intent + x-description-i18n: + eng: This endpoint enables the authorization of payments for an existing Transaction Intent + spa: Este endpoint permite la autorización de pagos para una Transaction Intent ya existente + por: Este endpoint possibilita a autorização de pagamentos para uma Transaction Intent já existente + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + - in: header + name: X-Product-ID + schema: + type: string + example: "876542356788-mp" + required: false + description: Alphanumeric ID of the product + x-description-i18n: + eng: Alphanumeric ID of the product + spa: ID alfanumérico del producto + por: ID alfanumérico do produto + requestBody: + description: Complete body for a Transaction Intent. + x-description-i18n: + eng: Complete body for a Transaction Intent. + spa: Body completo para una solicitud. + por: Body completo para uma solicitação. + content: + application/json: + schema: + type: object + properties: + active_to_date: + type: string + description: Close processing limit for transaction intent + x-description-i18n: + eng: Close processing limit for transaction intent + spa: Fecha límite de procesamiento para la intención de transacción + por: Data limite de processamento para a intenção de transação + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + options: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + payment_methods: + required: true + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: [ "credit_card", "debit_card" ] + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: [ "visa", "master" ] + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: [ "ticket", "account_money" ] + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: [ "wallet_purchase", "onboarding_credits" ] + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: + type: object + properties: + notification_url: + type: string + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + x-description-i18n: + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system + x-description-i18n: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + description: Order with all information to execute the transaction + x-description-i18n: + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação + type: object + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + required: true + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + responses: + "202": + description: accepted + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. From 236976338f93a79df589743f5daa76e56a795bfe Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 15 Aug 2023 12:38:41 -0300 Subject: [PATCH 20/40] description improvements --- reference/api/transaction_intent.yaml | 736 +++++++++++++------------- 1 file changed, 368 insertions(+), 368 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 21164cdfb5..d26daa0566 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -26,11 +26,11 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application's private key must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Access Token - Application's private key must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. - spa: Access Token - Clave privada de la aplicación debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. - por: Acess Token - Chave privada do aplicativo deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Acess Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: header name: X-Product-ID schema: @@ -372,69 +372,69 @@ paths: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" - description: Reference of the order + description: Reference of the order. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. description: type: string example: "my_order_description" - description: description for the order or transaction + description: description for the order or transaction. x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Description for the order or transaction. + spa: Descripción de la orden o transacción. + por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction + description: Total value of the transaction. For example, "233.00". x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação + eng: Total value of the transaction. For example, "233.00". + spa: Monto total de la transacción. Por ejemplo, "233.00". + por: Valor total da transação. Por exemplo, "233.00". items: type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos no pedido. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos no pedido. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit price of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -446,137 +446,137 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. + por: Descrição dos itens que constituem a lista de produtos incluídos no pedido. collectors: type: object - description: Seller user who receives the payment + description: Seller user who receives the payment. x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento + eng: Seller user who receives the payment. + spa: Usuario vendedor que recibe el pago. + por: Usuário vendedor que recebe o pagamento. properties: collector_id: type: number example: 123456789 - description: Collector identifier + description: Collector identifier. x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector + eng: Collector identifier. + spa: ID del collector. + por: Identificador do collector. amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector + description: Amount of the transaction corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector + eng: Amount of the transaction corresponding to the collector. + spa: Monto de la transacción que corresponde al collector. + por: Valor da transação correspondente ao collector. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the documento. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" description: Street name x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip covered. + spa: Código postal. + por: Código postal. phone: type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. properties: area_code: type: string @@ -586,63 +586,63 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. + spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. + por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: type: object properties: total: type: string example: "123.00" - description: Details of the total value of the transaction + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. paid: type: string example: "100.00" - description: Total paid + description: Total paid. x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. refunded: type: string example: "100.00" - description: Total value refunded + description: Total value refunded. x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. shipment: type: string example: "10.00" - description: Total value charged per shipment + description: Total value charged per shipment. x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) + eng: Total value charged per shipment. + spa: Monto cobrado por envío (incluido en total). + por: Valor cobrado por envio (incluído no total). payment_method: properties: credit_cards: @@ -652,115 +652,115 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 12345432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refunded. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Estado del pago. + por: Estado do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payments. + spa: Información sobre el resultado del procesamiento. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Status code. + spa: Código del estado del pago. + por: Código do Estado do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Status message. + spa: Mensaje del estado del pagos. + por: Mensagem do status do Pagamento. debit_cards: type: array items: @@ -768,107 +768,107 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 1234565432 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Estado del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el resultado del procesamiento. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" description: Status code x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Status code. + spa: Código del estado del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" description: Status message x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Status message. + spa: Mensaje del estado del pago. + por: Mensagem do status do Pagamento. tickets: type: array items: @@ -876,90 +876,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 1234567654 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Estado del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el resultado del procesamiento. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Refund amount. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Refund amount. + spa: Monto del reembolso. + por: Valor do reembolso. atms: type: array items: @@ -968,90 +968,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 12345432423 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al método de pago utilizado. + por: Identificação de pagamento associada ao método de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Payment status. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Payment status. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Refund amount. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Refund amount. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el resultado del procesamiento. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. bank_transfers: type: array items: @@ -1060,90 +1060,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 23421234543 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al método de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Payment status. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Payment status. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. por: Informações detalhadas sobre o status do pagamento properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. "400": description: Error x-description-i18n: From e211a892ef68210e43fd1d057cc894132cb406ca Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 15 Aug 2023 15:31:59 -0300 Subject: [PATCH 21/40] parameteres improvements --- reference/api/transaction_intent.yaml | 53 ++++++++++++++++++--------- 1 file changed, 36 insertions(+), 17 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index d26daa0566..1f01e00312 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -183,6 +183,11 @@ paths: example: wallet_purchase, onboarding_credits payment_methods: type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: description: Coupons can be used as a payment method during the transaction. @@ -218,24 +223,24 @@ paths: properties: enabled: type: array + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. items: type: string example: credit_card, debit_card - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. disabled: + example: "credit_card" + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string - example: "credit_card" - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". methods: type: object description: Configuration by specific payment method. @@ -580,9 +585,19 @@ paths: properties: area_code: type: string + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. example: "11" number: type: string + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. example: "99999999" advanced: type: object @@ -1359,7 +1374,11 @@ paths: enabled: type: array example: visa, master - description: Payment methods included + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos items: type: object properties: @@ -1405,14 +1424,14 @@ paths: example: "1" disabled: type: array + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. items: type: string example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" From a0dd115420c5b09bc48c8f7258507fb653452d23 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 15 Aug 2023 15:52:24 -0300 Subject: [PATCH 22/40] divided api files --- reference/api/transaction_intent.yaml | 6442 +++------------------- reference/api/transaction_intent_id.yaml | 5185 +++++++++++++++++ 2 files changed, 5815 insertions(+), 5812 deletions(-) create mode 100644 reference/api/transaction_intent_id.yaml diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 1f01e00312..82660d416e 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -1196,20 +1196,20 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. - /v1/transaction-intents/{id}: - get: + /v1/transaction-intents/process: + post: tags: - - $ref: "#/tags/checkout-api" - summary: Get transaction intent by ID + - $ref: '#/tags/checkout-api' + summary: Create and Process a new Transaction Intent x-summary-i18n: - eng: Get transaction intent by ID - spa: Obtener transaction intent por ID - por: Obter transaction intent por ID - description: Consult by ID retrieves an existing Transaction Intent + eng: Create and Process a new Transaction Intent + spa: Crear y procesar una nueva Transaction Intent + por: Criar e processar nova Transaction Intent + description: This endppoint allows you to creates and process a new Transaction Intent x-description-i18n: - eng: Consult by ID retrieves an existing Transaction Intent - spa: Consultar por ID recupera una Transaction Intent existente - por: Consultar por ID recupera uma Transaction Intent existente + eng: This endppoint allows you to creates and rocess a new Transaction Intent + spa: Este endpoint permite crear y procesar una nueva Transaction Intent + por: Este endpoint permite criar e processar uma nova Transaction Intent parameters: - in: header name: Authorization @@ -1222,243 +1222,229 @@ paths: eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - - name: id - in: path - required: true + - in: header + name: X-Product-ID schema: type: string - example: "00001njp2i" - description: Transaction Intent's Id - x-description-i18n: - eng: Transaction Intent's Id - spa: ID de la Transaction Intent - por: ID da Transaction Intent - responses: - "200": - description: success - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: "00001njp2i" - description: ID of a created Transaction Intent - x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada - created_date: - type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent - x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação - format: date-time - status: - type: string - example: "authorized" - description: Current status of the transaction intent - x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação - enum: - - new--novo - - transaction_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelado - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow - x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - option: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number + example: "876542356788-mp" + required: false + description: Alphanumeric ID of the product + x-description-i18n: + eng: Alphanumeric ID of the product + spa: ID alfanumérico del producto + por: ID alfanumérico do produto + - in: header + name: X-Platform-ID + schema: + type: string + required: false + description: Alphanumeric ID of the platform + x-description-i18n: + eng: Alphanumeric ID of the platform + spa: ID alfanumérico de la plataforma + por: ID alfanumérico da plataforma + - in: header + name: X-Integrator-ID + schema: + type: string + required: false + description: Alphanumeric ID of the integrator + x-description-i18n: + eng: Alphanumeric ID of the integrator + spa: ID alfanumérico del integrador + por: ID alfanumérico do integrador + requestBody: + description: Complete body for a Transaction Intent. + x-description-i18n: + eng: Complete body for a Transaction Intent. + spa: Body completo para una solicitud. + por: Body completo para uma solicitação. + content: + application/json: + schema: + type: object + properties: + active_to_date: + type: string + description: Close processing limit for transaction intent + x-description-i18n: + eng: Close processing limit for transaction intent + spa: Fecha límite de procesamiento para la intención de transacción + por: Data limite de processamento para a intenção de transação + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + options: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + payment_methods: + required: true + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: [ "credit_card", "debit_card" ] + description: List of Payment Types included x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: type: string - example: "100.00" - description: Total value of coupon + example: "credit_card" + description: Types of payment methods not included x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento - properties: - enabled: - type: array - example: visa, master - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - items: - type: object - properties: - id: - type: string - description: Payment method identifier - x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento - example: "credit_card" - installments: - type: object - description: Configuration of the number of installments to offer for the payment method - x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento - properties: - default: - description: Default number of installments to offer - x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão - type: string - example: "3" - max: - description: Maximum number of installments to offer - x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer - type: string - example: "6" - min: - description: Minimum number of installments to offer - x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer - type: string - example: "1" - disabled: - type: array - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - items: - type: string - example: ticket, account_money - default: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: [ "visa", "master" ] + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: type: string - example: "credit_card" - description: Payment method to offer by default + example: [ "ticket", "account_money" ] + description: Methods of payment not included x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - integration: - type: object - description: Configuration of the seller on integration - x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração - properties: - notifications: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: [ "wallet_purchase", "onboarding_credits" ] + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: type: object properties: notification_url: type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" return_url: type: object description: Status URLs available to redirect buyer after completion of payment attempt @@ -1499,5655 +1485,487 @@ paths: eng: URL to redirect the buyer in case of failed payment spa: URL a la cual se redireccionará al comprador en caso de pago fallido por: URL para redirecionar o comprador em caso de pagamento falhou - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system - x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador - order: - type: object - description: Common Order attributes for request and response - x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - reason: - type: string - example: "my_order_description" - description: Reason for the order or transaction - x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - example: "233.00" - type: string - description: Total value of the transaction - x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação - items: - type: array - items: - type: object - description: List of items included in the order + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - collectors: - type: object - description: Seller user who receives the payment - x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier - x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector - amount: - type: string - example: "50.00" - description: Amount of the transaction corresponding to the collector - x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + description: Order with all information to execute the transaction + x-description-i18n: + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação + type: object + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: + type: array + items: type: object - description: Type and number of legal document that identifies the person in the country + description: List of items included in the order x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + id: type: string - example: "12345678098" - type: - description: Type of the document + example: "x76ax" + description: Item identification code x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name - x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: - type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: type: string - example: "100" - description: Street number + example: "100.00" + description: Unit price of the item x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: type: string - example: "57000-865" - description: Zip code + example: "30x30x30" + description: Dimensions of the item - length x width x height. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - marketplace: - type: object - description: Marketplace settings - x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector - properties: - fee: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: type: string - example: "5" - description: Percentage of commission charged to the collector + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - amount_details: - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the transaction - x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação - paid: - type: string - example: "100.00" - description: Total paid - x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago - refunded: - type: string - example: "100.00" - description: Total value refunded - x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado - shipment: - type: string - example: "10.00" - description: Total value charged per shipment - x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 1234567654 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. - "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 500--Unexpected Error. - - 503--Service Unavailable. - patch: - tags: - - $ref: '#/tags/checkout-api' - summary: Modify Transaction Intent - x-summary-i18n: - eng: Modify Transaction Intent - spa: Modificar Transaction Intent - por: Modificar Transaction Intent - description: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It iss important to note that it is not necessary to send all fields filled, only those you want to modify or add - x-description-i18n: - eng: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It is important to note that it is not necessary to send all fields filled, only those you want to modify or add - spa: Este endpoint permite la modificación de una Transaction Intent creada en el modo Builder. Utilizando el ID de la Transaction Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos, solo aquellos que desea modificar o agregar - por: Este endpoint possibilita a modificação de uma Transaction Intent criada no modo Builder. Utilizando o ID da Transaction Intent, é possível realizar edições por meio do endpoint PATCH. Isso permite a alteração ou adição de campos no corpo da intenção antes de seu processamento. É importante observar que não é obrigatório enviar todos os campos preenchidos, apenas aqueles que você deseja modificar ou acrescentar - parameters: - - in: header - name: Authorization - schema: - type: string - example: "Bearer token-89987654567f-numeroToken" - required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - - name: id - in: path - required: true - schema: - type: string - example: "00001njp2i" - description: Transaction Intent's Id - x-description-i18n: - eng: Transaction Intent's Id - spa: ID de la Transaction Intent - por: ID da Transaction Intent - requestBody: - description: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. - x-description-i18n: - eng: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. - spa: Cuerpo completo de una TI, que se puede cambiar. No es necesario enviar todos los campos completados, solo aquellos que desee modificar o incluir. - por: Corpo completo de uma TI, que pode ser alteradado. Não é necessário enviar todos os campos preenchidos, somente aqueles que deseja alterar ou incluir. - content: - application/json: - schema: - type: object - properties: - active_to_date: - type: string - description: Close processing limit for transaction intent - x-description-i18n: - eng: Close processing limit for transaction intent - spa: Fecha límite de procesamiento para la intención de transacción - por: Data limite de processamento para a intenção de transação - format: date-time - example: "2023-09-06T10:00:00.000-03:00" - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - options: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - payment_methods: - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: [ "credit_card", "debit_card" ] - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento - properties: - enabled: - type: array - example: [ "visa", "master" ] - description: Payment methods included - items: - type: object - properties: - id: - type: string - description: Payment method identifier - x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento - example: "credit_card" - installments: - type: object - description: Configuration of the number of installments to offer for the payment method - x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento - properties: - default: - description: Default number of installments to offer - x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão - type: string - example: "3" - max: - description: Maximum number of installments to offer - x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer - type: string - example: "6" - min: - description: Minimum number of installments to offer - x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer - type: string - example: "1" - disabled: - type: array - items: - type: string - example: [ "ticket", "account_money" ] - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: [ "wallet_purchase", "onboarding_credits" ] - integration: - type: object - description: Configuration of the seller on integration - x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração - properties: - notifications: - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento - properties: - default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system - x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador - order: - description: Order with all information to execute the transaction - x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação - type: object - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - reason: - type: string - example: "my_order_description" - description: Reason for the order or transaction - x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - required: true - type: string - example: "50.00" - description: Total amount to be paid - x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago - items: - type: array - items: - type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - required: true - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country - x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name - x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: - type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name - x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: - type: string - example: "100" - description: Street number - x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code - x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - marketplace: - type: object - description: Marketplace settings - x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector - properties: - fee: - type: string - example: "5" - description: Percentage of commission charged to the collector - x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - responses: - "200": - description: success - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: "00001njp2i" - description: ID of a created Transaction Intent - x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada - created_date: - type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent - x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação - format: date-time - status: - type: string - example: "authorized" - description: Current status of the transaction intent - x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação - enum: - - new--novo - - transaction_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelado - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow - x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - option: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento - properties: - enabled: - type: array - example: visa, master - description: Payment methods included - items: - type: object - properties: - id: - type: string - description: Payment method identifier - x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento - example: "credit_card" - installments: - type: object - description: Configuration of the number of installments to offer for the payment method - x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento - properties: - default: - description: Default number of installments to offer - x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão - type: string - example: "3" - max: - description: Maximum number of installments to offer - x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer - type: string - example: "6" - min: - description: Minimum number of installments to offer - x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer - type: string - example: "1" - disabled: - type: array - items: - type: string - example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - integration: - type: object - description: Configuration of the seller on integration - x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração - properties: - notification_url: - type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas - return_url_default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - return_url_pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - return_url_failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou - order: - type: object - description: Common Order attributes for request and response - x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - description: - type: string - example: "my_order_description" - description: description for the order or transaction - x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - example: "233.00" - type: string - description: Total value of the transaction - x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação - items: - type: array - items: - type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - collectors: - type: object - description: Seller user who receives the payment - x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier - x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector - amount: - type: string - example: "50.00" - description: Amount of the transaction corresponding to the collector - x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country - x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name - x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: - type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name - x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: - type: string - example: "100" - description: Street number - x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code - x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - amount_details: - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the transaction - x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação - paid: - type: string - example: "100.00" - description: Total paid - x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago - refunded: - type: string - example: "100.00" - description: Total value refunded - x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado - shipment: - type: string - example: "10.00" - description: Total value charged per shipment - x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 1234567654 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. - "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 500--Unexpected Error. - - 503--Service Unavailable. - /v1/transaction-intents/process: - post: - tags: - - $ref: '#/tags/checkout-api' - summary: Create and Process a new Transaction Intent - x-summary-i18n: - eng: Create and Process a new Transaction Intent - spa: Crear y procesar una nueva Transaction Intent - por: Criar e processar nova Transaction Intent - description: This endppoint allows you to creates and process a new Transaction Intent - x-description-i18n: - eng: This endppoint allows you to creates and rocess a new Transaction Intent - spa: Este endpoint permite crear y procesar una nueva Transaction Intent - por: Este endpoint permite criar e processar uma nova Transaction Intent - parameters: - - in: header - name: Authorization - schema: - type: string - example: "Bearer token-89987654567f-numeroToken" - required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - - in: header - name: X-Product-ID - schema: - type: string - example: "876542356788-mp" - required: false - description: Alphanumeric ID of the product - x-description-i18n: - eng: Alphanumeric ID of the product - spa: ID alfanumérico del producto - por: ID alfanumérico do produto - - in: header - name: X-Platform-ID - schema: - type: string - required: false - description: Alphanumeric ID of the platform - x-description-i18n: - eng: Alphanumeric ID of the platform - spa: ID alfanumérico de la plataforma - por: ID alfanumérico da plataforma - - in: header - name: X-Integrator-ID - schema: - type: string - required: false - description: Alphanumeric ID of the integrator - x-description-i18n: - eng: Alphanumeric ID of the integrator - spa: ID alfanumérico del integrador - por: ID alfanumérico do integrador - requestBody: - description: Complete body for a Transaction Intent. - x-description-i18n: - eng: Complete body for a Transaction Intent. - spa: Body completo para una solicitud. - por: Body completo para uma solicitação. - content: - application/json: - schema: - type: object - properties: - active_to_date: - type: string - description: Close processing limit for transaction intent - x-description-i18n: - eng: Close processing limit for transaction intent - spa: Fecha límite de procesamiento para la intención de transacción - por: Data limite de processamento para a intenção de transação - format: date-time - example: "2023-09-06T10:00:00.000-03:00" - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - options: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - payment_methods: - required: true - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: [ "credit_card", "debit_card" ] - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento - properties: - enabled: - type: array - example: [ "visa", "master" ] - description: Payment methods included - items: - type: object - properties: - id: - type: string - description: Payment method identifier - x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento - example: "credit_card" - installments: - type: object - description: Configuration of the number of installments to offer for the payment method - x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento - properties: - default: - description: Default number of installments to offer - x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão - type: string - example: "3" - max: - description: Maximum number of installments to offer - x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer - type: string - example: "6" - min: - description: Minimum number of installments to offer - x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer - type: string - example: "1" - disabled: - type: array - items: - type: string - example: [ "ticket", "account_money" ] - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: [ "wallet_purchase", "onboarding_credits" ] - integration: - type: object - description: Configuration of the seller on integration - x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração - properties: - notifications: - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento - properties: - default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system - x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador - order: - description: Order with all information to execute the transaction - x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação - type: object - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - reason: - type: string - example: "my_order_description" - description: Reason for the order or transaction - x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - required: true - type: string - example: "50.00" - description: Total amount to be paid - x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago - items: - type: array - items: - type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - required: true - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country - x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name - x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: - type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name - x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: - type: string - example: "100" - description: Street number - x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code - x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - marketplace: - type: object - description: Marketplace settings - x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector - properties: - fee: - type: string - example: "5" - description: Percentage of commission charged to the collector - x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - responses: - "200": - description: success - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: "00001njp2i" - description: ID of a created Transaction Intent - x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada - created_date: - type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent - x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação - format: date-time - status: - type: string - example: "authorized" - description: Current status of the transaction intent - x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação - enum: - - new--novo - - transaction_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelado - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow - x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - option: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento - properties: - enabled: - type: array - example: visa, master - description: Payment methods included - items: - type: object - properties: - id: - type: string - description: Payment method identifier - x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento - example: "credit_card" - installments: - type: object - description: Configuration of the number of installments to offer for the payment method - x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento - properties: - default: - description: Default number of installments to offer - x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão - type: string - example: "3" - max: - description: Maximum number of installments to offer - x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer - type: string - example: "6" - min: - description: Minimum number of installments to offer - x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer - type: string - example: "1" - disabled: - type: array - items: - type: string - example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - integration: - type: object - description: Configuration of the seller on integration - x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração - properties: - notification_url: - type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas - return_url_default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - return_url_pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - return_url_failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou - order: - type: object - description: Common Order attributes for request and response - x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - description: - type: string - example: "my_order_description" - description: description for the order or transaction - x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - example: "233.00" - type: string - description: Total value of the transaction - x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação - items: - type: array - items: - type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido - properties: - id: - type: string - example: "x76ax" - description: Item identification code - x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: - type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item - x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items - x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - collectors: - type: object - description: Seller user who receives the payment - x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier - x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector - amount: - type: string - example: "50.00" - description: Amount of the transaction corresponding to the collector - x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country - x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name - x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: - type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name - x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: - type: string - example: "100" - description: Street number - x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code - x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - amount_details: - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the transaction - x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação - paid: - type: string - example: "100.00" - description: Total paid - x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago - refunded: - type: string - example: "100.00" - description: Total value refunded - x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado - shipment: - type: string - example: "10.00" - description: Total value charged per shipment - x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 1234567654 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string - example: "50.00" - description: Amount of the refund - x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: - type: string - example: "400" - description: Status code - x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message - x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. - "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 500--Unexpected Error. - - 503--Service Unavailable. - /v1/transaction-intents/{id}/cancel: - put: - tags: - - $ref: '#/tags/checkout-api' - summary: Cancel a Transaction Intent - x-summary-i18n: - eng: Cancel a Transaction Intent - spa: Cancelar una Transaction Intent - por: Cancelar Transaction Intent - description: This endpoint allows to cancel a Transaction Intent - x-description-i18n: - eng: This endpoint allows to cancel a Transaction Intent - spa: Este endpoint permite cancelar una Transaction Intent - por: Este endpoint permite cancelar uma Transaction Intent - parameters: - - in: header - name: Authorization - schema: - type: string - example: "Bearer token-89987654567f-numeroToken" - required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - - in: path - name: id - schema: - type: string - required: true - required: true - description: Alphanumeric ID of the Transaction Intent to get - x-description-i18n: - eng: Alphanumeric ID of the Transaction Intent to get - spa: ID alfanumérico de la Transaction Intent a obtener - por: ID alfanumérico da Transaction Intent a ser obtida - responses: - "200": - description: success - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: "00001njp2i" - description: ID of a created Transaction Intent - x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada - created_date: - type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent - x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação - format: date-time - status: - type: string - example: "authorized" - description: Current status of the transaction intent - x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação - enum: - - new--novo - - transaction_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelado - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow - x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento - configuration: - type: object - description: Configuration parameters defined by the seller before starting the transaction - x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação - properties: - option: - type: object - description: Seller's configuration on options available in the transaction - x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação - properties: - purpose: - type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options - x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - types: - type: object - description: Configuration by payment method type - x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento - properties: - enabled: - type: array - items: - type: string - example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos - disabled: - type: array - items: - type: string - example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos - methods: - type: object - description: Configuration by specific payment method - x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento - properties: - enabled: - type: array - example: visa, master - description: Payment methods included - items: - type: object - properties: - id: - type: string - description: Payment method identifier - x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento - example: "credit_card" - installments: - type: object - description: Configuration of the number of installments to offer for the payment method - x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento - properties: - default: - description: Default number of installments to offer - x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão - type: string - example: "3" - max: - description: Maximum number of installments to offer - x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer - type: string - example: "6" - min: - description: Minimum number of installments to offer - x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer - type: string - example: "1" - disabled: - type: array - items: - type: string - example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - integration: - type: object - description: Configuration of the seller on integration - x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração - properties: - notification_url: - type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas - return_url_default: - description: Default URL to redirect the buyer - x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido - return_url_pending: - description: URL to redirect the buyer in case of pending payment - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente - return_url_failure: - description: URL to redirect the buyer in case of failed payment - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou - order: - type: object - description: Common Order attributes for request and response - x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador - description: - type: string - example: "my_order_description" - description: description for the order or transaction - x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação - amount: - example: "233.00" - type: string - description: Total value of the transaction - x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação - items: - type: array - items: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: type: object - description: List of items included in the order + description: Buyer's information x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador properties: - id: + email: + required: true type: string - example: "x76ax" - description: Item identification code + description: Buyer's email x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item - quantity: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: type: number - example: 4 - description: Number of item included in the order - x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido - unit_price: - type: string - example: "100.00" - description: Unit price of the item + example: 123456 + description: ID of the Customer saved previously x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item - dimensions: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. + example: "John" + description: Buyer's name x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + example: "Doe" + description: Buyer's surname x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido - collectors: - type: object - description: Seller user who receives the payment - x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier - x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector - amount: - type: string - example: "50.00" - description: Amount of the transaction corresponding to the collector - x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector - payer: - type: object - description: Buyer's information - x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador - properties: - email: - type: string - description: Buyer's email - x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador - customer_id: - type: number - example: 123456 - description: ID of the Customer saved previously - x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente - identification: - type: object - description: Type and number of legal document that identifies the person in the country - x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país - properties: - number: - description: Number of the document - x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento - type: string - example: "12345678098" - type: - description: Type of the document - x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name - x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador - surname: - type: string - example: "Doe" - description: Buyer's surname - x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador - address: - type: object - description: Address of the buyer - x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name - x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua - street_number: - type: string - example: "100" - description: Street number - x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa - zip_code: - type: string - example: "57000-865" - description: Zip code - x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number - x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced transaction - x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação - properties: - binary_mode: - type: boolean - example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account that will pay the fees - x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - amount_details: - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the transaction - x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação - paid: - type: string - example: "100.00" - description: Total paid - x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago - refunded: - type: string - example: "100.00" - description: Total value refunded - x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado - shipment: - type: string - example: "10.00" - description: Total value charged per shipment - x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) - payment_method: - properties: - credit_cards: - type: array - items: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador properties: - amount: + street_name: type: string - example: "50.00" - description: Total amount to be paid with this payment method + example: "Street MercadoLivre" + description: Street name x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method + example: "100" + description: Street number x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: type: string - example: "visa" - description: Identifier of the chosen payment method + example: "57000-865" + description: Zip code x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: + example: "11" + number: type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: + amount: type: string example: "50.00" - description: Amount of the refund + description: Total amount to be paid with this payment method x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: type: string - example: "400" - description: Status code + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: type: string - example: "acquirer rejected" - description: Status message + example: "visa" + description: Identifier of the chosen payment method x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: type: number - example: 123456789 - description: ID of the refund + description: Quantity of installments x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: type: string - example: "50.00" - description: Amount of the refund + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: properties: - code: + amount: type: string - example: "400" - description: Status code + example: "50.00" + description: Total amount to be paid with this payment method x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: type: string - example: "acquirer rejected" - description: Status message + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 1234567654 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: type: string - example: "400" - description: Status code + example: "debvisa" + description: Identifier of the chosen payment method x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: type: string - example: "acquirer rejected" - description: Status message + example: "23" + description: In case it is required, identifier of the card issuer entity x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: type: string example: "50.00" - description: Amount of the refund + description: Total amount to be paid with this payment method x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: type: object properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: + amount: type: string example: "50.00" - description: Amount of the refund + description: Total amount to be paid with this payment method x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: type: string - example: "400" - description: Status code + example: "bapropagos" + description: Identifier of the chosen payment method x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method - x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento - status: - type: string - example: "pending" - description: Status of the payment - x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento - completion_url: - type: string - description: For offline payments, URL that allows you to continue the payment flow - x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento - refunds: - description: List of refunds related to the payment method - x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: type: object properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund - x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: + amount: type: string example: "50.00" - description: Amount of the refund + description: Total amount to be paid with this payment method x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso - status_detail: - type: object - description: Detail information about the status of the payment - x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: type: string - example: "400" - description: Status code + example: "banco_mp" + description: Identifier of the chosen payment method x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento - message: - type: string - example: "acquirer rejected" - description: Status message + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento - "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. - "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 500--Unexpected Error. - - 503--Service Unavailable. - /v1/transaction-intents/{id}/refund: - put: - tags: - - $ref: '#/tags/checkout-api' - summary: Refund Transaction Intent - x-summary-i18n: - eng: Refund Transaction Intent - spa: Reembolsar Transaction Intent - por: Reembolsar Transaction Intent - description: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint - x-description-i18n: - eng: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint - spa: Si una Transaction intent es procesada correctamente y el cliente desea realizar una cancelación, será posible efectuar un reembolso a través de este endpoint - por: Caso uma Transaction Intent seja devidamente processada e o cliente desejar efetuar um cancelamento, será possível efetuar um reembolso por meio deste endpoint - parameters: - - in: header - name: Authorization - schema: - type: string - example: "Bearer token-89987654567f-numeroToken" - required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - - in: path - name: id - schema: - type: string - required: true - required: true - description: Alphanumeric ID of the Transaction Intent to get - x-description-i18n: - eng: Alphanumeric ID of the Transaction Intent to get - spa: ID alfanumérico de la Transaction Intent a obtener - por: ID alfanumérico da Transaction Intent a ser obtida + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom responses: "200": description: success @@ -7175,7 +1993,7 @@ paths: format: date-time status: type: string - example: "reverted" + example: "authorized" description: Current status of the transaction intent x-description-i18n: eng: Current status of the transaction intent @@ -7769,7 +2587,7 @@ paths: por: Valor do reembolso status: type: string - example: "refunded" + example: "pending" description: Status of the payment x-description-i18n: eng: Status of the payment diff --git a/reference/api/transaction_intent_id.yaml b/reference/api/transaction_intent_id.yaml new file mode 100644 index 0000000000..293e97c0fd --- /dev/null +++ b/reference/api/transaction_intent_id.yaml @@ -0,0 +1,5185 @@ +openapi: 3.0.0 +servers: + - url: https://api.mercadopago.com +info: + title: Mercado Pago API Reference + version: '1.0' +paths: + /v1/transaction-intents/{id}: + get: + tags: + - $ref: "#/tags/checkout-api" + summary: Get transaction intent by ID + x-summary-i18n: + eng: Get transaction intent by ID + spa: Obtener transaction intent por ID + por: Obter transaction intent por ID + description: Consult by ID retrieves an existing Transaction Intent + x-description-i18n: + eng: Consult by ID retrieves an existing Transaction Intent + spa: Consultar por ID recupera una Transaction Intent existente + por: Consultar por ID recupera uma Transaction Intent existente + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + - name: id + in: path + required: true + schema: + type: string + example: "00001njp2i" + description: Transaction Intent's Id + x-description-i18n: + eng: Transaction Intent's Id + spa: ID de la Transaction Intent + por: ID da Transaction Intent + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: + type: object + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system + x-description-i18n: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. + patch: + tags: + - $ref: '#/tags/checkout-api' + summary: Modify Transaction Intent + x-summary-i18n: + eng: Modify Transaction Intent + spa: Modificar Transaction Intent + por: Modificar Transaction Intent + description: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It iss important to note that it is not necessary to send all fields filled, only those you want to modify or add + x-description-i18n: + eng: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It is important to note that it is not necessary to send all fields filled, only those you want to modify or add + spa: Este endpoint permite la modificación de una Transaction Intent creada en el modo Builder. Utilizando el ID de la Transaction Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos, solo aquellos que desea modificar o agregar + por: Este endpoint possibilita a modificação de uma Transaction Intent criada no modo Builder. Utilizando o ID da Transaction Intent, é possível realizar edições por meio do endpoint PATCH. Isso permite a alteração ou adição de campos no corpo da intenção antes de seu processamento. É importante observar que não é obrigatório enviar todos os campos preenchidos, apenas aqueles que você deseja modificar ou acrescentar + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + - name: id + in: path + required: true + schema: + type: string + example: "00001njp2i" + description: Transaction Intent's Id + x-description-i18n: + eng: Transaction Intent's Id + spa: ID de la Transaction Intent + por: ID da Transaction Intent + requestBody: + description: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. + x-description-i18n: + eng: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. + spa: Cuerpo completo de una TI, que se puede cambiar. No es necesario enviar todos los campos completados, solo aquellos que desee modificar o incluir. + por: Corpo completo de uma TI, que pode ser alteradado. Não é necessário enviar todos os campos preenchidos, somente aqueles que deseja alterar ou incluir. + content: + application/json: + schema: + type: object + properties: + active_to_date: + type: string + description: Close processing limit for transaction intent + x-description-i18n: + eng: Close processing limit for transaction intent + spa: Fecha límite de procesamiento para la intención de transacción + por: Data limite de processamento para a intenção de transação + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + options: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: [ "credit_card", "debit_card" ] + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: [ "visa", "master" ] + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: [ "ticket", "account_money" ] + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: [ "wallet_purchase", "onboarding_credits" ] + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notifications: + type: object + properties: + notification_url: + type: string + description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + x-description-i18n: + eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + example: "https://www.integrator-site.com/api/notifications" + return_url: + type: object + description: Status URLs available to redirect buyer after completion of payment attempt + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + properties: + default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + integrator_id: + type: number + example: 34567 + description: Seller's identifier in the integrator's system + x-description-i18n: + eng: Seller's identifier in the integrator's system + spa: Identificador del seller en el sistema del integrador + por: Identificador do vendedor no sistema do integrador + order: + description: Order with all information to execute the transaction + x-description-i18n: + eng: Order with all information to execute the transaction + spa: Orden con toda la información necesaria para poder ejecutar la transacción + por: Ordem com todas as informações necessárias para executar uma transação + type: object + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + reason: + type: string + example: "my_order_description" + description: Reason for the order or transaction + x-description-i18n: + eng: Reason for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + required: true + type: string + example: "50.00" + description: Total amount to be paid + x-description-i18n: + eng: Total amount to be paid + spa: Monto total que se desea cobrar + por: Valor total a ser pago + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + required: true + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + marketplace: + type: object + description: Marketplace settings + x-description-i18n: + eng: Marketplace settings + spa: En caso de integración tipo Marketplace, configuración que aplica al collector + por: Configurações de Marketplace que se aplicam ao collector + properties: + fee: + type: string + example: "5" + description: Percentage of commission charged to the collector + x-description-i18n: + eng: Percentage of commission charged to the collector + spa: Comisión del monto asignado al collector que le corresponde al Marketplace + por: Porcentagem da comissão cobrada ao collector + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. + /v1/transaction-intents/{id}/cancel: + put: + tags: + - $ref: '#/tags/checkout-api' + summary: Cancel a Transaction Intent + x-summary-i18n: + eng: Cancel a Transaction Intent + spa: Cancelar una Transaction Intent + por: Cancelar Transaction Intent + description: This endpoint allows to cancel a Transaction Intent + x-description-i18n: + eng: This endpoint allows to cancel a Transaction Intent + spa: Este endpoint permite cancelar una Transaction Intent + por: Este endpoint permite cancelar uma Transaction Intent + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + - in: path + name: id + schema: + type: string + required: true + required: true + description: Alphanumeric ID of the Transaction Intent to get + x-description-i18n: + eng: Alphanumeric ID of the Transaction Intent to get + spa: ID alfanumérico de la Transaction Intent a obtener + por: ID alfanumérico da Transaction Intent a ser obtida + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "authorized" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. + /v1/transaction-intents/{id}/refund: + put: + tags: + - $ref: '#/tags/checkout-api' + summary: Refund Transaction Intent + x-summary-i18n: + eng: Refund Transaction Intent + spa: Reembolsar Transaction Intent + por: Reembolsar Transaction Intent + description: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint + x-description-i18n: + eng: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint + spa: Si una Transaction intent es procesada correctamente y el cliente desea realizar una cancelación, será posible efectuar un reembolso a través de este endpoint + por: Caso uma Transaction Intent seja devidamente processada e o cliente desejar efetuar um cancelamento, será possível efetuar um reembolso por meio deste endpoint + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer token-89987654567f-numeroToken" + required: true + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + x-description-i18n: + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + - in: path + name: id + schema: + type: string + required: true + required: true + description: Alphanumeric ID of the Transaction Intent to get + x-description-i18n: + eng: Alphanumeric ID of the Transaction Intent to get + spa: ID alfanumérico de la Transaction Intent a obtener + por: ID alfanumérico da Transaction Intent a ser obtida + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Transaction Intent + x-description-i18n: + eng: ID of a created Transaction Intent + spa: ID de la intención de transacción creada + por: ID da intenção de transação criada + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the transaction intent + x-description-i18n: + eng: Date of creation of the transaction intent + spa: Fecha de creación de la intención de transacción + por: Data de criação da intenção de transação + format: date-time + status: + type: string + example: "reverted" + description: Current status of the transaction intent + x-description-i18n: + eng: Current status of the transaction intent + spa: Estado actual de la intención de transacción + por: Estado atual da transação + enum: + - new--novo + - transaction_in_process--transação em processo + - partially_processed--parcialmente processada + - processed--processada + - partially_reverted--revertida parcialmente + - reverted--revertida + - failed--falhou + - cancelled--cancelado + - authorized--autorizada + init_point: + type: string + example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" + description: URL that allows you to start the payment flow + x-description-i18n: + eng: URL that allows you to start the payment flow + spa: URL que permite iniciar el flujo de pago + por: URL que permite iniciar o fluxo de pagamento + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + option: + type: object + description: Seller's configuration on options available in the transaction + x-description-i18n: + eng: Seller's configuration on options available in the transaction + spa: Configuración del seller sobre opciones disponibles en la transacción + por: Configuração do vendedor sobre opções disponíveis na transação + properties: + purpose: + type: string + description: Identifier of the purpose of the transaction, which allows load a predefined list of options + x-description-i18n: + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + example: wallet_purchase, onboarding_credits + payment_methods: + type: object + properties: + coupons: + description: Coupons can be used as a methods of payment in the transaction + x-description-i18n: + eng: Coupons can be used as a methods of payment in the transaction + spa: Los cupones pueden ser utilizados como medio de pago en la transacción + por: Os cupons podem ser utilizados como meio de pagamento na transação + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Campaign identifier number + x-description-i18n: + eng: Campaign identifier number + spa: Número identificador de la campaña + por: Número identificador da campanha a qual o cupom está vinculadop + amount: + type: string + example: "100.00" + description: Total value of coupon + x-description-i18n: + eng: Total value of coupon + spa: Valor total del cupón + por: Valor total do cupom + types: + type: object + description: Configuration by payment method type + x-description-i18n: + eng: Configuration by payment method type + spa: Configuración por tipo de medio de pago + por: Configuração por tipo de meio de pagamento + properties: + enabled: + type: array + items: + type: string + example: credit_card, debit_card + description: List of Payment Types included + x-description-i18n: + eng: List of Payment Types included + spa: Lista de tipos de medios de pago incluidos + por: Lista de tipos de meios de pagamento incluídos + disabled: + type: array + items: + type: string + example: "credit_card" + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos + methods: + type: object + description: Configuration by specific payment method + x-description-i18n: + eng: Configuration by specific payment method + spa: Configuración por tipo específico de medio de pago + por: Configuração por tipo específico de meio de pagamento + properties: + enabled: + type: array + example: visa, master + description: Payment methods included + items: + type: object + properties: + id: + type: string + description: Payment method identifier + x-description-i18n: + eng: Payment method identifier + spa: Identificador del medio de pago + por: Identificador do meio de pagamento + example: "credit_card" + installments: + type: object + description: Configuration of the number of installments to offer for the payment method + x-description-i18n: + eng: Configuration of the number of installments to offer for the payment method + spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago + por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + properties: + default: + description: Default number of installments to offer + x-description-i18n: + eng: Default number of installments to offer + spa: Cantidad de cuotas a ofrecer por defecto + por: Quantidade de parcelas a oferecer por padrão + type: string + example: "3" + max: + description: Maximum number of installments to offer + x-description-i18n: + eng: Maximum number of installments to offer + spa: Cantidad máxima de cuotas a ofrecer + por: Quantidade máxima de parcelas a oferecer + type: string + example: "6" + min: + description: Minimum number of installments to offer + x-description-i18n: + eng: Minimum number of installments to offer + spa: Cantidad mínima de cuotas a ofrecer + por: Quantidade mínima de parcelas a oferecer + type: string + example: "1" + disabled: + type: array + items: + type: string + example: ticket, account_money + description: Methods of payment not included + x-description-i18n: + eng: Methods of payment not included + spa: Métodos de pago no incluidos + por: Métodos de pagamento não incluídos + default: + type: string + example: "credit_card" + description: Payment method to offer by default + x-description-i18n: + eng: Payment method to offer by default + spa: Tipo de medio de pago a ofrecer por defecto + por: Tipos de meios de pagamento a oferecer por padrão + integration: + type: object + description: Configuration of the seller on integration + x-description-i18n: + eng: Configuration of the seller on integration + spa: Configuración del seller sobre la integración + por: Configuração do vendedor sobre a integração + properties: + notification_url: + type: string + description: URL to which notifications will be sent + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent + spa: URL a la cual se enviarán las notificaciones + por: URL para a qual as notificações serão enviadas + return_url_default: + description: Default URL to redirect the buyer + x-description-i18n: + eng: Default URL to redirect the buyer + spa: URL por defecto a la cual se redireccionará al comprador + por: URL padrão para redirecionar o comprador + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + return_url_pending: + description: URL to redirect the buyer in case of pending payment + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente + por: URL para redirecionar o comprador em caso de pagamento pendente + return_url_failure: + description: URL to redirect the buyer in case of failed payment + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment + spa: URL a la cual se redireccionará al comprador en caso de pago fallido + por: URL para redirecionar o comprador em caso de pagamento falhou + order: + type: object + description: Common Order attributes for request and response + x-description-i18n: + eng: Common Order attributes for request and response + spa: Atributos de Order comunes para el request y el response + por: Atributos de Order comuns para o request e o response + properties: + id: + type: number + example: 123456789 + description: ID of the order previously created in the integrator's system + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID de orden previamente creada en el sistema del integrador + por: ID da ordem criada anteriormente no sistema do integrador + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: description for the order or transaction + x-description-i18n: + eng: description for the order or transaction + spa: Motivo de la orden o transacción + por: Motivo da ordem ou transação + amount: + example: "233.00" + type: string + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + items: + type: object + description: List of items included in the order + x-description-i18n: + eng: List of items included in the order + spa: Listado de ítems incluidos en la órden + por: Lista de itens incluídos no pedido + properties: + id: + type: string + example: "x76ax" + description: Item identification code + x-description-i18n: + eng: Item identification code + spa: Código de identificación del ítem + por: Código de identificação do item + quantity: + type: number + example: 4 + description: Number of item included in the order + x-description-i18n: + eng: Number of item included in the order + spa: Cantidad de ocurrencias del ítem incluidos en la órden + por: Quantidade de itens incluídos no pedido + unit_price: + type: string + example: "100.00" + description: Unit price of the item + x-description-i18n: + eng: Unit value of the item + spa: Precio unitario del ítem + por: Preço unitário do item + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items + x-description-i18n: + eng: Description of the item that makes up the list of order items + spa: Descripción del artículo que componen el listado de items de la orden + por: Descrição do item que compõe a lista de itens do pedido + collectors: + type: object + description: Seller user who receives the payment + x-description-i18n: + eng: Seller user who receives the payment + spa: Usuario vendedor que recibe el pago + por: Usuário vendedor que recebe o pagamento + properties: + collector_id: + type: number + example: 123456789 + description: Collector identifier + x-description-i18n: + eng: Collector identifier + spa: ID del collector + por: Identificador do collector + amount: + type: string + example: "50.00" + description: Amount of the transaction corresponding to the collector + x-description-i18n: + eng: Amount of the transaction corresponding to the collector + spa: Monto de la transacción que corresponde al collector + por: Valor da transação correspondente ao collector + payer: + type: object + description: Buyer's information + x-description-i18n: + eng: Buyer's information + spa: Información del comprador + por: Informações do comprador + properties: + email: + type: string + description: Buyer's email + x-description-i18n: + eng: Buyer's email + spa: Email del comprador + por: Email do comprador + customer_id: + type: number + example: 123456 + description: ID of the Customer saved previously + x-description-i18n: + eng: ID of the Customer saved previously + spa: ID del Customer guardado anteriormente + por: Número de identificação do comprador salvo anteriormente + identification: + type: object + description: Type and number of legal document that identifies the person in the country + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country + spa: Tipo y número de documento legal que identifica a la persona en el país + por: Tipo e número de documento que identifica a pessoa no país + properties: + number: + description: Number of the document + x-description-i18n: + eng: Number of the document + spa: Número del documento + por: Número do documento + type: string + example: "12345678098" + type: + description: Type of the document + x-description-i18n: + eng: Type of the document + spa: Tipo de documento + por: Tipo de documento + type: string + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name + x-description-i18n: + eng: Buyer's name + spa: Nombre del comprador + por: Nome do comprador + surname: + type: string + example: "Doe" + description: Buyer's surname + x-description-i18n: + eng: Buyer's surname + spa: Apellido del comprador + por: Sobrenome do comprador + address: + type: object + description: Address of the buyer + x-description-i18n: + eng: Address of the buyer + spa: Dirección del comprador + por: Endereço do comprador + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name + x-description-i18n: + eng: Street name + spa: Nombre de la calle + por: Nome da rua + street_number: + type: string + example: "100" + description: Street number + x-description-i18n: + eng: Street number + spa: Número de la calle + por: Número da casa + zip_code: + type: string + example: "57000-865" + description: Zip code + x-description-i18n: + eng: Zip code + spa: Código postal + por: Código postal + phone: + type: object + description: Buyer's phone number + x-description-i18n: + eng: Buyer's phone number + spa: Número de teléfono del comprador + por: Número de telefone do comprador + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction + x-description-i18n: + eng: Options for advanced transaction + spa: Agrupación de opciones avanzadas para la transacción + por: Opções avançadas para a transação + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + sponsor_id: + type: number + example: 123456789 + description: ID of the Mercado Pago account that will pay the fees + x-description-i18n: + eng: ID of the Mercado Pago account that will pay the fees + spa: ID de la cuenta de Mercado Pago que pagará las comisiones + por: ID da conta do Mercado Pago que pagará as comissões + amount_details: + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction + x-description-i18n: + eng: Details of the total value of the transaction + spa: Detalles del monto total de la transacción + por: Detalhes do valor total da transação + paid: + type: string + example: "100.00" + description: Total paid + x-description-i18n: + eng: Total paid + spa: Monto de la transacción pagado + por: Valor pago + refunded: + type: string + example: "100.00" + description: Total value refunded + x-description-i18n: + eng: Total value refunded + spa: Monto de la transacción devuelto + por: Valor reembolsado + shipment: + type: string + example: "10.00" + description: Total value charged per shipment + x-description-i18n: + eng: Total value charged per shipment + spa: Monto cobrado por envío (incluido en total) + por: Valor cobrado por envio (incluído no total) + payment_method: + properties: + credit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + installments: + type: number + description: Quantity of installments + x-description-i18n: + eng: Quantity of installments + spa: Cantidad de cuotas deseadas + por: Quantidade de parcelas desejadas + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "refunded" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + debit_cards: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data + x-description-i18n: + eng: Card token that represents securely the credit card data + spa: card_token que representa de manera segura los datos de tarjeta + por: Card token que representa de maneira segura os dados do cartão + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta + por: Caso seja requerido, identificador da entidade emissora do cartão + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement + spa: Descriptor del cargo a utilizar en el resumen del emisor + por: Descritor da cobrança a ser mostrada no extrato do cartão + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + tickets: + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 1234567654 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + atms: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + bank_transfers: + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method + x-description-i18n: + eng: Total amount to be paid with this payment method + spa: Monto a pagar con este medio + por: Valor total a ser pago com este meio de pagamento + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method + x-description-i18n: + eng: Identifier of the chosen payment method + spa: Identificador del medio de pago elegido + por: Identificador do meio de pagamento escolhido + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method + x-description-i18n: + eng: Payment ID corresponding to the payment method + spa: ID de Pago correspondiente al medio + por: ID de pagamento correspondente ao meio de pagamento + status: + type: string + example: "pending" + description: Status of the payment + x-description-i18n: + eng: Status of the payment + spa: Estado del pago + por: Estado do pagamento + completion_url: + type: string + description: For offline payments, URL that allows you to continue the payment flow + x-description-i18n: + eng: For offline payments, URL that allows you to continue the payment flow + spa: Para pagos offline, URL que permite continuar el flujo de pago + por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + refunds: + description: List of refunds related to the payment method + x-description-i18n: + eng: List of refunds related to the payment method + spa: Listado de devoluciones relacionadas al medio de pago + por: Lista de reembolsos relacionados ao meio de pagamento + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund + x-description-i18n: + eng: ID of the refund + spa: ID de la devolución + por: ID do reembolso + refund_amount: + type: string + example: "50.00" + description: Amount of the refund + x-description-i18n: + eng: Amount of the refund + spa: Monto de la devolución + por: Valor do reembolso + status_detail: + type: object + description: Detail information about the status of the payment + x-description-i18n: + eng: Information about the status of the payment + spa: Información sobre el resultado del procesamiento + por: Informações detalhadas sobre o status do pagamento + properties: + code: + type: string + example: "400" + description: Status code + x-description-i18n: + eng: Status code + spa: Código del estado del pago + por: Código do Estado do Pagamento + message: + type: string + example: "acquirer rejected" + description: Status message + x-description-i18n: + eng: Status message + spa: Mensaje del estado del pago + por: Mensagem do Estado do Pagamento + "400": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 400--Bad Request. + - 401--Unauthorized. + - 403--Forbidden. + - 404--Not Found. + - 408--Request Timeout. + - 409--Conflict. + - 422--Unprocessable Entity. + "500": + description: Error + x-description-i18n: + eng: Error + spa: Error + por: Erro + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - 500--Unexpected Error. + - 503--Service Unavailable. From bba7110a201c2ca6f31fd9ffc159b5a7b5c1f1a1 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 15 Aug 2023 16:06:25 -0300 Subject: [PATCH 23/40] identation fix --- reference/api/transaction_intent.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 82660d416e..9fc7b4f640 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -159,11 +159,11 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789. configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Configuration parameters defined by the seller before starting the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Configuration parameters defined by the seller before starting the transaction. + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción. + por: Configuração definida pelo seller antes de iniciar a transação. properties: option: type: object @@ -301,15 +301,15 @@ paths: type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: ticket, account_money - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. default: type: string example: "credit_card" From db085804de46c40f4e52e6f2b9bdff9334c0d2a1 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 15 Aug 2023 16:52:14 -0300 Subject: [PATCH 24/40] description improvements --- reference/api/transaction_intent.yaml | 246 +++++++++++++------------- 1 file changed, 125 insertions(+), 121 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 9fc7b4f640..9b538f2073 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -1200,11 +1200,11 @@ paths: post: tags: - $ref: '#/tags/checkout-api' - summary: Create and Process a new Transaction Intent + summary: Create and Process a Transaction Intent x-summary-i18n: - eng: Create and Process a new Transaction Intent - spa: Crear y procesar una nueva Transaction Intent - por: Criar e processar nova Transaction Intent + eng: Create and Process a Transaction Intent + spa: Crear y procesar Transaction Intent + por: Criar e processar Transaction Intent description: This endppoint allows you to creates and process a new Transaction Intent x-description-i18n: eng: This endppoint allows you to creates and rocess a new Transaction Intent @@ -1217,32 +1217,32 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: header name: X-Product-ID schema: type: string example: "876542356788-mp" required: false - description: Alphanumeric ID of the product + description: Alphanumeric product ID, for example, 876542356788-mp. x-description-i18n: - eng: Alphanumeric ID of the product - spa: ID alfanumérico del producto - por: ID alfanumérico do produto + eng: Alphanumeric product ID, for example, 876542356788-mp. + spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. + por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. - in: header name: X-Platform-ID schema: type: string required: false - description: Alphanumeric ID of the platform + description: Alphanumeric ID of the platform. x-description-i18n: - eng: Alphanumeric ID of the platform - spa: ID alfanumérico de la plataforma - por: ID alfanumérico da plataforma + eng: Alphanumeric ID of the platform. + spa: Identificación alfanumérica de la plataforma. + por: Identificação alfanumérica da plataforma. - in: header name: X-Integrator-ID schema: @@ -1251,14 +1251,14 @@ paths: description: Alphanumeric ID of the integrator x-description-i18n: eng: Alphanumeric ID of the integrator - spa: ID alfanumérico del integrador - por: ID alfanumérico do integrador + spa: Identificación alfanumérica del integrador + por: Identificação alfanumérica do integrador. requestBody: - description: Complete body for a Transaction Intent. + description: Complete body to create and process a Transaction Intent. x-description-i18n: - eng: Complete body for a Transaction Intent. - spa: Body completo para una solicitud. - por: Body completo para uma solicitação. + eng: Complete body to create and process a Transaction Intent. + spa: Body completo para crear y procesar una Transaction Intent. + por: Body completo para criar e processar uma Transaction Intent. content: application/json: schema: @@ -1266,85 +1266,85 @@ paths: properties: active_to_date: type: string - description: Close processing limit for transaction intent + description: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". x-description-i18n: - eng: Close processing limit for transaction intent - spa: Fecha límite de procesamiento para la intención de transacción - por: Data limite de processamento para a intenção de transação + eng: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Transaction Intent. Este plazo establece la fecha límite hasta la cual se espera que la Transaction Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Transaction Intent. Este prazo determina a data-limite até a qual se espera que a Transaction Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidps pelo seller antes de iniciar a transação. properties: options: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: payment_methods: required: true type: object properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a payment method during the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a payment method during the transaction. + spa: Los cupones se pueden utilizar como método de pago durante la transacción. + por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. + x-description-i18n: + eng: List of Payment Types included. + spa: Lista de tipos de medios de pago incluidos. + por: Lista de tipos de meios de pagamento incluídos. type: array items: type: string example: [ "credit_card", "debit_card" ] - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not included + x-description-i18n: + eng: Types of payment methods not included + spa: Tipos de medios de pago no incluidos + por: Tipos de meios de pagamento não incluídos type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object description: Configuration by specific payment method @@ -1356,48 +1356,52 @@ paths: enabled: type: array example: [ "visa", "master" ] - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier. For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier. For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a serem disponibilizadas. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a serem disponibilizadas. type: string example: "1" disabled: @@ -1405,86 +1409,86 @@ paths: items: type: string example: [ "ticket", "account_money" ] - description: Methods of payment not included + description: Payment methods not included. x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. default: type: string example: "credit_card" - description: Payment method to offer by default + description: Types of payment methods to be offered by default. x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". example: [ "wallet_purchase", "onboarding_credits" ] integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do vendedor sobre a integração. properties: notifications: type: object properties: notification_url: type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). + por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). example: "https://www.integrator-site.com/api/notifications" return_url: type: object - description: Status URLs available to redirect buyer after completion of payment attempt + description: Status URLs available to redirect buyer after completion of payment attempt. x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + eng: Status URLs available to redirect buyer after completion of payment attempt. + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. properties: default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. failure: - description: URL to redirect the buyer in case of failed payment + description: URL to redirect the buyer in case of payment failure. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: URL to redirect the buyer in case of payment failure. + spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. + por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. integrator_id: type: number example: 34567 From 15547e1f653c39676bbd490631cc5ce4e0778134 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 16 Aug 2023 15:35:06 -0300 Subject: [PATCH 25/40] process endpoint description improvements --- reference/api/transaction_intent.yaml | 1671 +++++++++++++------------ 1 file changed, 863 insertions(+), 808 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 9b538f2073..b4ceb405a3 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -125,20 +125,20 @@ paths: created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la intención de transacción. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da intenção de transação. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the transaction intent + description: Current status of the Transaction Intent. x-description-i18n: - eng: Current status of the transaction intent - spa: Status actual de la intención de transacción - por: Status atual da transação + eng: Current status of the Transaction Intent. + spa: Status actual de la Transaction Intent. + por: Status atual da Transaction Intent. enum: - new--nova - transaction_in_process--transação em processo @@ -156,30 +156,30 @@ paths: x-description-i18n: eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789. + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction. + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction. - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción. - por: Configuração definida pelo seller antes de iniciar a transação. + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller's configuration regarding the available options in the transaction. + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration regarding the available options in the transaction. - spa: Configuración del seller con respecto a las opciones disponibles en la transacción. - por: Configuração do vendedor que abrange as opções disponíveis durante o processo de transação. + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. + description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. + eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object @@ -262,11 +262,11 @@ paths: properties: id: type: string - description: Payment method identifier. + description: Payment method identifier. For example, "credit_card". x-description-i18n: - eng: Payment method identifier. - spa: Identificador del medio de pago. - por: Identificador do meio de pagamento. + eng: Payment method identifier For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object @@ -324,7 +324,7 @@ paths: x-description-i18n: eng: Configuration of the seller on integration. spa: Configuración del seller sobre la integración. - por: Configuração do vendedor sobre a integração. + por: Configuração do seller sobre a integração. properties: notification_url: type: string @@ -368,11 +368,11 @@ paths: por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object - description: Common Order attributes for request and response + description: Common Order attributes for request and response. x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. properties: id: type: number @@ -393,7 +393,7 @@ paths: description: type: string example: "my_order_description" - description: description for the order or transaction. + description: Description for the order or transaction. x-description-i18n: eng: Description for the order or transaction. spa: Descripción de la orden o transacción. @@ -407,6 +407,11 @@ paths: spa: Monto total de la transacción. Por ejemplo, "233.00". por: Valor total da transação. Por exemplo, "233.00". items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -414,7 +419,7 @@ paths: x-description-i18n: eng: List of items included in the order. spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos no pedido. + por: Lista de itens incluídos na ordem. properties: id: type: string @@ -431,7 +436,7 @@ paths: x-description-i18n: eng: Number of item included in the order. spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos no pedido. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" @@ -455,7 +460,7 @@ paths: x-description-i18n: eng: Description of the items comprising the list of products included in the order. spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. - por: Descrição dos itens que constituem a lista de produtos incluídos no pedido. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. collectors: type: object description: Seller user who receives the payment. @@ -470,7 +475,7 @@ paths: description: Collector identifier. x-description-i18n: eng: Collector identifier. - spa: ID del collector. + spa: Identificador del collector. por: Identificador do collector. amount: type: string @@ -495,6 +500,7 @@ paths: eng: Buyer's email. spa: Email del comprador. por: Email do comprador. + example: test@test.com customer_id: type: number example: 123456 @@ -670,7 +676,7 @@ paths: description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio. + spa: Monto a pagar con este medio de pago. por: Total a ser pago com este meio de pagamento. token: type: string @@ -686,7 +692,7 @@ paths: description: Payment ID corresponding to the payment method. x-description-i18n: eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio. + spa: ID de Pago correspondiente al medio de pago. por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string @@ -742,7 +748,7 @@ paths: description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto de la devolución. + spa: Monto del reembolso. por: Valor do reembolso. status: type: string @@ -750,8 +756,8 @@ paths: description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Estado del pago. - por: Estado do pagamento. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object description: Detail information about the status of the payment. @@ -763,17 +769,17 @@ paths: code: type: string example: "400" - description: Status code. + description: Payment status code. x-description-i18n: - eng: Status code. + eng: Payment status code. spa: Código del estado del pago. por: Código do Estado do Pagamento. message: type: string example: "acquirer rejected" - description: Status message. + description: Payment status message. x-description-i18n: - eng: Status message. + eng: Payment status message. spa: Mensaje del estado del pagos. por: Mensagem do status do Pagamento. debit_cards: @@ -842,7 +848,7 @@ paths: description: ID of the refund. x-description-i18n: eng: ID of the refund. - spa: ID de la devolución. + spa: ID del reembolso. por: ID do reembolso. refund_amount: type: string @@ -850,7 +856,7 @@ paths: description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto de la devolución. + spa: Monto del reembolso. por: Valor do reembolso. status: type: string @@ -858,24 +864,24 @@ paths: description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Estado del pago. + spa: Status del pago. por: Status do pagamento. status_detail: type: object description: Detail information about the status of the payment. x-description-i18n: eng: Information about the status of the payment. - spa: Información sobre el resultado del procesamiento. + spa: Información sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code x-description-i18n: - eng: Status code. + eng: Payment status code. spa: Código del estado del pago. - por: Código do status do Pagamento. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" @@ -918,14 +924,14 @@ paths: description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Estado del pago. + spa: Status del pago. por: Status do pagamento. status_detail: type: object description: Detail information about the status of the payment. x-description-i18n: eng: Information about the status of the payment. - spa: Información sobre el resultado del procesamiento. + spa: Información sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: @@ -943,7 +949,7 @@ paths: x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. + por: Mensagem do status do pagamento. completion_url: type: string description: For offline payments, this is the URL that enables the continuation of the payment flow. @@ -1115,7 +1121,7 @@ paths: description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. + spa: Listado de reembolsos relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: @@ -1133,15 +1139,15 @@ paths: description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto de la devolución. + spa: Monto del reembolso. por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment. + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string @@ -1279,7 +1285,7 @@ paths: x-description-i18n: eng: Predefined configuration parameters set by the seller before initiating the transaction. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidps pelo seller antes de iniciar a transação. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: options: type: object @@ -1292,6 +1298,11 @@ paths: payment_methods: required: true type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: description: Coupons can be used as a payment method during the transaction. @@ -1326,32 +1337,32 @@ paths: por: Configuração por tipo de meio de pagamento. properties: enabled: - description: List of Payment Types included. + description: List of Payment Types included. For example, credit_card, debit_card. x-description-i18n: - eng: List of Payment Types included. - spa: Lista de tipos de medios de pago incluidos. - por: Lista de tipos de meios de pagamento incluídos. + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: [ "credit_card", "debit_card" ] disabled: - description: Types of payment methods not included + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array @@ -1405,15 +1416,15 @@ paths: type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: [ "ticket", "account_money" ] - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. default: type: string example: "credit_card" @@ -1436,9 +1447,14 @@ paths: x-description-i18n: eng: Configuration of the seller on integration. spa: Configuración del seller sobre la integración. - por: Configuração do vendedor sobre a integração. + por: Configuração do seller sobre a integração. properties: notifications: + description: Parameter concerning notification URL settings for conducted transactions. + x-description-i18n: + eng: Parameter concerning notification URL settings for conducted transactions. + spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. + por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object properties: notification_url: @@ -1482,96 +1498,101 @@ paths: spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. por: URL para redirecionar o comprador em caso de pagamento pendente. failure: - description: URL to redirect the buyer in case of payment failure. + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of payment failure. + eng: URL to redirect the buyer in case of pending payment. spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. integrator_id: type: number example: 34567 - description: Seller's identifier in the integrator's system + description: Seller's identifier in the integrator's system. x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador + eng: Seller's identifier in the integrator's system. + spa: Identificador del seller en el sistema del integrador. + por: Identificador do vendedor no sistema do integrador. order: - description: Order with all information to execute the transaction + description: Order containing all the essential information for the execution of a transaction. x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação + eng: Order containing all the essential information for the execution of a transaction. + spa: Orden que contiene toda la información esencial para la ejecución de una transacción. + por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" - description: Reference of the order + description: Reference of the order. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. reason: type: string example: "my_order_description" - description: Reason for the order or transaction + description: Reason for the order or transaction. x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Reason for the order or transaction. + spa: Motivo de la orden o transacción. + por: Motivo da ordem ou transação. amount: required: true type: string example: "50.00" - description: Total amount to be paid + description: Total amount to be paid. x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago + eng: Total amount to be paid. + spa: Monto total que se desea cobrar. + por: Valor total a ser pago. items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -1583,162 +1604,172 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: required: true type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal - phone: - type: object - description: Buyer's phone number + eng: Zip code. + spa: Código postal. + por: Código postal. + phone: + type: object + description: Buyer's phone number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + properties: + area_code: + type: string + description: Buyer's area code. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador - properties: - area_code: - type: string - example: "11" - number: - type: string - example: "99999999" + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. + example: "11" + number: + type: string + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: type: object - description: Marketplace settings + description: In the event of a marketplace-type integration, this configuration is applicable to the collector. x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector + eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. + spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. + por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. properties: fee: type: string example: "5" - description: Percentage of commission charged to the collector + description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector + eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. + spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. + por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: ID of the Mercado Pago account responsible for paying the commissions. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - payment_method: + eng: ID of the Mercado Pago account responsible for paying the commissions. + spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. + por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. + payment_method: properties: credit_cards: type: array @@ -1747,51 +1778,51 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. debit_cards: type: array items: @@ -1799,43 +1830,43 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. tickets: type: array items: @@ -1843,43 +1874,43 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: - type: string - example: "100.00" - description: Total value of coupon - x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + description: Coupons can be used as a payment method during the transaction. + x-description-i18n: + eng: Coupons can be used as a payment method during the transaction. + spa: Los cupones se pueden utilizar como método de pago durante la transacción. + por: Os cupons podem ser utilizados como forma de pagamento durante a transação. + type: object + properties: + campaign_id: + type: number + example: 123456 + description: Identifier number of the campaign to which the coupon is linked. + x-description-i18n: + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. + amount: + type: string + example: "100.00" + description: Total value of coupon. For example, "100.00". + x-description-i18n: + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". atms: type: array items: @@ -1888,43 +1919,43 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a payment method during the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a payment method during the transaction. + spa: Los cupones se pueden utilizar como método de pago durante la transacción. + por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". bank_transfers: type: array items: @@ -1933,43 +1964,43 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. + spa: Valor total del cupón. + por: Valor total do cupom. responses: "200": description: success @@ -1981,320 +2012,329 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent + description: ID of a created Transaction Intent. x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent + description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação + eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the transaction intent + description: Current status of the Transaction Intent. x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação + eng: Current status of the Transaction Intent. + spa: Status actual de la Transaction Intent. + por: Status atual da Transaction Intent. enum: - - new--novo + - new--nova - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente - reverted--revertida - failed--falhou - - cancelled--cancelado + - cancelled--cancelada - authorized--autorizada init_point: type: string example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow + description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento + eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: visa, master - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a oferecer. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a oferecer. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" - description: Payment method to offer by default + description: Types of payment methods to be offered by default. x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notification_url: type: string - description: URL to which notifications will be sent + description: URL to which notifications will be sent. example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. return_url_default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" return_url_success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. return_url_pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. return_url_failure: - description: URL to redirect the buyer in case of failed payment + description: Redirection URL for the event of buyer payment failure. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: Redirection URL for the event of buyer payment failure. + spa: URL de redirección para el caso de fallo en el pago del comprador. + por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object - description: Common Order attributes for request and response + description: Common Order attributes for request and response. x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" description: Reference of the order x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. description: type: string example: "my_order_description" - description: description for the order or transaction + description: Description for the order or transaction. x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Description for the order or transaction. + spa: Descripción de la orden o transacción. + por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction + description: Total value of the transaction. For example, "233.00". x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação + eng: Total value of the transaction. For example, "233.00". + spa: Monto total de la transacción. Por ejemplo, "233.00".. + por: Valor total da transação. Por exemplo, "233.00". items: type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -2306,203 +2346,218 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. collectors: type: object - description: Seller user who receives the payment + description: Seller user who receives the payment. x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento + eng: Seller user who receives the payment. + spa: Usuario vendedor que recibe el pago. + por: Usuário vendedor que recebe o pagamento. properties: collector_id: type: number example: 123456789 - description: Collector identifier + description: Collector identifier. x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector + eng: Collector identifier. + spa: Identificador del collector. + por: Identificador do collector. amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector + description: Amount of the transaction corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector + eng: Amount of the transaction corresponding to the collector. + spa: Monto de la transacción que corresponde al collector. + por: Valor da transação correspondente ao collector. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip code. + spa: Código postal. + por: Código postal. phone: - type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + type: object properties: area_code: + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. type: string example: "11" number: + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. type: string example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. + spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. + por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: + description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object properties: total: type: string example: "123.00" - description: Details of the total value of the transaction + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. paid: type: string example: "100.00" - description: Total paid + description: Total paid. x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. refunded: type: string example: "100.00" - description: Total value refunded + description: Total value refunded. x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. shipment: type: string example: "10.00" - description: Total value charged per shipment + description: Total value charged per shipment. x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) + eng: Total value charged per shipment. + spa: Monto cobrado por envío (incluido en el otal). + por: Valor cobrado por envio (incluído no total). payment_method: properties: credit_cards: @@ -2512,115 +2567,115 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 12345432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el resultado del procesamiento. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. debit_cards: type: array items: @@ -2628,107 +2683,107 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 1234565432 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. tickets: type: array items: @@ -2736,90 +2791,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 1234567654 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. atms: type: array items: @@ -2828,90 +2883,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 12345432423 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. bank_transfers: type: array items: @@ -2920,90 +2975,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 23421234543 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. "400": description: Error x-description-i18n: From 298fdecdae6e70d69bf38818a0f564f7ac7affab Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 16 Aug 2023 16:08:32 -0300 Subject: [PATCH 26/40] amount details field fix --- reference/api/transaction_intent.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index b4ceb405a3..5d2d7cd8fe 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -630,6 +630,11 @@ paths: spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: + description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object properties: total: From bedf27a406b0bb91381ca75ef5ea3788fb9bf1c5 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 16 Aug 2023 17:25:39 -0300 Subject: [PATCH 27/40] parameteres adjustments --- reference/api/transaction_intent.yaml | 445 ++++++++++++++------------ 1 file changed, 232 insertions(+), 213 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 5d2d7cd8fe..68da8b137e 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -3122,28 +3122,28 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: header name: X-Product-ID schema: type: string example: "876542356788-mp" required: false - description: Alphanumeric ID of the product + description: Alphanumeric product ID, for example, 876542356788-mp. x-description-i18n: - eng: Alphanumeric ID of the product - spa: ID alfanumérico del producto - por: ID alfanumérico do produto + eng: Alphanumeric product ID, for example, 876542356788-mp. + spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. + por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. requestBody: - description: Complete body for a Transaction Intent. + description: Complete body for authorizing payments of a Transaction Intent. x-description-i18n: - eng: Complete body for a Transaction Intent. - spa: Body completo para una solicitud. - por: Body completo para uma solicitação. + eng: Complete body for authorizing payments of a Transaction Intent. + spa: Body completo para autorizar los pagos de una Transaction Intent. + por: Body completo para autorização de pagamentos de uma Transaction Intent. content: application/json: schema: @@ -3151,308 +3151,327 @@ paths: properties: active_to_date: type: string - description: Close processing limit for transaction intent + description: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". x-description-i18n: - eng: Close processing limit for transaction intent - spa: Fecha límite de procesamiento para la intención de transacción - por: Data limite de processamento para a intenção de transação + eng: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Transaction Intent. Este plazo establece la fecha límite hasta la cual se espera que la Transaction Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Transaction Intent. Este prazo determina a data-limite até a qual se espera que a Transaction Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: options: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: payment_methods: required: true type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a payment method during the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a payment method during the transaction. + spa: Los cupones se pueden utilizar como método de pago durante la transacción. + por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: [ "credit_card", "debit_card" ] - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: [ "visa", "master" ] - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier. For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier. For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a serem disponibilizadas. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a serem disponibilizadas. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: [ "ticket", "account_money" ] - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" - description: Payment method to offer by default + description: Types of payment methods to be offered by default. x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". example: [ "wallet_purchase", "onboarding_credits" ] integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notifications: + description: Parameter concerning notification URL settings for conducted transactions. + x-description-i18n: + eng: Parameter concerning notification URL settings for conducted transactions. + spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. + por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object properties: notification_url: type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). + por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). example: "https://www.integrator-site.com/api/notifications" return_url: type: object - description: Status URLs available to redirect buyer after completion of payment attempt + description: Status URLs available to redirect buyer after completion of payment attempt. x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + eng: Status URLs available to redirect buyer after completion of payment attempt. + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. properties: default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. failure: - description: URL to redirect the buyer in case of failed payment + description: URL to redirect the buyer in case of failed payment. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. + por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. integrator_id: type: number example: 34567 - description: Seller's identifier in the integrator's system + description: Seller's identifier in the integrator's system. x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador + eng: Seller's identifier in the integrator's system. + spa: Identificador del seller en el sistema del integrador. + por: Identificador do seller no sistema do integrador. order: - description: Order with all information to execute the transaction + description: Order containing all the essential information for the execution of a transaction. x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação + eng: Order containing all the essential information for the execution of a transaction. + spa: Orden que contiene toda la información esencial para la ejecución de una transacción. + por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" - description: Reference of the order + description: Reference of the order. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. reason: type: string example: "my_order_description" - description: Reason for the order or transaction + description: Reason for the order or transaction. x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Reason for the order or transaction. + spa: Motivo de la orden o transacción. + por: Motivo da ordem ou transação. amount: required: true type: string example: "50.00" - description: Total amount to be paid + description: Total amount to be paid. x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago + eng: Total amount to be paid. + spa: Monto total que se desea cobrar. + por: Valor total a ser pago. items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -3464,114 +3483,114 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: required: true type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip code. + spa: Código postal. + por: Código postal. phone: type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. properties: area_code: type: string @@ -3852,7 +3871,7 @@ paths: spa: Valor total del cupón por: Valor total do cupom responses: - "202": + "200": description: accepted content: application/json: From 8c15fbad3609056d33a462b009406b5e7fb74933 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Thu, 17 Aug 2023 12:56:02 -0300 Subject: [PATCH 28/40] fixed process endpoint parameters --- reference/api/transaction_intent.yaml | 1211 +++++++++++++------------ 1 file changed, 627 insertions(+), 584 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 68da8b137e..011cde90dc 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -2307,6 +2307,11 @@ paths: spa: Monto total de la transacción. Por ejemplo, "233.00".. por: Valor total da transação. Por exemplo, "233.00". items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -3594,50 +3599,60 @@ paths: properties: area_code: type: string + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. example: "11" number: type: string + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: type: object - description: Marketplace settings + description: In the event of a marketplace-type integration, this configuration is applicable to the collector. x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector + eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. + spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. + por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. properties: fee: type: string example: "5" - description: Percentage of commission charged to the collector + description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector + eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. + spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. + por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: ID of the Mercado Pago account responsible for paying the commissions. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: ID of the Mercado Pago account responsible for paying the commissions. + spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. + por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. payment_method: properties: credit_cards: @@ -3647,51 +3662,51 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. debit_cards: type: array items: @@ -3699,43 +3714,43 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. tickets: type: array items: @@ -3743,19 +3758,19 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. coupons: description: Coupons can be used as a methods of payment in the transaction x-description-i18n: @@ -3767,19 +3782,19 @@ paths: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". atms: type: array items: @@ -3788,43 +3803,43 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. + spa: Valor total del cupón. + por: Valor total do cupom. bank_transfers: type: array items: @@ -3833,43 +3848,43 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number - x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + description: Identifier number of the campaign to which the coupon is linked. + x-description-i18n: + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". responses: "200": description: accepted @@ -3881,190 +3896,198 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent + description: ID of a created Transaction Intent. x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent + description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação + eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the transaction intent + description: Current status of the Transaction Intent. x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação + eng: Current status of the Transaction Intent. + spa: Status actual de la Transaction Intent. + por: Status atual da Transaction Intent. enum: - - new--novo + - new--nova - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente - reverted--revertida - failed--falhou - - cancelled--cancelado + - cancelled--cancelada - authorized--autorizada init_point: type: string example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow + description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento + eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas - example: wallet_purchase, onboarding_credits + eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. payment_methods: type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: visa, master - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a oferecer. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a oferecer. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" @@ -4075,126 +4098,131 @@ paths: por: Tipos de meios de pagamento a oferecer por padrão integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notification_url: type: string - description: URL to which notifications will be sent + description: URL to which notifications will be sent. example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. return_url_default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" return_url_success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. return_url_pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. return_url_failure: - description: URL to redirect the buyer in case of failed payment + description: Redirection URL for the event of buyer payment failure. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: Redirection URL for the event of buyer payment failure. + spa: URL de redirección para el caso de fallo en el pago del comprador. + por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object - description: Common Order attributes for request and response + description: Common Order attributes for request and response. x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" description: Reference of the order x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. description: type: string example: "my_order_description" - description: description for the order or transaction + description: Description for the order or transaction. x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Description for the order or transaction. + spa: Descripción de la orden o transacción. + por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction + description: Total value of the transaction. For example, "233.00". x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação + eng: Total value of the transaction. For example, "233.00". + spa: Monto total de la transacción. Por ejemplo, "233.00".. + por: Valor total da transação. Por exemplo, "233.00". items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -4206,163 +4234,178 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. collectors: type: object - description: Seller user who receives the payment + description: Seller user who receives the payment. x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento + eng: Seller user who receives the payment. + spa: Usuario vendedor que recibe el pago. + por: Usuário vendedor que recebe o pagamento. properties: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector + description: Amount of the transaction corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector + eng: Amount of the transaction corresponding to the collector. + spa: Monto de la transacción que corresponde al collector. + por: Valor da transação correspondente ao collector. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip code. + spa: Código postal. + por: Código postal. phone: - type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + type: object properties: area_code: + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. type: string example: "11" number: + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. type: string example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: ID of the Mercado Pago account responsible for paying the commissions. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: ID of the Mercado Pago account responsible for paying the commissions. + spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. + por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. amount_details: + description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object properties: total: type: string example: "123.00" - description: Details of the total value of the transaction + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. paid: type: string example: "100.00" - description: Total paid + description: Total paid. x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. refunded: type: string example: "100.00" - description: Total value refunded + description: Total value refunded. x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. payment_method: properties: credit_cards: @@ -4372,115 +4415,115 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 12345432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. debit_cards: type: array items: @@ -4488,107 +4531,107 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 1234565432 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. tickets: type: array items: @@ -4596,90 +4639,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 1234567654 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. atms: type: array items: @@ -4688,90 +4731,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 12345432423 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. bank_transfers: type: array items: @@ -4780,90 +4823,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 23421234543 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. "400": description: Error x-description-i18n: From f23e7d32d17b6686d332194a2b7df662fe0b08b7 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Thu, 17 Aug 2023 17:59:43 -0300 Subject: [PATCH 29/40] fixed parameteres and identation issues --- reference/api/transaction_intent.yaml | 1711 +++++++++++++++------- reference/api/transaction_intent_id.yaml | 1046 ++++++------- 2 files changed, 1755 insertions(+), 1002 deletions(-) diff --git a/reference/api/transaction_intent.yaml b/reference/api/transaction_intent.yaml index 011cde90dc..5468d2a875 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/transaction_intent.yaml @@ -670,8 +670,19 @@ paths: spa: Monto cobrado por envío (incluido en total). por: Valor cobrado por envio (incluído no total). payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. type: array items: properties: @@ -744,8 +755,8 @@ paths: example: 123456789 description: ID of the refund. x-description-i18n: - eng: ID of the refunded. - spa: ID de la devolución. + eng: ID of the refund. + spa: ID del reembolso. por: ID do reembolso. refund_amount: type: string @@ -767,8 +778,8 @@ paths: type: object description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payments. - spa: Información sobre el resultado del procesamiento. + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: @@ -777,17 +788,22 @@ paths: description: Payment status code. x-description-i18n: eng: Payment status code. - spa: Código del estado del pago. - por: Código do Estado do Pagamento. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" description: Payment status message. x-description-i18n: eng: Payment status message. - spa: Mensaje del estado del pagos. + spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. type: array items: properties: @@ -797,8 +813,8 @@ paths: description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio. - por: Valor total a ser pago com este meio de pagamento. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" @@ -810,11 +826,11 @@ paths: payment_id: type: number example: 1234565432 - description: Payment identification associated with the payment method used. + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "debvisa" @@ -826,9 +842,9 @@ paths: issuer: type: string example: "23" - description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: @@ -876,26 +892,31 @@ paths: description: Detail information about the status of the payment. x-description-i18n: eng: Information about the status of the payment. - spa: Información sobre el status del pago. + spa: Información detallada sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Payment status code + description: Payment status code. x-description-i18n: eng: Payment status code. - spa: Código del estado del pago. + spa: Código del status del pago. por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message. - spa: Mensaje del estado del pago. + eng: Payment status message. + spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. type: array items: properties: @@ -966,7 +987,7 @@ paths: description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. + spa: Listado de reembolsos relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: @@ -981,12 +1002,17 @@ paths: refund_amount: type: string example: "50.00" - description: Refund amount. + description: Amount of the refund. x-description-i18n: - eng: Refund amount. + eng: Amount of the refund. spa: Monto del reembolso. por: Valor do reembolso. atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. type: array items: type: object @@ -997,7 +1023,7 @@ paths: description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio. + spa: Monto a pagar con este medio de pago. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string @@ -1010,17 +1036,17 @@ paths: payment_id: type: number example: 12345432423 - description: Payment identification associated with the payment method used. + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al método de pago utilizado. - por: Identificação de pagamento associada ao método de pagamento utilizado. + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Payment status. + description: Status of the payment. x-description-i18n: - eng: Payment status. + eng: Status of the payment. spa: Status del pago. por: Status do pagamento. completion_url: @@ -1034,7 +1060,7 @@ paths: description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. + spa: Listado de reembolsos relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: @@ -1049,17 +1075,17 @@ paths: refund_amount: type: string example: "50.00" - description: Refund amount. + description: Amount of the refund. x-description-i18n: - eng: Refund amount. + eng: Amount of the refund. spa: Monto del reembolso. por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment. + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el resultado del procesamiento. + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: @@ -1069,7 +1095,7 @@ paths: x-description-i18n: eng: Payment status code. spa: Código del status del pago. - por: Código do status do Pagamento. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" @@ -1079,6 +1105,11 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do pagamento. bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. type: array items: type: object @@ -1102,17 +1133,17 @@ paths: payment_id: type: number example: 23421234543 - description: Payment identification associated with the payment method used. + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al método de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Payment status. + description: Status of the payment. x-description-i18n: - eng: Payment status. + eng: Status of the payment. spa: Status del pago. por: Status do pagamento. completion_url: @@ -1126,7 +1157,7 @@ paths: description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. + spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: @@ -1774,238 +1805,538 @@ paths: eng: ID of the Mercado Pago account responsible for paying the commissions. spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. - payment_method: + payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - x-description-i18n: - eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - coupons: - description: Coupons can be used as a payment method during the transaction. - x-description-i18n: - eng: Coupons can be used as a payment method during the transaction. - spa: Los cupones se pueden utilizar como método de pago durante la transacción. - por: Os cupons podem ser utilizados como forma de pagamento durante a transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - coupons: - description: Coupons can be used as a payment method during the transaction. - x-description-i18n: - eng: Coupons can be used as a payment method during the transaction. - spa: Los cupones se pueden utilizar como método de pago durante la transacción. - por: Os cupons podem ser utilizados como forma de pagamento durante a transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - coupons: - description: Coupons can be used as a methods of payment in the transaction. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. - x-description-i18n: - eng: Total value of coupon. - spa: Valor total del cupón. - por: Valor total do cupom. + credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + x-description-i18n: + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_id: + type: number + example: 12345432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + installments: + type: number + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + x-description-i18n: + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: + type: number + example: 1234567654 + description: Payment identification associated with the payment method used. + x-description-i18n: + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: + type: number + example: 12345432423 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status_detail: + type: object + description: Detailed information about the status of the payment. + x-description-i18n: + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. + bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status_detail: + type: object + description: Detailed information about the status of the payment. + x-description-i18n: + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. responses: "200": description: success @@ -2569,8 +2900,19 @@ paths: spa: Monto cobrado por envío (incluido en el otal). por: Valor cobrado por envio (incluído no total). payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. type: array items: properties: @@ -2644,7 +2986,7 @@ paths: description: ID of the refund. x-description-i18n: eng: ID of the refund. - spa: ID de la devolución. + spa: ID del reembolso. por: ID do reembolso. refund_amount: type: string @@ -2667,7 +3009,7 @@ paths: description: Detail information about the status of the payment. x-description-i18n: eng: Information about the status of the payment. - spa: Información sobre el resultado del procesamiento. + spa: Información detallada sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: @@ -2687,6 +3029,11 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. type: array items: properties: @@ -2697,7 +3044,7 @@ paths: x-description-i18n: eng: Total amount to be paid with this payment method. spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" @@ -2709,11 +3056,11 @@ paths: payment_id: type: number example: 1234565432 - description: Payment identification associated with the payment method used. + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "debvisa" @@ -2725,9 +3072,9 @@ paths: issuer: type: string example: "23" - description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: @@ -2775,7 +3122,7 @@ paths: description: Detail information about the status of the payment. x-description-i18n: eng: Information about the status of the payment. - spa: Información sobre el status del pago. + spa: Información detallada sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: @@ -2795,6 +3142,11 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. type: array items: properties: @@ -2886,6 +3238,11 @@ paths: spa: Monto del reembolso. por: Valor do reembolso. atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. type: array items: type: object @@ -2978,6 +3335,11 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do pagamento. bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. type: array items: type: object @@ -3653,238 +4015,538 @@ paths: eng: ID of the Mercado Pago account responsible for paying the commissions. spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - x-description-i18n: - eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object + payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object + properties: + credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. + type: array + items: properties: - campaign_id: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + x-description-i18n: + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_id: type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. + example: 12345432 + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + payment_method_id: type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". + example: "visa" + description: Identifier of the chosen payment method. x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - coupons: - description: Coupons can be used as a methods of payment in the transaction. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + installments: + type: number + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. + type: array + items: properties: - campaign_id: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + x-description-i18n: + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_id: type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. + example: 1234565432 + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. + type: array + items: + properties: amount: type: string - example: "100.00" - description: Total value of coupon. + example: "50.00" + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total value of coupon. - spa: Valor total del cupón. - por: Valor total do cupom. - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - coupons: - description: Coupons can be used as a methods of payment in the transaction. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: + type: number + example: 1234567654 + description: Payment identification associated with the payment method used. + x-description-i18n: + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. + type: array + items: type: object properties: - campaign_id: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. + example: 12345432423 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status_detail: + type: object + description: Detailed information about the status of the payment. + x-description-i18n: + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. + bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. + type: array + items: + type: object + properties: amount: type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". + example: "50.00" + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status_detail: + type: object + description: Detailed information about the status of the payment. + x-description-i18n: + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. responses: "200": description: accepted @@ -4407,8 +5069,19 @@ paths: spa: Monto de la transacción devuelto. por: Valor total reembolsado. payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. type: array items: properties: @@ -4525,6 +5198,11 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. type: array items: properties: @@ -4535,7 +5213,7 @@ paths: x-description-i18n: eng: Total amount to be paid with this payment method. spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" @@ -4547,11 +5225,11 @@ paths: payment_id: type: number example: 1234565432 - description: Payment identification associated with the payment method used. + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "debvisa" @@ -4563,9 +5241,9 @@ paths: issuer: type: string example: "23" - description: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: @@ -4613,7 +5291,7 @@ paths: description: Detail information about the status of the payment. x-description-i18n: eng: Information about the status of the payment. - spa: Información sobre el status del pago. + spa: Información detallada sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: code: @@ -4633,6 +5311,11 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. type: array items: properties: @@ -4724,6 +5407,11 @@ paths: spa: Monto del reembolso. por: Valor do reembolso. atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. type: array items: type: object @@ -4816,6 +5504,11 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do pagamento. bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. type: array items: type: object diff --git a/reference/api/transaction_intent_id.yaml b/reference/api/transaction_intent_id.yaml index 293e97c0fd..5d14760d8a 100644 --- a/reference/api/transaction_intent_id.yaml +++ b/reference/api/transaction_intent_id.yaml @@ -2971,10 +2971,10 @@ paths: put: tags: - $ref: '#/tags/checkout-api' - summary: Cancel a Transaction Intent + summary: Cancel Transaction Intent x-summary-i18n: - eng: Cancel a Transaction Intent - spa: Cancelar una Transaction Intent + eng: Cancel Transaction Intent + spa: Cancelar Transaction Intent por: Cancelar Transaction Intent description: This endpoint allows to cancel a Transaction Intent x-description-i18n: @@ -2988,22 +2988,22 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: path name: id schema: type: string required: true required: true - description: Alphanumeric ID of the Transaction Intent to get + description: Alphanumeric product ID, for example, 876542356788-mp. x-description-i18n: - eng: Alphanumeric ID of the Transaction Intent to get - spa: ID alfanumérico de la Transaction Intent a obtener - por: ID alfanumérico da Transaction Intent a ser obtida + eng: Alphanumeric product ID, for example, 876542356788-mp. + spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. + por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. responses: "200": description: success @@ -3015,190 +3015,199 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent + description: ID of a created Transaction Intent. x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent + description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação + eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the transaction intent + description: Current status of the Transaction Intent. x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação + eng: Current status of the Transaction Intent. + spa: Status actual de la Transaction Intent. + por: Status atual da Transaction Intent. enum: - - new--novo + - new--nova - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente - reverted--revertida - failed--falhou - - cancelled--cancelado + - cancelled--cancelada - authorized--autorizada init_point: type: string example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow + description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento + eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. type: object properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: visa, master - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier. For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier. For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a serem disponibilizadas. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a serem disponibilizadas. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" @@ -3209,126 +3218,131 @@ paths: por: Tipos de meios de pagamento a oferecer por padrão integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notification_url: type: string - description: URL to which notifications will be sent + description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). + por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). return_url_default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" return_url_success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. return_url_pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. return_url_failure: - description: URL to redirect the buyer in case of failed payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. + por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. order: type: object - description: Common Order attributes for request and response + description: Order containing all the essential information for the execution of a transaction. x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response + eng: Order containing all the essential information for the execution of a transaction. + spa: Orden que contiene toda la información esencial para la ejecución de una transacción. + por: Ordem contendo todas as informações essenciais para a execução de uma transação. properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" - description: Reference of the order + description: Reference of the order. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. description: type: string example: "my_order_description" - description: description for the order or transaction + description: Reason for the order or transaction. x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Reason for the order or transaction. + spa: Motivo de la orden o transacción. + por: Motivo da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction + description: Total amount to be paid. x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação + eng: Total amount to be paid. + spa: Monto total que se desea cobrar. + por: Valor total a ser pago. items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -3340,521 +3354,562 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. collectors: type: object - description: Seller user who receives the payment + description: Seller user who receives the payment. x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento + eng: Seller user who receives the payment. + spa: Usuario vendedor que recibe el pago. + por: Usuário vendedor que recebe o pagamento. properties: collector_id: type: number example: 123456789 - description: Collector identifier + description: Collector identifier. x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector + eng: Collector identifier. + spa: ID del collector. + por: Identificador do collector. amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector + description: Amount of the transaction corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector + eng: Amount of the transaction corresponding to the collector. + spa: Monto de la transacción que corresponde al collector. + por: Valor da transação correspondente ao collector. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip code. + spa: Código postal. + por: Código postal. phone: type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. properties: area_code: type: string + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. example: "11" number: type: string + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: ID of the Mercado Pago account responsible for paying the commissions. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: ID of the Mercado Pago account responsible for paying the commissions. + spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. + por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. amount_details: + description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object properties: total: type: string example: "123.00" - description: Details of the total value of the transaction + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. paid: type: string example: "100.00" - description: Total paid + description: Total paid. x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. refunded: type: string example: "100.00" - description: Total value refunded + description: Total value refunded. x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. shipment: type: string example: "10.00" - description: Total value charged per shipment + description: Total value charged per shipment. x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) + eng: Total value charged per shipment. + spa: Monto cobrado por envío (incluido en total). + por: Valor cobrado por envio (incluído no total). payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 12345432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 1234565432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 1234567654 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. type: array items: type: object @@ -3862,91 +3917,96 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 12345432423 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. type: array items: type: object @@ -3954,90 +4014,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 23421234543 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. "400": description: Error x-description-i18n: From 8d54eaea9608197af3cdb8457ca23fd6952dfb54 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 22 Aug 2023 16:35:22 -0300 Subject: [PATCH 30/40] description improvements --- reference/api/transaction_intent_id.yaml | 585 ++++++++++++----------- 1 file changed, 310 insertions(+), 275 deletions(-) diff --git a/reference/api/transaction_intent_id.yaml b/reference/api/transaction_intent_id.yaml index 5d14760d8a..b2b673431b 100644 --- a/reference/api/transaction_intent_id.yaml +++ b/reference/api/transaction_intent_id.yaml @@ -14,11 +14,11 @@ paths: eng: Get transaction intent by ID spa: Obtener transaction intent por ID por: Obter transaction intent por ID - description: Consult by ID retrieves an existing Transaction Intent + description: This endpoint allows you to retrieve an existing 'Transaction Intent' using its ID as a parameter x-description-i18n: - eng: Consult by ID retrieves an existing Transaction Intent - spa: Consultar por ID recupera una Transaction Intent existente - por: Consultar por ID recupera uma Transaction Intent existente + eng: This endpoint allows you to retrieve an existing 'Transaction Intent' using its ID as a parameter + spa: Este endpoint permite consultar una Transaction Intent ya existente mediante su ID + por: Este endpoint permite consultar uma Transaction Intent existente utilizando seu ID como parâmetro parameters: - in: header name: Authorization @@ -26,22 +26,22 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - name: id + description: Transaction Intent's Id. + x-description-i18n: + eng: Transaction Intent's Id. + spa: ID de la Transaction Intent. + por: ID da Transaction Intent. in: path required: true schema: type: string example: "00001njp2i" - description: Transaction Intent's Id - x-description-i18n: - eng: Transaction Intent's Id - spa: ID de la Transaction Intent - por: ID da Transaction Intent responses: "200": description: success @@ -53,231 +53,245 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent + description: ID of a created Transaction Intent. x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent + description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação + eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the transaction intent + description: Current status of the Transaction Intent. x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação + eng: Current status of the Transaction Intent. + spa: Status actual de la Transaction Intent. + por: Status atual da Transaction Intent. enum: - - new--novo + - new--nova - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente - reverted--revertida - failed--falhou - - cancelled--cancelado + - cancelled--cancelada - authorized--autorizada init_point: type: string example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow + description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento + eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: visa, master - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a oferecer. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a oferecer. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" - description: Payment method to offer by default + description: Types of payment methods to be offered by default. x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notifications: + description: Parameter related to the configuration of notification URLs for completed transactions. + x-description-i18n: + eng: Parameter related to the configuration of notification URLs for completed transactions. + spa: Parámetro relacionado con la configuración de las URLs de notificación para transacciones completadas. + por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object properties: notification_url: type: string - description: URL to which notifications will be sent + description: URL to which notifications will be sent. example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. return_url: type: object - description: Status URLs available to redirect buyer after completion of payment attempt + description: Status URLs available to redirect buyer after completion of payment attempt. x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + eng: Status URLs available to redirect buyer after completion of payment attempt. + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. properties: default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" success: @@ -285,107 +299,107 @@ paths: type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. failure: - description: URL to redirect the buyer in case of failed payment + description: Redirection URL for the event of buyer payment failure. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: Redirection URL for the event of buyer payment failure. + spa: URL de redirección para el caso de fallo en el pago del comprador. + por: URL de redirecionamento para o caso de falha no pagamento do comprador. integrator_id: type: number example: 34567 - description: Seller's identifier in the integrator's system + description: Seller's identifier in the integrator's system. x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador + eng: Seller's identifier in the integrator's system. + spa: Identificador del seller en el sistema del integrador. + por: Identificador do vendedor no sistema do integrador. order: type: object - description: Common Order attributes for request and response + description: Common Order attributes for request and response. x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" description: Reference of the order x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. reason: type: string example: "my_order_description" - description: Reason for the order or transaction + description: Reason for the order or transaction. x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Reason for the order or transaction. + spa: Motivo de la orden o transacción. + por: Motivo da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction + description: Total amount to be paid. x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação + eng: Total amount to be paid. + spa: Monto total que se desea cobrar. + por: Valor total a ser pago. items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order - x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -397,220 +411,241 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. collectors: type: object - description: Seller user who receives the payment + description: Seller user who receives the payment. x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento + eng: Seller user who receives the payment. + spa: Usuario vendedor que recibe el pago. + por: Usuário vendedor que recebe o pagamento. properties: collector_id: type: number example: 123456789 - description: Collector identifier + description: Collector identifier. x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector + eng: Collector identifier. + spa: Identificador del collector. + por: Identificador do collector. amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector + description: Amount of the transaction corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector + eng: Amount of the transaction corresponding to the collector. + spa: Monto de la transacción que corresponde al collector. + por: Valor da transação correspondente ao collector. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip code. + spa: Código postal. + por: Código postal. phone: - type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + type: object properties: area_code: + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. type: string example: "11" number: + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. type: string example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: type: object - description: Marketplace settings + description: In the event of a marketplace-type integration, this configuration is applicable to the collector. x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector + eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. + spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. + por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. properties: fee: type: string example: "5" - description: Percentage of commission charged to the collector + description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector + eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. + spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. + por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: ID of the Mercado Pago account responsible for paying the commissions. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: ID of the Mercado Pago account responsible for paying the commissions. + spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. + por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. amount_details: + description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object properties: total: type: string example: "123.00" - description: Details of the total value of the transaction + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. paid: type: string example: "100.00" - description: Total paid + description: Total paid. x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. refunded: type: string example: "100.00" - description: Total value refunded + description: Total value refunded. x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. shipment: type: string example: "10.00" - description: Total value charged per shipment + description: Total value charged per shipment. x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) + eng: Total value charged per shipment. + spa: Monto cobrado por envío (incluido en el otal). + por: Valor cobrado por envio (incluído no total). payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: credit_cards: type: array From cbb938203d915f61e113b0587f671d01e9d9b0f9 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 23 Aug 2023 11:51:05 -0300 Subject: [PATCH 31/40] parameteres descriptions fix and improvements --- reference/api/transaction_intent_id.yaml | 3826 ++++++++++++---------- 1 file changed, 2150 insertions(+), 1676 deletions(-) diff --git a/reference/api/transaction_intent_id.yaml b/reference/api/transaction_intent_id.yaml index b2b673431b..50df6fd175 100644 --- a/reference/api/transaction_intent_id.yaml +++ b/reference/api/transaction_intent_id.yaml @@ -648,321 +648,341 @@ paths: type: object properties: credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 12345432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 1234565432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 1234567654 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. type: array items: type: object @@ -970,91 +990,96 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 12345432423 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. type: array items: type: object @@ -1062,90 +1087,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 23421234543 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento - properties: - code: + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. "400": description: Error x-description-i18n: @@ -1203,28 +1228,28 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - name: id + description: ID of a created Transaction Intent. + x-description-i18n: + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. in: path required: true schema: type: string example: "00001njp2i" - description: Transaction Intent's Id - x-description-i18n: - eng: Transaction Intent's Id - spa: ID de la Transaction Intent - por: ID da Transaction Intent requestBody: - description: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. + description: Complete body of a Transaction Intent. You can modify as needed. When updating, only send the fields you wish to change or add. x-description-i18n: - eng: Complete body of a TI, which can be changed. It is not necessary to send all fields completed, only those you want to change or include. - spa: Cuerpo completo de una TI, que se puede cambiar. No es necesario enviar todos los campos completados, solo aquellos que desee modificar o incluir. - por: Corpo completo de uma TI, que pode ser alteradado. Não é necessário enviar todos os campos preenchidos, somente aqueles que deseja alterar ou incluir. + eng: Complete body of a Transaction Intent. You can modify as needed. When updating, only send the fields you wish to change or add. + spa: Body completo de una Transaction Intent. Puedes modificarla según lo necesites. Al actualizar, envía solo los campos que desees cambiar o agregar. + por: Body completo de uma Transaction Intent. Você pode modificar conforme necessário. Ao atualizar, envie apenas os campos que deseja alterar ou adicionar. content: application/json: schema: @@ -1232,307 +1257,326 @@ paths: properties: active_to_date: type: string - description: Close processing limit for transaction intent + description: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". x-description-i18n: - eng: Close processing limit for transaction intent - spa: Fecha límite de procesamiento para la intención de transacción - por: Data limite de processamento para a intenção de transação + eng: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Transaction Intent. Este plazo establece la fecha límite hasta la cual se espera que la Transaction Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Transaction Intent. Este prazo determina a data-limite até a qual se espera que a Transaction Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: options: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: payment_methods: type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a payment method during the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a payment method during the transaction. + spa: Los cupones se pueden utilizar como método de pago durante la transacción. + por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: [ "credit_card", "debit_card" ] - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. type: array example: [ "visa", "master" ] - description: Payment methods included items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier. For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier. For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a serem disponibilizadas. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a serem disponibilizadas. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: [ "ticket", "account_money" ] - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" - description: Payment method to offer by default + description: Types of payment methods to be offered by default. x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". example: [ "wallet_purchase", "onboarding_credits" ] integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notifications: + description: Parameter concerning notification URL settings for conducted transactions. + x-description-i18n: + eng: Parameter concerning notification URL settings for conducted transactions. + spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. + por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object properties: notification_url: type: string - description: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) + description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). x-description-i18n: - eng: URL that provides the integrator with updates on the status of your transaction (Webhooks and IPN) - spa: URL a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URL que fornece ao integrador atualizações sobre o status da sua transação (Webhooks e IPN) + eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). + por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). example: "https://www.integrator-site.com/api/notifications" return_url: type: object - description: Status URLs available to redirect buyer after completion of payment attempt + description: Status URLs available to redirect buyer after completion of payment attempt. x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento + eng: Status URLs available to redirect buyer after completion of payment attempt. + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. properties: default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. failure: - description: URL to redirect the buyer in case of failed payment + description: URL to redirect the buyer in case of failed payment. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: URL to redirect the buyer in case of failed payment. + spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. + por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. integrator_id: type: number example: 34567 - description: Seller's identifier in the integrator's system + description: Seller's identifier in the integrator's system. x-description-i18n: - eng: Seller's identifier in the integrator's system - spa: Identificador del seller en el sistema del integrador - por: Identificador do vendedor no sistema do integrador + eng: Seller's identifier in the integrator's system. + spa: Identificador del seller en el sistema del integrador. + por: Identificador do vendedor no sistema do integrador. order: - description: Order with all information to execute the transaction + description: Order containing all the essential information for the execution of a transaction. x-description-i18n: - eng: Order with all information to execute the transaction - spa: Orden con toda la información necesaria para poder ejecutar la transacción - por: Ordem com todas as informações necessárias para executar uma transação + eng: Order containing all the essential information for the execution of a transaction. + spa: Orden que contiene toda la información esencial para la ejecución de una transacción. + por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" - description: Reference of the order + description: Reference of the order. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. reason: type: string example: "my_order_description" - description: Reason for the order or transaction + description: Reason for the order or transaction. x-description-i18n: - eng: Reason for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Reason for the order or transaction. + spa: Motivo de la orden o transacción. + por: Motivo da ordem ou transação. amount: required: true type: string example: "50.00" - description: Total amount to be paid + description: Total amount to be paid. x-description-i18n: - eng: Total amount to be paid - spa: Monto total que se desea cobrar - por: Valor total a ser pago + eng: Total amount to be paid. + spa: Monto total que se desea cobrar. + por: Valor total a ser pago. items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -1544,393 +1588,703 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: required: true type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip code. + spa: Código postal. + por: Código postal. phone: type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. properties: area_code: type: string + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. example: "11" number: type: string + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: type: object - description: Marketplace settings + description: In the event of a marketplace-type integration, this configuration is applicable to the collector. x-description-i18n: - eng: Marketplace settings - spa: En caso de integración tipo Marketplace, configuración que aplica al collector - por: Configurações de Marketplace que se aplicam ao collector + eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. + spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. + por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. properties: fee: type: string example: "5" - description: Percentage of commission charged to the collector + description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. x-description-i18n: - eng: Percentage of commission charged to the collector - spa: Comisión del monto asignado al collector que le corresponde al Marketplace - por: Porcentagem da comissão cobrada ao collector + eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. + spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. + por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: ID of the Mercado Pago account responsible for paying the commissions. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões - payment_method: - properties: - credit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - installments: - type: number - description: Quantity of installments - x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - debit_cards: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data - x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - issuer: - type: string - example: "23" - description: In case it is required, identifier of the card issuer entity - x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement - x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão - tickets: - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object + eng: ID of the Mercado Pago account responsible for paying the commissions. + spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. + por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. + payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object + properties: + credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. + type: array + items: properties: - campaign_id: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + x-description-i18n: + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_id: type: number - example: 123456 - description: Campaign identifier number + example: 12345432 + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop - amount: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + payment_method_id: type: string - example: "100.00" - description: Total value of coupon + example: "visa" + description: Identifier of the chosen payment method. x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - atms: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação - type: object + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + installments: + type: number + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. + type: array + items: properties: - campaign_id: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + x-description-i18n: + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_id: type: number - example: 123456 - description: Campaign identifier number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status: + type: string + example: "pending" + description: Status of the payment. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. + type: array + items: + properties: amount: type: string - example: "100.00" - description: Total value of coupon + example: "50.00" + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom - bank_transfers: - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method - x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method - x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido - coupons: - description: Coupons can be used as a methods of payment in the transaction - x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: + type: number + example: 1234567654 + description: Payment identification associated with the payment method used. + x-description-i18n: + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + status_detail: + type: object + description: Detail information about the status of the payment. + x-description-i18n: + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. + type: array + items: type: object properties: - campaign_id: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "bapropagos" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: type: number - example: 123456 - description: Campaign identifier number + example: 12345432423 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status_detail: + type: object + description: Detailed information about the status of the payment. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. + bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. + type: array + items: + type: object + properties: amount: type: string - example: "100.00" - description: Total value of coupon + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + payment_id: + type: number + example: 23421234543 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + completion_url: + type: string + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + refunds: + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + type: object + properties: + refund_id: + type: number + example: 123456789 + description: Refund identifier. + x-description-i18n: + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. + status_detail: + type: object + description: Detailed information about the status of the payment. x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. + properties: + code: + type: string + example: "400" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "acquirer rejected" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. responses: "200": description: success @@ -1942,320 +2296,334 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent + description: ID of a created Transaction Intent. x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent + description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação + eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the transaction intent + description: Current status of the Transaction Intent. x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação + eng: Current status of the Transaction Intent. + spa: Status actual de la Transaction Intent. + por: Status atual da Transaction Intent. enum: - - new--novo + - new--nova - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente - reverted--revertida - failed--falhou - - cancelled--cancelado + - cancelled--cancelada - authorized--autorizada init_point: type: string example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow + description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento + eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: visa, master - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a oferecer. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a oferecer. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: + description: Types of payment methods to be offered by default. + x-description-i18n: + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. type: string example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notification_url: type: string - description: URL to which notifications will be sent + description: URL to which notifications will be sent. example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. return_url_default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" return_url_success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. return_url_pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. return_url_failure: - description: URL to redirect the buyer in case of failed payment + description: Redirection URL for the event of buyer payment failure. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: Redirection URL for the event of buyer payment failure. + spa: URL de redirección para el caso de fallo en el pago del comprador. + por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object - description: Common Order attributes for request and response + description: Common Order attributes for request and response. x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" description: Reference of the order x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. description: type: string example: "my_order_description" - description: description for the order or transaction + description: Description for the order or transaction. x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Description for the order or transaction. + spa: Descripción de la orden o transacción. + por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction + description: Total value of the transaction. For example, "233.00". x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação + eng: Total value of the transaction. For example, "233.00". + spa: Monto total de la transacción. Por ejemplo, "233.00".. + por: Valor total da transação. Por exemplo, "233.00". items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -2267,521 +2635,562 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. collectors: type: object - description: Seller user who receives the payment + description: Seller user who receives the payment. x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento + eng: Seller user who receives the payment. + spa: Usuario vendedor que recibe el pago. + por: Usuário vendedor que recebe o pagamento. properties: collector_id: type: number example: 123456789 - description: Collector identifier + description: Collector identifier. x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector + eng: Collector identifier. + spa: Identificador del collector. + por: Identificador do collector. amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector + description: Amount of the transaction corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector + eng: Amount of the transaction corresponding to the collector. + spa: Monto de la transacción que corresponde al collector. + por: Valor da transação correspondente ao collector. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: eng: Zip code - spa: Código postal - por: Código postal + spa: Código postal. + por: Código postal. phone: type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. properties: area_code: + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. type: string example: "11" number: + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. type: string example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. + spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. + por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: + description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object properties: total: type: string example: "123.00" - description: Details of the total value of the transaction + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. paid: type: string example: "100.00" - description: Total paid + description: Total paid. x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. refunded: type: string example: "100.00" - description: Total value refunded + description: Total value refunded. x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. shipment: type: string example: "10.00" - description: Total value charged per shipment + description: Total value charged per shipment. x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) + eng: Total value charged per shipment. + spa: Monto cobrado por envío (incluido en el otal). + por: Valor cobrado por envio (incluído no total). payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 12345432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso - refund_amount: - type: string + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. + refund_amount: + type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 1234565432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 1234567654 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. type: array items: type: object @@ -2789,91 +3198,96 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 12345432423 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. type: array items: type: object @@ -2881,90 +3295,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 23421234543 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. "400": description: Error x-description-i18n: @@ -4179,11 +4593,11 @@ paths: eng: Refund Transaction Intent spa: Reembolsar Transaction Intent por: Reembolsar Transaction Intent - description: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint + description: If a Transaction Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure x-description-i18n: - eng: If a Transaction Intent is successfully processed and the client wishes to initiate a cancellation, it will be possible to issue a refund through this endpoint - spa: Si una Transaction intent es procesada correctamente y el cliente desea realizar una cancelación, será posible efectuar un reembolso a través de este endpoint - por: Caso uma Transaction Intent seja devidamente processada e o cliente desejar efetuar um cancelamento, será possível efetuar um reembolso por meio deste endpoint + eng: If a Transaction Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure + spa: Si una Transaction Intent se procesa con éxito y el cliente decide cancelar, este endpoint permite iniciar un procedimiento de reembolso + por: Se uma Transaction Intent for processada com sucesso e o cliente optar pelo cancelamento, este endpoint oferece a capacidade de iniciar um procedimento de reembolso parameters: - in: header name: Authorization @@ -4191,22 +4605,22 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. + por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: path name: id schema: type: string required: true required: true - description: Alphanumeric ID of the Transaction Intent to get + description: Alphanumeric ID of the Transaction Intent to get. x-description-i18n: - eng: Alphanumeric ID of the Transaction Intent to get - spa: ID alfanumérico de la Transaction Intent a obtener - por: ID alfanumérico da Transaction Intent a ser obtida + eng: Alphanumeric ID of the Transaction Intent to get. + spa: ID alfanumérico de la Transaction Intent a obtener. + por: ID alfanumérico da Transaction Intent a ser obtida. responses: "200": description: success @@ -4218,320 +4632,334 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent + description: ID of a created Transaction Intent. x-description-i18n: - eng: ID of a created Transaction Intent - spa: ID de la intención de transacción creada - por: ID da intenção de transação criada + eng: ID of a created Transaction Intent. + spa: ID de la Transaction Intent creada. + por: ID da Transaction Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the transaction intent + description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the transaction intent - spa: Fecha de creación de la intención de transacción - por: Data de criação da intenção de transação + eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "reverted" - description: Current status of the transaction intent + description: Current status of the Transaction Intent. x-description-i18n: - eng: Current status of the transaction intent - spa: Estado actual de la intención de transacción - por: Estado atual da transação + eng: Current status of the Transaction Intent. + spa: Status actual de la Transaction Intent. + por: Status atual da Transaction Intent. enum: - - new--novo + - new--nova - transaction_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente - reverted--revertida - failed--falhou - - cancelled--cancelado + - cancelled--cancelada - authorized--autorizada init_point: type: string example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow + description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". x-description-i18n: - eng: URL that allows you to start the payment flow - spa: URL que permite iniciar el flujo de pago - por: URL que permite iniciar o fluxo de pagamento + eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Configuration parameters defined by the seller before starting the transaction + description: Predefined configuration parameters set by the seller before initiating the transaction. x-description-i18n: - eng: Configuration parameters defined by the seller before starting the transaction - spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción - por: Configuração definida pelo seller antes de iniciar a transação + eng: Predefined configuration parameters set by the seller before initiating the transaction. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller's configuration on options available in the transaction + description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. x-description-i18n: - eng: Seller's configuration on options available in the transaction - spa: Configuración del seller sobre opciones disponibles en la transacción - por: Configuração do vendedor sobre opções disponíveis na transação + eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options + description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas + eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. + por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object + description: Information related to the payment methods defined for the transaction. + x-description-i18n: + eng: Information related to the payment methods defined for the transaction. + spa: Información relacionada con los medios de pago definidos para la transacción. + por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction + description: Coupons can be used as a methods of payment in the transaction. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction - spa: Los cupones pueden ser utilizados como medio de pago en la transacción - por: Os cupons podem ser utilizados como meio de pagamento na transação + eng: Coupons can be used as a methods of payment in the transaction. + spa: Los cupones pueden ser utilizados como medio de pago en la transacción. + por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object properties: campaign_id: type: number example: 123456 - description: Campaign identifier number + description: Identifier number of the campaign to which the coupon is linked. x-description-i18n: - eng: Campaign identifier number - spa: Número identificador de la campaña - por: Número identificador da campanha a qual o cupom está vinculadop + eng: Identifier number of the campaign to which the coupon is linked. + spa: Número identificador de la campaña a la cual el cupón está vinculado. + por: Número de identificação da campanha à qual o cupom está associado. amount: type: string example: "100.00" - description: Total value of coupon + description: Total value of coupon. For example, "100.00". x-description-i18n: - eng: Total value of coupon - spa: Valor total del cupón - por: Valor total do cupom + eng: Total value of coupon. For example, "100.00". + spa: Valor total del cupón. Por ejemplo, "100.00". + por: Valor total do cupom. Por exemplo, "100.00". types: type: object - description: Configuration by payment method type + description: Configuration by payment method type. x-description-i18n: - eng: Configuration by payment method type - spa: Configuración por tipo de medio de pago - por: Configuração por tipo de meio de pagamento + eng: Configuration by payment method type. + spa: Configuración por tipo de medio de pago. + por: Configuração por tipo de meio de pagamento. properties: enabled: + description: List of Payment Types included. For example, credit_card, debit_card. + x-description-i18n: + eng: List of Payment Types included. For example, credit_card, debit_card. + spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. + por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. type: array items: type: string example: credit_card, debit_card - description: List of Payment Types included - x-description-i18n: - eng: List of Payment Types included - spa: Lista de tipos de medios de pago incluidos - por: Lista de tipos de meios de pagamento incluídos disabled: + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + x-description-i18n: + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". + por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array items: type: string example: "credit_card" - description: Types of payment methods not included - x-description-i18n: - eng: Types of payment methods not included - spa: Tipos de medios de pago no incluidos - por: Tipos de meios de pagamento não incluídos methods: type: object - description: Configuration by specific payment method + description: Configuration by specific payment method. x-description-i18n: - eng: Configuration by specific payment method - spa: Configuración por tipo específico de medio de pago - por: Configuração por tipo específico de meio de pagamento + eng: Configuration by specific payment method. + spa: Configuración por tipo específico de medio de pago. + por: Configuração por tipo específico de meio de pagamento. properties: enabled: type: array example: visa, master - description: Payment methods included + description: Payment methods included. + x-description-i18n: + eng: Payment methods included. + spa: Medios de pago incluidos. + por: Meios de pagamento incluídos. items: type: object properties: id: type: string - description: Payment method identifier + description: Payment method identifier For example, "credit_card". x-description-i18n: - eng: Payment method identifier - spa: Identificador del medio de pago - por: Identificador do meio de pagamento + eng: Payment method identifier For example, "credit_card". + spa: Identificador del medio de pago. Por ejemplo, "credit_card". + por: Identificador do meio de pagamento. Por exemplo, "credit_card". example: "credit_card" installments: type: object - description: Configuration of the number of installments to offer for the payment method + description: Configuration of the installment quantity to be offered for each payment method. x-description-i18n: - eng: Configuration of the number of installments to offer for the payment method - spa: Configuración de cantidad de cuotas a ofrecer para el tipo de medio de pago - por: Configuração de quantidade de parcelas a oferecer para o tipo de meio de pagamento + eng: Configuration of the installment quantity to be offered for each payment method. + spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. + por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. properties: default: - description: Default number of installments to offer + description: Number of installments to be offered by default. x-description-i18n: - eng: Default number of installments to offer - spa: Cantidad de cuotas a ofrecer por defecto - por: Quantidade de parcelas a oferecer por padrão + eng: Number of installments to be offered by default. + spa: Número de cuotas a ofrecer de forma predeterminada. + por: Número de parcelas a serem disponibilizadas por padrão. type: string example: "3" max: - description: Maximum number of installments to offer + description: Maximum number of installments to offer. x-description-i18n: - eng: Maximum number of installments to offer - spa: Cantidad máxima de cuotas a ofrecer - por: Quantidade máxima de parcelas a oferecer + eng: Maximum number of installments to offer. + spa: Cantidad máxima de cuotas a ofrecer. + por: Quantidade máxima de parcelas a oferecer. type: string example: "6" min: - description: Minimum number of installments to offer + description: Minimum number of installments to offer. x-description-i18n: - eng: Minimum number of installments to offer - spa: Cantidad mínima de cuotas a ofrecer - por: Quantidade mínima de parcelas a oferecer + eng: Minimum number of installments to offer. + spa: Cantidad mínima de cuotas a ofrecer. + por: Quantidade mínima de parcelas a oferecer. type: string example: "1" disabled: + description: Payment methods not included. + x-description-i18n: + eng: Payment methods not included. + spa: Medios de pago no incluidos. + por: Meios de pagamento não incluídos. type: array items: type: string example: ticket, account_money - description: Methods of payment not included - x-description-i18n: - eng: Methods of payment not included - spa: Métodos de pago no incluidos - por: Métodos de pagamento não incluídos default: type: string example: "credit_card" - description: Payment method to offer by default + description: Types of payment methods to be offered by default. x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão + eng: Types of payment methods to be offered by default. + spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. + por: Tipos de meios de pagamento a serem disponibilizados por padrão. integration: type: object - description: Configuration of the seller on integration + description: Configuration of the seller on integration. x-description-i18n: - eng: Configuration of the seller on integration - spa: Configuración del seller sobre la integración - por: Configuração do vendedor sobre a integração + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. properties: notification_url: type: string - description: URL to which notifications will be sent + description: URL to which notifications will be sent. example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: URL to which notifications will be sent - spa: URL a la cual se enviarán las notificaciones - por: URL para a qual as notificações serão enviadas + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. return_url_default: - description: Default URL to redirect the buyer + description: Default URL to redirect the buyer. x-description-i18n: - eng: Default URL to redirect the buyer - spa: URL por defecto a la cual se redireccionará al comprador - por: URL padrão para redirecionar o comprador + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. type: string example: "https://www.integrator-site.com/order" return_url_success: - description: URL to redirect the buyer in case of successful payment + description: URL to redirect the buyer in case of successful payment. type: string example: "https://www.integrator-site.com/order/success" x-description-i18n: - eng: URL to redirect the buyer in case of successful payment - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. return_url_pending: - description: URL to redirect the buyer in case of pending payment + description: URL to redirect the buyer in case of pending payment. type: string example: "https://www.integrator-site.com/order/pending" x-description-i18n: - eng: URL to redirect the buyer in case of pending payment - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente - por: URL para redirecionar o comprador em caso de pagamento pendente + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. return_url_failure: - description: URL to redirect the buyer in case of failed payment + description: Redirection URL for the event of buyer payment failure. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: URL to redirect the buyer in case of failed payment - spa: URL a la cual se redireccionará al comprador en caso de pago fallido - por: URL para redirecionar o comprador em caso de pagamento falhou + eng: Redirection URL for the event of buyer payment failure. + spa: URL de redirección para el caso de fallo en el pago del comprador. + por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object - description: Common Order attributes for request and response + description: Common Order attributes for request and response. x-description-i18n: - eng: Common Order attributes for request and response - spa: Atributos de Order comunes para el request y el response - por: Atributos de Order comuns para o request e o response + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. properties: id: type: number example: 123456789 - description: ID of the order previously created in the integrator's system + description: ID of the order previously created in the integrator's system. x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID de orden previamente creada en el sistema del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: ID of the order previously created in the integrator's system. + spa: ID de orden previamente creada en el sistema del integrador. + por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" description: Reference of the order x-description-i18n: - eng: ID of the order previously created in the integrator's system - spa: ID en sistema externo del integrador - por: ID da ordem criada anteriormente no sistema do integrador + eng: Reference of the order. + spa: Referencia de lá orden. + por: Referência da ordem. description: type: string example: "my_order_description" - description: description for the order or transaction + description: Description for the order or transaction. x-description-i18n: - eng: description for the order or transaction - spa: Motivo de la orden o transacción - por: Motivo da ordem ou transação + eng: Description for the order or transaction. + spa: Descripción de la orden o transacción. + por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction + description: Total value of the transaction. For example, "233.00". x-description-i18n: - eng: Total value of the transaction - spa: Monto total de la transacción - por: Valor total da transação + eng: Total value of the transaction. For example, "233.00". + spa: Monto total de la transacción. Por ejemplo, "233.00".. + por: Valor total da transação. Por exemplo, "233.00". items: + description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object - description: List of items included in the order + description: List of items included in the order. x-description-i18n: - eng: List of items included in the order - spa: Listado de ítems incluidos en la órden - por: Lista de itens incluídos no pedido + eng: List of items included in the order. + spa: Listado de ítems incluidos en la órden. + por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code + description: Item identification code. For example, "x76ax". x-description-i18n: - eng: Item identification code - spa: Código de identificación del ítem - por: Código de identificação do item + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". quantity: type: number example: 4 - description: Number of item included in the order + description: Number of item included in the order. x-description-i18n: - eng: Number of item included in the order - spa: Cantidad de ocurrencias del ítem incluidos en la órden - por: Quantidade de itens incluídos no pedido + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. unit_price: type: string example: "100.00" - description: Unit price of the item + description: Unit value of the item. For example, "100.00". x-description-i18n: - eng: Unit value of the item - spa: Precio unitario del ítem - por: Preço unitário do item + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". dimensions: type: string example: "30x30x30" @@ -4543,521 +4971,562 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the item that makes up the list of order items + description: Description of the items comprising the list of products included in the order. x-description-i18n: - eng: Description of the item that makes up the list of order items - spa: Descripción del artículo que componen el listado de items de la orden - por: Descrição do item que compõe a lista de itens do pedido + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. collectors: type: object - description: Seller user who receives the payment + description: Seller user who receives the payment. x-description-i18n: - eng: Seller user who receives the payment - spa: Usuario vendedor que recibe el pago - por: Usuário vendedor que recebe o pagamento + eng: Seller user who receives the payment. + spa: Usuario vendedor que recibe el pago. + por: Usuário vendedor que recebe o pagamento. properties: collector_id: type: number example: 123456789 - description: Collector identifier + description: Collector identifier. x-description-i18n: - eng: Collector identifier - spa: ID del collector - por: Identificador do collector + eng: Collector identifier. + spa: Identificador del collector. + por: Identificador do collector. amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector + description: Amount of the transaction corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector - spa: Monto de la transacción que corresponde al collector - por: Valor da transação correspondente ao collector + eng: Amount of the transaction corresponding to the collector. + spa: Monto de la transacción que corresponde al collector. + por: Valor da transação correspondente ao collector. payer: type: object - description: Buyer's information + description: Buyer's information. x-description-i18n: - eng: Buyer's information - spa: Información del comprador - por: Informações do comprador + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. properties: email: type: string - description: Buyer's email + description: Buyer's email. x-description-i18n: - eng: Buyer's email - spa: Email del comprador - por: Email do comprador + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. customer_id: type: number example: 123456 - description: ID of the Customer saved previously + description: Previously stored buyer identification number. x-description-i18n: - eng: ID of the Customer saved previously - spa: ID del Customer guardado anteriormente - por: Número de identificação do comprador salvo anteriormente + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. identification: type: object - description: Type and number of legal document that identifies the person in the country + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: Type and number of legal document that identifies the person in the country - spa: Tipo y número de documento legal que identifica a la persona en el país - por: Tipo e número de documento que identifica a pessoa no país + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: number: - description: Number of the document + description: Number of the document. x-description-i18n: - eng: Number of the document - spa: Número del documento - por: Número do documento + eng: Number of the document. + spa: Número del documento. + por: Número do documento. type: string example: "12345678098" type: - description: Type of the document + description: Type of the document. x-description-i18n: - eng: Type of the document - spa: Tipo de documento - por: Tipo de documento + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string example: "CPF" name: type: string example: "John" - description: Buyer's name + description: Buyer's name. x-description-i18n: - eng: Buyer's name - spa: Nombre del comprador - por: Nome do comprador + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. surname: type: string example: "Doe" - description: Buyer's surname + description: Buyer's surname. x-description-i18n: - eng: Buyer's surname - spa: Apellido del comprador - por: Sobrenome do comprador + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. address: type: object - description: Address of the buyer + description: Address of the buyer. x-description-i18n: - eng: Address of the buyer - spa: Dirección del comprador - por: Endereço do comprador + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. properties: street_name: type: string example: "Street MercadoLivre" - description: Street name + description: Street name. x-description-i18n: - eng: Street name - spa: Nombre de la calle - por: Nome da rua + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. street_number: type: string example: "100" - description: Street number + description: Street number. x-description-i18n: - eng: Street number - spa: Número de la calle - por: Número da casa + eng: Street number. + spa: Número de la calle. + por: Número da casa. zip_code: type: string example: "57000-865" - description: Zip code + description: Zip code. x-description-i18n: - eng: Zip code - spa: Código postal - por: Código postal + eng: Zip code. + spa: Código postal. + por: Código postal. phone: type: object - description: Buyer's phone number + description: Buyer's phone number. x-description-i18n: - eng: Buyer's phone number - spa: Número de teléfono del comprador - por: Número de telefone do comprador + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. properties: area_code: + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. type: string example: "11" number: + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. type: string example: "99999999" advanced: type: object - description: Options for advanced transaction + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced transaction - spa: Agrupación de opciones avanzadas para la transacción - por: Opções avançadas para a transação + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) + description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option) - spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona) - por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono) + eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: type: number example: 123456789 - description: ID of the Mercado Pago account that will pay the fees + description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. x-description-i18n: - eng: ID of the Mercado Pago account that will pay the fees - spa: ID de la cuenta de Mercado Pago que pagará las comisiones - por: ID da conta do Mercado Pago que pagará as comissões + eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. + spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. + por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: + description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object properties: total: type: string example: "123.00" - description: Details of the total value of the transaction + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the transaction - spa: Detalles del monto total de la transacción - por: Detalhes do valor total da transação + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. paid: type: string example: "100.00" - description: Total paid + description: Total paid. x-description-i18n: - eng: Total paid - spa: Monto de la transacción pagado - por: Valor pago + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. refunded: type: string example: "100.00" - description: Total value refunded + description: Total value refunded. x-description-i18n: - eng: Total value refunded - spa: Monto de la transacción devuelto - por: Valor reembolsado + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. shipment: type: string example: "10.00" - description: Total value charged per shipment + description: Total value charged per shipment. x-description-i18n: - eng: Total value charged per shipment - spa: Monto cobrado por envío (incluido en total) - por: Valor cobrado por envio (incluído no total) + eng: Total value charged per shipment. + spa: Monto cobrado por envío (incluido en el otal). + por: Valor cobrado por envio (incluído no total). payment_method: + description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object properties: credit_cards: - type: array - items: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. + type: array + items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 12345432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "visa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: type: number - description: Quantity of installments + description: Quantity of installments. x-description-i18n: - eng: Quantity of installments - spa: Cantidad de cuotas deseadas - por: Quantidade de parcelas desejadas + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. example: 1 statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string - example: "refunded" - description: Status of the payment + example: "pending" + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Card token that represents securely the credit card data - spa: card_token que representa de manera segura los datos de tarjeta - por: Card token que representa de maneira segura os dados do cartão + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number example: 1234565432 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. payment_method_id: type: string example: "debvisa" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. issuer: type: string example: "23" - description: In case it is required, identifier of the card issuer entity + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. x-description-i18n: - eng: In case it is required, identifier of the card issuer entity - spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta - por: Caso seja requerido, identificador da entidade emissora do cartão + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Descriptor of the charge to be shown in the card statement + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. x-description-i18n: - eng: descriptor of the charge to be shown in the card statement - spa: Descriptor del cargo a utilizar en el resumen del emisor - por: Descritor da cobrança a ser mostrada no extrato do cartão + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: ID of the refund. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. type: array items: properties: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "pec" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 1234567654 - description: Payment ID corresponding to the payment method + description: Payment identification associated with the payment method used. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment identification associated with the payment method used. + spa: Identificación de pago asociada al medio de pago utilizado. + por: Identificação de pagamento associada ao meio de pagamento utilizado. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. status_detail: type: object - description: Detail information about the status of the payment + description: Detail information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Information about the status of the payment. + spa: Información sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do Pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. type: array items: type: object @@ -5065,91 +5534,96 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "bapropagos" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 12345432423 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de reembolsos relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do pagamento. bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. type: array items: type: object @@ -5157,90 +5631,90 @@ paths: amount: type: string example: "50.00" - description: Total amount to be paid with this payment method + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Total amount to be paid with this payment method - spa: Monto a pagar con este medio - por: Valor total a ser pago com este meio de pagamento + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string example: "banco_mp" - description: Identifier of the chosen payment method + description: Identifier of the chosen payment method. x-description-i18n: - eng: Identifier of the chosen payment method - spa: Identificador del medio de pago elegido - por: Identificador do meio de pagamento escolhido + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. payment_id: type: number example: 23421234543 - description: Payment ID corresponding to the payment method + description: Payment ID corresponding to the payment method. x-description-i18n: - eng: Payment ID corresponding to the payment method - spa: ID de Pago correspondiente al medio - por: ID de pagamento correspondente ao meio de pagamento + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio de pago. + por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" - description: Status of the payment + description: Status of the payment. x-description-i18n: - eng: Status of the payment - spa: Estado del pago - por: Estado do pagamento + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. completion_url: type: string - description: For offline payments, URL that allows you to continue the payment flow + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: For offline payments, URL that allows you to continue the payment flow - spa: Para pagos offline, URL que permite continuar el flujo de pago - por: Para pagamentos offline, URL que permite continuar o fluxo de pagamento + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. refunds: - description: List of refunds related to the payment method + description: List of refunds related to the payment method. x-description-i18n: - eng: List of refunds related to the payment method - spa: Listado de devoluciones relacionadas al medio de pago - por: Lista de reembolsos relacionados ao meio de pagamento + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. type: object properties: refund_id: type: number example: 123456789 - description: ID of the refund + description: Refund identifier. x-description-i18n: - eng: ID of the refund - spa: ID de la devolución - por: ID do reembolso + eng: Refund identifier. + spa: Identificador del reembolso. + por: Identificador do reembolso. refund_amount: type: string example: "50.00" - description: Amount of the refund + description: Amount of the refund. x-description-i18n: - eng: Amount of the refund - spa: Monto de la devolución - por: Valor do reembolso + eng: Amount of the refund. + spa: Monto del reembolso. + por: Valor do reembolso. status_detail: type: object - description: Detail information about the status of the payment + description: Detailed information about the status of the payment. x-description-i18n: - eng: Information about the status of the payment - spa: Información sobre el resultado del procesamiento - por: Informações detalhadas sobre o status do pagamento + eng: Detailed information about the status of the payment. + spa: Información detallada sobre el status del pago. + por: Informações detalhadas sobre o status do pagamento. properties: code: type: string example: "400" - description: Status code + description: Payment status code. x-description-i18n: - eng: Status code - spa: Código del estado del pago - por: Código do Estado do Pagamento + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. message: type: string example: "acquirer rejected" - description: Status message + description: Payment status message. x-description-i18n: - eng: Status message - spa: Mensaje del estado del pago - por: Mensagem do Estado do Pagamento + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. "400": description: Error x-description-i18n: From df7e09842c06bb110f647915030f0f837c3c0fe2 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 30 Aug 2023 14:44:52 -0300 Subject: [PATCH 32/40] updated endpoint names --- ...action_intent.yaml => payment_intent.yaml} | 639 +++++++------- ..._intent_id.yaml => payment_intent_id.yaml} | 816 +++++++++--------- 2 files changed, 732 insertions(+), 723 deletions(-) rename reference/api/{transaction_intent.yaml => payment_intent.yaml} (92%) rename reference/api/{transaction_intent_id.yaml => payment_intent_id.yaml} (90%) diff --git a/reference/api/transaction_intent.yaml b/reference/api/payment_intent.yaml similarity index 92% rename from reference/api/transaction_intent.yaml rename to reference/api/payment_intent.yaml index 5468d2a875..cc3e090fed 100644 --- a/reference/api/transaction_intent.yaml +++ b/reference/api/payment_intent.yaml @@ -3,22 +3,22 @@ servers: - url: https://api.mercadopago.com info: title: Mercado Pago API Reference - version: '1.0' + version: "1.0" paths: - /v1/transaction-intents: + /v1/payment-intents: post: tags: - - $ref: '#/tags/checkout-api' - summary: Create Transaction Intent + - $ref: "#/tags/checkout-api" + summary: Create Payment Intent x-summary-i18n: - eng: Create Transaction Intent - spa: Crear Transaction Intent - por: Criar Transaction Intent - description: This endpoint enables the creation of a new Transaction Intent in Builder mode. Upon obtaining the ID of this Transaction Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint + eng: Create Payment Intent + spa: Crear Payment Intent + por: Criar Payment Intent + description: This endpoint enables the creation of a new Payment Intent in Builder mode. Upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint x-description-i18n: - eng: This endpoint enables the creation of a new Transaction Intent in Builder mode. Upon obtaining the ID of this Transaction Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint - spa: Este endpoint permite la creación de una nueva Transaction Intent en modo Builder. Al obtener el ID de esta Transaction Intent, es posible realizar ediciones a través del endpoint Patch y llevar a cabo el procesamiento utilizando el endpoint Process - por: Este endpoint possibilita a criação de uma nova Transaction Intent no modo Builder. Ao obter o ID desta Transaction Intent, é possível efetuar edições por meio do Endpoint Patch e realizar o processamento utilizando o Endpoint Process + eng: This endpoint enables the creation of a new Payment Intent in Builder mode. Upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint + spa: Este endpoint permite la creación de una nueva Payment Intent en modo Builder. Al obtener el ID de esta Payment Intent, es posible realizar ediciones a través del endpoint Patch y llevar a cabo el procesamiento utilizando el endpoint Process + por: Este endpoint possibilita a criação de uma nova Payment Intent no modo Builder. Ao obter o ID desta Payment Intent, é possível efetuar edições por meio do Endpoint Patch e realizar o processamento utilizando o Endpoint Process parameters: - in: header name: Authorization @@ -30,53 +30,43 @@ paths: x-description-i18n: eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. - por: Acess Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - - in: header - name: X-Product-ID - schema: - type: string - example: "876542356788-mp" - required: false - description: Alphanumeric product ID, for example, 876542356788-mp. - x-description-i18n: - eng: Alphanumeric product ID, for example, 876542356788-mp. - spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. - por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. + por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: header - name: X-Platform-ID + name: X-Integrator-ID schema: type: string required: false - description: Alphanumeric ID of the platform + description: Optinal ID for programmers or agencies who are part of the program. x-description-i18n: - eng: Alphanumeric ID of the platform - spa: Identificación alfanumérica de la plataforma. - por: Identificação alfanumérica da plataforma. + eng: Optinal ID for programmers or agencies who are part of the program. + spa: ID opcional para programadores o agencias que forman parte del programa . + por: ID opcional para programadores ou agências que fazem parte do programa . - in: header - name: X-Integrator-ID + name: X-Frontend-Token schema: - type: string - required: false - description: Alphanumeric ID of the integrator + type: boolean + example: false + allowEmptyValue: false + description: Frontend Token - Boolean value indicating whether you want the application to return the client_token property, this property allows you to make calls directly from your frontend passing the client_token as authorization. x-description-i18n: - eng: Alphanumeric ID of the integrator - spa: Identificación alfanumérica del integrador - por: Identificação alfanumérica do integrador + eng: Frontend Token - Boolean value indicating whether you want the application to return the client_token property, this property allows you to make calls directly from your frontend passing the client_token as authorization. + spa: Frontend Token - Valor booleano que indica si desea que la aplicación devuelva la propiedad client_token, esta propiedad le permite realizar llamadas directamente desde su frontend pasando el client_token como autorización. + por: Frontend Token - Valor booleano indicando se deseja que a aplicação retorne a propriedade client_token, está propriedade permite que realize chamadas diretamente do seu frontend passando como autorização o client_token. requestBody: - description: Complete body for a Transaction Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. + description: Complete body for a Payment Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. x-description-i18n: - eng: Complete body for a Transaction Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. - spa: Body completo para una solicitud de Transaction Intent en modo Builder. El requisito mínimo para este body es una solicitud que contenga la dirección de correo electrónico del pagador y el monto del pedido. - por: Body completo para uma requisição de Transaction Intent no modo Builder. O requisito mínimo para esse body consiste em um pedido contendo o endereço de e-mail do pagador e o valor do pedido. + eng: Complete body for a Payment Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. + spa: Body completo para una solicitud de Payment Intent en modo Builder. El requisito mínimo para este body es una solicitud que contenga la dirección de correo electrónico del pagador y el monto del pedido. + por: Body completo para uma requisição de Payment Intent no modo Builder. O requisito mínimo para esse body consiste em um pedido contendo o endereço de e-mail do pagador e o valor do pedido. content: application/json: schema: type: object properties: order: - description: Order containing all the essential information for the execution of a transaction. + description: Order containing all the essential information for the execution of a payment. x-description-i18n: - eng: Order containing all the essential information for the execution of a transaction. + eng: Order containing all the essential information for the execution of a payment. spa: Orden que contiene toda la información esencial para la ejecución de una transacción. por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object @@ -117,31 +107,31 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent. + description: ID of a created Payment Intent. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the Transaction Intent. + description: Current status of the Payment Intent. x-description-i18n: - eng: Current status of the Transaction Intent. - spa: Status actual de la Transaction Intent. - por: Status atual da Transaction Intent. + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. enum: - new--nova - - transaction_in_process--transação em processo + - payment_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -159,40 +149,40 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a payment method during the transaction. + description: Coupons can be used as a payment method during the payment. x-description-i18n: - eng: Coupons can be used as a payment method during the transaction. + eng: Coupons can be used as a payment method during the payment. spa: Los cupones se pueden utilizar como método de pago durante la transacción. por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object @@ -233,9 +223,9 @@ paths: example: credit_card, debit_card disabled: example: "credit_card" - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -393,25 +383,25 @@ paths: description: type: string example: "my_order_description" - description: Description for the order or transaction. + description: Description for the order or payment. x-description-i18n: - eng: Description for the order or transaction. + eng: Description for the order or payment. spa: Descripción de la orden o transacción. por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction. For example, "233.00". + description: Total value of the payment. For example, "233.00". x-description-i18n: - eng: Total value of the transaction. For example, "233.00". + eng: Total value of the payment. For example, "233.00". spa: Monto total de la transacción. Por ejemplo, "233.00". por: Valor total da transação. Por exemplo, "233.00". items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -480,9 +470,9 @@ paths: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector. + description: Amount of the payment corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector. + eng: Amount of the payment corresponding to the collector. spa: Monto de la transacción que corresponde al collector. por: Valor da transação correspondente ao collector. payer: @@ -607,18 +597,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: @@ -630,9 +620,9 @@ paths: spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: - description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. x-description-i18n: - eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object @@ -640,9 +630,9 @@ paths: total: type: string example: "123.00" - description: Details of the total value of the transaction. + description: Details of the total value of the payment. x-description-i18n: - eng: Details of the total value of the transaction. + eng: Details of the total value of the payment. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -670,9 +660,9 @@ paths: spa: Monto cobrado por envío (incluido en total). por: Valor cobrado por envio (incluído no total). payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -721,9 +711,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -737,11 +727,11 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -842,19 +832,19 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -1238,20 +1228,20 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. - /v1/transaction-intents/process: + /v1/payment-intents/process: post: tags: - $ref: '#/tags/checkout-api' - summary: Create and Process a Transaction Intent + summary: Create and Process a Payment Intent x-summary-i18n: - eng: Create and Process a Transaction Intent - spa: Crear y procesar Transaction Intent - por: Criar e processar Transaction Intent - description: This endppoint allows you to creates and process a new Transaction Intent + eng: Create and Process a Payment Intent + spa: Crear y procesar Payment Intent + por: Criar e processar Payment Intent + description: This endppoint allows you to creates and process a new Payment Intent x-description-i18n: - eng: This endppoint allows you to creates and rocess a new Transaction Intent - spa: Este endpoint permite crear y procesar una nueva Transaction Intent - por: Este endpoint permite criar e processar uma nova Transaction Intent + eng: This endppoint allows you to creates and rocess a new Payment Intent + spa: Este endpoint permite crear y procesar una nueva Payment Intent + por: Este endpoint permite criar e processar uma nova Payment Intent parameters: - in: header name: Authorization @@ -1264,43 +1254,22 @@ paths: eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - - in: header - name: X-Product-ID - schema: - type: string - example: "876542356788-mp" - required: false - description: Alphanumeric product ID, for example, 876542356788-mp. - x-description-i18n: - eng: Alphanumeric product ID, for example, 876542356788-mp. - spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. - por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. - - in: header - name: X-Platform-ID - schema: - type: string - required: false - description: Alphanumeric ID of the platform. - x-description-i18n: - eng: Alphanumeric ID of the platform. - spa: Identificación alfanumérica de la plataforma. - por: Identificação alfanumérica da plataforma. - in: header name: X-Integrator-ID schema: type: string required: false - description: Alphanumeric ID of the integrator + description: Optinal ID for programmers or agencies who are part of the program. x-description-i18n: - eng: Alphanumeric ID of the integrator - spa: Identificación alfanumérica del integrador - por: Identificação alfanumérica do integrador. + eng: Optinal ID for programmers or agencies who are part of the program. + spa: ID opcional para programadores o agencias que forman parte del programa . + por: ID opcional para programadores ou agências que fazem parte do programa . requestBody: - description: Complete body to create and process a Transaction Intent. + description: Complete body to create and process a Payment Intent. x-description-i18n: - eng: Complete body to create and process a Transaction Intent. - spa: Body completo para crear y procesar una Transaction Intent. - por: Body completo para criar e processar uma Transaction Intent. + eng: Complete body to create and process a Payment Intent. + spa: Body completo para crear y procesar una Payment Intent. + por: Body completo para criar e processar uma Payment Intent. content: application/json: schema: @@ -1308,42 +1277,42 @@ paths: properties: active_to_date: type: string - description: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + description: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". x-description-i18n: - eng: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - spa: Plazo máximo de procesamiento para la Transaction Intent. Este plazo establece la fecha límite hasta la cual se espera que la Transaction Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". - por: Prazo máximo de processamento para a Transaction Intent. Este prazo determina a data-limite até a qual se espera que a Transaction Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". + eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Payment Intent. Este prazo determina a data-limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: options: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: payment_methods: required: true type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a payment method during the transaction. + description: Coupons can be used as a payment method during the payment. x-description-i18n: - eng: Coupons can be used as a payment method during the transaction. + eng: Coupons can be used as a payment method during the payment. spa: Los cupones se pueden utilizar como método de pago durante la transacción. por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object @@ -1383,9 +1352,9 @@ paths: type: string example: [ "credit_card", "debit_card" ] disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -1471,9 +1440,9 @@ paths: por: Tipos de meios de pagamento a serem disponibilizados por padrão. purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + description: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + eng: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". example: [ "wallet_purchase", "onboarding_credits" ] @@ -1486,18 +1455,18 @@ paths: por: Configuração do seller sobre a integração. properties: notifications: - description: Parameter concerning notification URL settings for conducted transactions. + description: Parameter concerning notification URL settings for conducted payments. x-description-i18n: - eng: Parameter concerning notification URL settings for conducted transactions. + eng: Parameter concerning notification URL settings for conducted payments. spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object properties: notification_url: type: string - description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). example: "https://www.integrator-site.com/api/notifications" @@ -1550,9 +1519,9 @@ paths: spa: Identificador del seller en el sistema del integrador. por: Identificador do vendedor no sistema do integrador. order: - description: Order containing all the essential information for the execution of a transaction. + description: Order containing all the essential information for the execution of a payment. x-description-i18n: - eng: Order containing all the essential information for the execution of a transaction. + eng: Order containing all the essential information for the execution of a payment. spa: Orden que contiene toda la información esencial para la ejecución de una transacción. por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object @@ -1576,9 +1545,9 @@ paths: reason: type: string example: "my_order_description" - description: Reason for the order or transaction. + description: Reason for the order or payment. x-description-i18n: - eng: Reason for the order or transaction. + eng: Reason for the order or payment. spa: Motivo de la orden o transacción. por: Motivo da ordem ou transação. amount: @@ -1591,9 +1560,9 @@ paths: spa: Monto total que se desea cobrar. por: Valor total a ser pago. items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array @@ -1767,18 +1736,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: @@ -1806,9 +1775,9 @@ paths: spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -1857,9 +1826,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -1873,9 +1842,9 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -1978,17 +1947,17 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -2348,31 +2317,31 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent. + description: ID of a created Payment Intent. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the Transaction Intent. + description: Current status of the Payment Intent. x-description-i18n: - eng: Current status of the Transaction Intent. - spa: Status actual de la Transaction Intent. - por: Status atual da Transaction Intent. + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. enum: - new--nova - - transaction_in_process--transação em processo + - payment_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -2390,40 +2359,40 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + description: payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + eng: payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction. + description: Coupons can be used as a methods of payment in the payment. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. + eng: Coupons can be used as a methods of payment in the payment. spa: Los cupones pueden ser utilizados como medio de pago en la transacción. por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object @@ -2463,9 +2432,9 @@ paths: type: string example: credit_card, debit_card disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -2624,23 +2593,23 @@ paths: description: type: string example: "my_order_description" - description: Description for the order or transaction. + description: Description for the order or payment. x-description-i18n: - eng: Description for the order or transaction. + eng: Description for the order or payment. spa: Descripción de la orden o transacción. por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction. For example, "233.00". + description: Total value of the payment. For example, "233.00". x-description-i18n: - eng: Total value of the transaction. For example, "233.00". + eng: Total value of the payment. For example, "233.00". spa: Monto total de la transacción. Por ejemplo, "233.00".. por: Valor total da transação. Por exemplo, "233.00". items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array @@ -2711,9 +2680,9 @@ paths: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector. + description: Amount of the payment corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector. + eng: Amount of the payment corresponding to the collector. spa: Monto de la transacción que corresponde al collector. por: Valor da transação correspondente ao collector. payer: @@ -2837,18 +2806,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: @@ -2860,9 +2829,9 @@ paths: spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: - description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. x-description-i18n: - eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object @@ -2870,9 +2839,9 @@ paths: total: type: string example: "123.00" - description: Details of the total value of the transaction. + description: Details of the total value of the payment. x-description-i18n: - eng: Details of the total value of the transaction. + eng: Details of the total value of the payment. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -2900,9 +2869,9 @@ paths: spa: Monto cobrado por envío (incluido en el otal). por: Valor cobrado por envio (incluído no total). payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -2951,9 +2920,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -2967,9 +2936,9 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -3072,17 +3041,17 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -3468,20 +3437,20 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. - /v1/transaction-intents/authorize: + /v1/payment-intents/authorize: post: tags: - $ref: '#/tags/checkout-api' - summary: Authorize payments for a Transaction Intent + summary: Authorize payments for a Payment Intent x-summary-i18n: - eng: Authorize payments for a Transaction Intent - spa: Autorizar pagos de una Transaction Intent - por: Autorizar pagamentos de uma Transaction Intent - description: This endpoint enables the authorization of payments for an existing Transaction Intent + eng: Authorize payments for a Payment Intent + spa: Autorizar pagos de una Payment Intent + por: Autorizar pagamentos de uma Payment Intent + description: This endpoint enables the authorization of payments for an existing Payment Intent x-description-i18n: - eng: This endpoint enables the authorization of payments for an existing Transaction Intent - spa: Este endpoint permite la autorización de pagos para una Transaction Intent ya existente - por: Este endpoint possibilita a autorização de pagamentos para uma Transaction Intent já existente + eng: This endpoint enables the authorization of payments for an existing Payment Intent + spa: Este endpoint permite la autorización de pagos para una Payment Intent ya existente + por: Este endpoint possibilita a autorização de pagamentos para uma Payment Intent já existente parameters: - in: header name: Authorization @@ -3495,22 +3464,21 @@ paths: spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: header - name: X-Product-ID + name: X-Integrator-ID schema: type: string - example: "876542356788-mp" required: false - description: Alphanumeric product ID, for example, 876542356788-mp. + description: Optinal ID for programmers or agencies who are part of the program. x-description-i18n: - eng: Alphanumeric product ID, for example, 876542356788-mp. - spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. - por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. + eng: Optinal ID for programmers or agencies who are part of the program. + spa: ID opcional para programadores o agencias que forman parte del programa . + por: ID opcional para programadores ou agências que fazem parte do programa . requestBody: - description: Complete body for authorizing payments of a Transaction Intent. + description: Complete body for authorizing payments of a Payment Intents. x-description-i18n: - eng: Complete body for authorizing payments of a Transaction Intent. - spa: Body completo para autorizar los pagos de una Transaction Intent. - por: Body completo para autorização de pagamentos de uma Transaction Intent. + eng: Complete body for authorizing payments of a Payment Intents. + spa: Body completo para autorizar los pagos de una Payment Intents. + por: Body completo para autorização de pagamentos de uma Payment Intents. content: application/json: schema: @@ -3518,42 +3486,42 @@ paths: properties: active_to_date: type: string - description: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + description: Maximum processing deadline for the payment intents. This deadline sets the date by which the Payment Intents is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". x-description-i18n: - eng: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - spa: Plazo máximo de procesamiento para la Transaction Intent. Este plazo establece la fecha límite hasta la cual se espera que la Transaction Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". - por: Prazo máximo de processamento para a Transaction Intent. Este prazo determina a data-limite até a qual se espera que a Transaction Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". + eng: Maximum processing deadline for the payment intents. This deadline sets the date by which the Payment Intents is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intents. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intents sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Payment Intents. Este prazo determina a data-limite até a qual se espera que a Payment Intents seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: options: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: payment_methods: required: true type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a payment method during the transaction. + description: Coupons can be used as a payment method during the payment. x-description-i18n: - eng: Coupons can be used as a payment method during the transaction. + eng: Coupons can be used as a payment method during the payment. spa: Los cupones se pueden utilizar como método de pago durante la transacción. por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object @@ -3593,9 +3561,9 @@ paths: type: string example: [ "credit_card", "debit_card" ] disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -3681,9 +3649,9 @@ paths: por: Tipos de meios de pagamento a serem disponibilizados por padrão. purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + description: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + eng: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". example: [ "wallet_purchase", "onboarding_credits" ] @@ -3696,18 +3664,18 @@ paths: por: Configuração do seller sobre a integração. properties: notifications: - description: Parameter concerning notification URL settings for conducted transactions. + description: Parameter concerning notification URL settings for conducted payments. x-description-i18n: - eng: Parameter concerning notification URL settings for conducted transactions. + eng: Parameter concerning notification URL settings for conducted payments. spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object properties: notification_url: type: string - description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). example: "https://www.integrator-site.com/api/notifications" @@ -3760,9 +3728,9 @@ paths: spa: Identificador del seller en el sistema del integrador. por: Identificador do seller no sistema do integrador. order: - description: Order containing all the essential information for the execution of a transaction. + description: Order containing all the essential information for the execution of a payment. x-description-i18n: - eng: Order containing all the essential information for the execution of a transaction. + eng: Order containing all the essential information for the execution of a payment. spa: Orden que contiene toda la información esencial para la ejecución de una transacción. por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object @@ -3786,9 +3754,9 @@ paths: reason: type: string example: "my_order_description" - description: Reason for the order or transaction. + description: Reason for the order or payment. x-description-i18n: - eng: Reason for the order or transaction. + eng: Reason for the order or payment. spa: Motivo de la orden o transacción. por: Motivo da ordem ou transação. amount: @@ -3801,9 +3769,9 @@ paths: spa: Monto total que se desea cobrar. por: Valor total a ser pago. items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array @@ -3977,18 +3945,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: @@ -4016,9 +3984,9 @@ paths: spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -4067,9 +4035,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -4083,9 +4051,9 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -4188,17 +4156,17 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -4558,31 +4526,31 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent. + description: ID of a created Payment Intents. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intents. + spa: ID de la Payment Intents creada. + por: ID da Payment Intents criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment Intents. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment Intents. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intents. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intents. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the Transaction Intent. + description: Current status of the Payment Intents. x-description-i18n: - eng: Current status of the Transaction Intent. - spa: Status actual de la Transaction Intent. - por: Status atual da Transaction Intent. + eng: Current status of the Payment Intents. + spa: Status actual de la Payment Intents. + por: Status atual da Payment Intents. enum: - new--nova - - transaction_in_process--transação em processo + - payment_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -4600,39 +4568,39 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. payment_methods: type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction. + description: Coupons can be used as a methods of payment in the payment. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. + eng: Coupons can be used as a methods of payment in the payment. spa: Los cupones pueden ser utilizados como medio de pago en la transacción. por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object @@ -4672,9 +4640,9 @@ paths: type: string example: credit_card, debit_card disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -4833,23 +4801,23 @@ paths: description: type: string example: "my_order_description" - description: Description for the order or transaction. + description: Description for the order or payment. x-description-i18n: - eng: Description for the order or transaction. + eng: Description for the order or payment. spa: Descripción de la orden o transacción. por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction. For example, "233.00". + description: Total value of the payment. For example, "233.00". x-description-i18n: - eng: Total value of the transaction. For example, "233.00". + eng: Total value of the payment. For example, "233.00". spa: Monto total de la transacción. Por ejemplo, "233.00".. por: Valor total da transação. Por exemplo, "233.00". items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array @@ -4912,9 +4880,9 @@ paths: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector. + description: Amount of the payment corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector. + eng: Amount of the payment corresponding to the collector. spa: Monto de la transacción que corresponde al collector. por: Valor da transação correspondente ao collector. payer: @@ -5014,18 +4982,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: @@ -5037,9 +5005,9 @@ paths: spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. amount_details: - description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. x-description-i18n: - eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object @@ -5047,9 +5015,9 @@ paths: total: type: string example: "123.00" - description: Details of the total value of the transaction. + description: Details of the total value of the payment. x-description-i18n: - eng: Details of the total value of the transaction. + eng: Details of the total value of the payment. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -5069,9 +5037,9 @@ paths: spa: Monto de la transacción devuelto. por: Valor total reembolsado. payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -5120,9 +5088,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -5136,9 +5104,9 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -5241,17 +5209,17 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -5637,3 +5605,4 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. + diff --git a/reference/api/transaction_intent_id.yaml b/reference/api/payment_intent_id.yaml similarity index 90% rename from reference/api/transaction_intent_id.yaml rename to reference/api/payment_intent_id.yaml index 50df6fd175..b1ab6c258c 100644 --- a/reference/api/transaction_intent_id.yaml +++ b/reference/api/payment_intent_id.yaml @@ -3,22 +3,22 @@ servers: - url: https://api.mercadopago.com info: title: Mercado Pago API Reference - version: '1.0' + version: "1.0" paths: - /v1/transaction-intents/{id}: + /v1/payment-intents/{id}: get: tags: - $ref: "#/tags/checkout-api" - summary: Get transaction intent by ID + summary: Get payment intent by ID x-summary-i18n: - eng: Get transaction intent by ID - spa: Obtener transaction intent por ID - por: Obter transaction intent por ID - description: This endpoint allows you to retrieve an existing 'Transaction Intent' using its ID as a parameter + eng: Get payment intent by ID + spa: Obtener payment intent por ID + por: Obter payment intent por ID + description: This endpoint allows you to retrieve an existing 'Payment Intent' using its ID as a parameter x-description-i18n: - eng: This endpoint allows you to retrieve an existing 'Transaction Intent' using its ID as a parameter - spa: Este endpoint permite consultar una Transaction Intent ya existente mediante su ID - por: Este endpoint permite consultar uma Transaction Intent existente utilizando seu ID como parâmetro + eng: This endpoint allows you to retrieve an existing 'Payment Intent' using its ID as a parameter + spa: Este endpoint permite consultar una Payment Intent ya existente mediante su ID + por: Este endpoint permite consultar uma Payment Intent existente utilizando seu ID como parâmetro parameters: - in: header name: Authorization @@ -31,12 +31,22 @@ paths: eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. + - in: header + name: X-Integrator-ID + schema: + type: string + required: false + description: Optinal ID for programmers or agencies who are part of the program. + x-description-i18n: + eng: Optinal ID for programmers or agencies who are part of the program. + spa: ID opcional para programadores o agencias que forman parte del programa . + por: ID opcional para programadores ou agências que fazem parte do programa . - name: id - description: Transaction Intent's Id. + description: Payment Intent's Id. x-description-i18n: - eng: Transaction Intent's Id. - spa: ID de la Transaction Intent. - por: ID da Transaction Intent. + eng: Payment Intent's Id. + spa: ID de la Payment Intent. + por: ID da Payment Intent. in: path required: true schema: @@ -53,31 +63,31 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent. + description: ID of a created Payment Intent. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the Transaction Intent. + description: Current status of the Payment Intent. x-description-i18n: - eng: Current status of the Transaction Intent. - spa: Status actual de la Transaction Intent. - por: Status atual da Transaction Intent. + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. enum: - new--nova - - transaction_in_process--transação em processo + - payment_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -95,40 +105,40 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction. + description: Coupons can be used as a methods of payment in the payment. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. + eng: Coupons can be used as a methods of payment in the payment. spa: Los cupones pueden ser utilizados como medio de pago en la transacción. por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object @@ -168,9 +178,9 @@ paths: type: string example: credit_card, debit_card disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -263,9 +273,9 @@ paths: por: Configuração do seller sobre a integração. properties: notifications: - description: Parameter related to the configuration of notification URLs for completed transactions. + description: Parameter related to the configuration of notification URLs for completed payments. x-description-i18n: - eng: Parameter related to the configuration of notification URLs for completed transactions. + eng: Parameter related to the configuration of notification URLs for completed payments. spa: Parámetro relacionado con la configuración de las URLs de notificación para transacciones completadas. por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object @@ -353,9 +363,9 @@ paths: reason: type: string example: "my_order_description" - description: Reason for the order or transaction. + description: Reason for the order or payment. x-description-i18n: - eng: Reason for the order or transaction. + eng: Reason for the order or payment. spa: Motivo de la orden o transacción. por: Motivo da ordem ou transação. amount: @@ -367,11 +377,11 @@ paths: spa: Monto total que se desea cobrar. por: Valor total a ser pago. items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -435,9 +445,9 @@ paths: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector. + description: Amount of the payment corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector. + eng: Amount of the payment corresponding to the collector. spa: Monto de la transacción que corresponde al collector. por: Valor da transação correspondente ao collector. payer: @@ -561,18 +571,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: @@ -600,9 +610,9 @@ paths: spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. amount_details: - description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. x-description-i18n: - eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object @@ -610,9 +620,9 @@ paths: total: type: string example: "123.00" - description: Details of the total value of the transaction. + description: Details of the total value of the payment. x-description-i18n: - eng: Details of the total value of the transaction. + eng: Details of the total value of the payment. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -640,9 +650,9 @@ paths: spa: Monto cobrado por envío (incluido en el otal). por: Valor cobrado por envio (incluído no total). payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -691,9 +701,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -707,11 +717,11 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -812,19 +822,19 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -1211,16 +1221,16 @@ paths: patch: tags: - $ref: '#/tags/checkout-api' - summary: Modify Transaction Intent + summary: Modify Payment Intent x-summary-i18n: - eng: Modify Transaction Intent - spa: Modificar Transaction Intent - por: Modificar Transaction Intent - description: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It iss important to note that it is not necessary to send all fields filled, only those you want to modify or add + eng: Modify Payment Intent + spa: Modificar Payment Intent + por: Modificar Payment Intent + description: This endpoint allows for the modification of a Payment Intent created in Builder mode. By using the Payment Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It iss important to note that it is not necessary to send all fields filled, only those you want to modify or add x-description-i18n: - eng: This endpoint allows for the modification of a Transaction Intent created in Builder mode. By using the Transaction Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It is important to note that it is not necessary to send all fields filled, only those you want to modify or add - spa: Este endpoint permite la modificación de una Transaction Intent creada en el modo Builder. Utilizando el ID de la Transaction Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos, solo aquellos que desea modificar o agregar - por: Este endpoint possibilita a modificação de uma Transaction Intent criada no modo Builder. Utilizando o ID da Transaction Intent, é possível realizar edições por meio do endpoint PATCH. Isso permite a alteração ou adição de campos no corpo da intenção antes de seu processamento. É importante observar que não é obrigatório enviar todos os campos preenchidos, apenas aqueles que você deseja modificar ou acrescentar + eng: This endpoint allows for the modification of a Payment Intent created in Builder mode. By using the Payment Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It is important to note that it is not necessary to send all fields filled, only those you want to modify or add + spa: Este endpoint permite la modificación de una Payment Intent creada en el modo Builder. Utilizando el ID de la Payment Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos, solo aquellos que desea modificar o agregar + por: Este endpoint possibilita a modificação de uma Payment Intent criada no modo Builder. Utilizando o ID da Payment Intent, é possível realizar edições por meio do endpoint PATCH. Isso permite a alteração ou adição de campos no corpo da intenção antes de seu processamento. É importante observar que não é obrigatório enviar todos os campos preenchidos, apenas aqueles que você deseja modificar ou acrescentar parameters: - in: header name: Authorization @@ -1233,23 +1243,33 @@ paths: eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. + - in: header + name: X-Integrator-ID + schema: + type: string + required: false + description: Optinal ID for programmers or agencies who are part of the program. + x-description-i18n: + eng: Optinal ID for programmers or agencies who are part of the program. + spa: ID opcional para programadores o agencias que forman parte del programa . + por: ID opcional para programadores ou agências que fazem parte do programa . - name: id - description: ID of a created Transaction Intent. + description: ID of a created Payment Intent. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. in: path required: true schema: type: string example: "00001njp2i" requestBody: - description: Complete body of a Transaction Intent. You can modify as needed. When updating, only send the fields you wish to change or add. + description: Complete body of a Payment Intent. You can modify as needed. When updating, only send the fields you wish to change or add. x-description-i18n: - eng: Complete body of a Transaction Intent. You can modify as needed. When updating, only send the fields you wish to change or add. - spa: Body completo de una Transaction Intent. Puedes modificarla según lo necesites. Al actualizar, envía solo los campos que desees cambiar o agregar. - por: Body completo de uma Transaction Intent. Você pode modificar conforme necessário. Ao atualizar, envie apenas os campos que deseja alterar ou adicionar. + eng: Complete body of a Payment Intent. You can modify as needed. When updating, only send the fields you wish to change or add. + spa: Body completo de una Payment Intent. Puedes modificarla según lo necesites. Al actualizar, envía solo los campos que desees cambiar o agregar. + por: Body completo de uma Payment Intent. Você pode modificar conforme necessário. Ao atualizar, envie apenas os campos que deseja alterar ou adicionar. content: application/json: schema: @@ -1257,41 +1277,41 @@ paths: properties: active_to_date: type: string - description: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + description: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". x-description-i18n: - eng: Maximum processing deadline for the transaction intent. This deadline sets the date by which the Transaction Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - spa: Plazo máximo de procesamiento para la Transaction Intent. Este plazo establece la fecha límite hasta la cual se espera que la Transaction Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". - por: Prazo máximo de processamento para a Transaction Intent. Este prazo determina a data-limite até a qual se espera que a Transaction Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". + eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Payment Intent. Este prazo determina a data-limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: options: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: payment_methods: type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a payment method during the transaction. + description: Coupons can be used as a payment method during the payment. x-description-i18n: - eng: Coupons can be used as a payment method during the transaction. + eng: Coupons can be used as a payment method during the payment. spa: Los cupones se pueden utilizar como método de pago durante la transacción. por: Os cupons podem ser utilizados como forma de pagamento durante a transação. type: object @@ -1331,9 +1351,9 @@ paths: type: string example: [ "credit_card", "debit_card" ] disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -1419,9 +1439,9 @@ paths: por: Tipos de meios de pagamento a serem disponibilizados por padrão. purpose: type: string - description: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + description: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". x-description-i18n: - eng: Identifier of the purpose of the transaction, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". + eng: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". example: [ "wallet_purchase", "onboarding_credits" ] @@ -1434,18 +1454,18 @@ paths: por: Configuração do seller sobre a integração. properties: notifications: - description: Parameter concerning notification URL settings for conducted transactions. + description: Parameter concerning notification URL settings for conducted payments. x-description-i18n: - eng: Parameter concerning notification URL settings for conducted transactions. + eng: Parameter concerning notification URL settings for conducted payments. spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. type: object properties: notification_url: type: string - description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). + eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). example: "https://www.integrator-site.com/api/notifications" @@ -1498,9 +1518,9 @@ paths: spa: Identificador del seller en el sistema del integrador. por: Identificador do vendedor no sistema do integrador. order: - description: Order containing all the essential information for the execution of a transaction. + description: Order containing all the essential information for the execution of a payment. x-description-i18n: - eng: Order containing all the essential information for the execution of a transaction. + eng: Order containing all the essential information for the execution of a payment. spa: Orden que contiene toda la información esencial para la ejecución de una transacción. por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object @@ -1524,9 +1544,9 @@ paths: reason: type: string example: "my_order_description" - description: Reason for the order or transaction. + description: Reason for the order or payment. x-description-i18n: - eng: Reason for the order or transaction. + eng: Reason for the order or payment. spa: Motivo de la orden o transacción. por: Motivo da ordem ou transação. amount: @@ -1539,9 +1559,9 @@ paths: spa: Monto total que se desea cobrar. por: Valor total a ser pago. items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array @@ -1715,18 +1735,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. marketplace: @@ -1754,9 +1774,9 @@ paths: spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -1805,9 +1825,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -1821,9 +1841,9 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -1926,17 +1946,17 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -2296,31 +2316,31 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent. + description: ID of a created Payment Intent. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the Transaction Intent. + description: Current status of the Payment Intent. x-description-i18n: - eng: Current status of the Transaction Intent. - spa: Status actual de la Transaction Intent. - por: Status atual da Transaction Intent. + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. enum: - new--nova - - transaction_in_process--transação em processo + - payment_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -2338,40 +2358,40 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction. + description: Coupons can be used as a methods of payment in the payment. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. + eng: Coupons can be used as a methods of payment in the payment. spa: Los cupones pueden ser utilizados como medio de pago en la transacción. por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object @@ -2411,9 +2431,9 @@ paths: type: string example: credit_card, debit_card disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -2572,23 +2592,23 @@ paths: description: type: string example: "my_order_description" - description: Description for the order or transaction. + description: Description for the order or payment. x-description-i18n: - eng: Description for the order or transaction. + eng: Description for the order or payment. spa: Descripción de la orden o transacción. por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction. For example, "233.00". + description: Total value of the payment. For example, "233.00". x-description-i18n: - eng: Total value of the transaction. For example, "233.00". + eng: Total value of the payment. For example, "233.00". spa: Monto total de la transacción. Por ejemplo, "233.00".. por: Valor total da transação. Por exemplo, "233.00". items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array @@ -2659,9 +2679,9 @@ paths: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector. + description: Amount of the payment corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector. + eng: Amount of the payment corresponding to the collector. spa: Monto de la transacción que corresponde al collector. por: Valor da transação correspondente ao collector. payer: @@ -2785,18 +2805,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: @@ -2808,9 +2828,9 @@ paths: spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: - description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. x-description-i18n: - eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object @@ -2818,9 +2838,9 @@ paths: total: type: string example: "123.00" - description: Details of the total value of the transaction. + description: Details of the total value of the payment. x-description-i18n: - eng: Details of the total value of the transaction. + eng: Details of the total value of the payment. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -2848,9 +2868,9 @@ paths: spa: Monto cobrado por envío (incluido en el otal). por: Valor cobrado por envio (incluído no total). payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -2899,9 +2919,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -2915,9 +2935,9 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -3020,17 +3040,17 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: @@ -3416,20 +3436,20 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. - /v1/transaction-intents/{id}/cancel: + /v1/payment-intents/{id}/cancel: put: tags: - - $ref: '#/tags/checkout-api' - summary: Cancel Transaction Intent + - $ref: "#/tags/checkout-api" + summary: Cancel Payment Intent x-summary-i18n: - eng: Cancel Transaction Intent - spa: Cancelar Transaction Intent - por: Cancelar Transaction Intent - description: This endpoint allows to cancel a Transaction Intent + eng: Cancel Payment Intent + spa: Cancelar Payment Intent + por: Cancelar Payment Intent + description: This endpoint allows to cancel a Payment Intent x-description-i18n: - eng: This endpoint allows to cancel a Transaction Intent - spa: Este endpoint permite cancelar una Transaction Intent - por: Este endpoint permite cancelar uma Transaction Intent + eng: This endpoint allows to cancel a Payment Intent + spa: Este endpoint permite cancelar una Payment Intent + por: Este endpoint permite cancelar uma Payment Intent parameters: - in: header name: Authorization @@ -3439,9 +3459,19 @@ paths: required: true description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. + - in: header + name: X-Integrator-ID + schema: + type: string + required: false + description: Optinal ID for programmers or agencies who are part of the program. + x-description-i18n: + eng: Optinal ID for programmers or agencies who are part of the program. + spa: Opción de ID para programadores o agencias que forman parte del programa . + por: ID opcional para programadores ou agências que fazem parte do programa . - in: path name: id schema: @@ -3464,31 +3494,31 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent. + description: ID of a created Payment Intent. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the Transaction Intent. + description: Current status of the Payment Intent. x-description-i18n: - eng: Current status of the Transaction Intent. - spa: Status actual de la Transaction Intent. - por: Status atual da Transaction Intent. + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. enum: - new--nova - - transaction_in_process--transação em processo + - payment_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -3506,40 +3536,40 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. type: object properties: coupons: - description: Coupons can be used as a methods of payment in the transaction. + description: Coupons can be used as a methods of payment in the payment. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. + eng: Coupons can be used as a methods of payment in the payment. spa: Los cupones pueden ser utilizados como medio de pago en la transacción. por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object @@ -3579,9 +3609,9 @@ paths: type: string example: credit_card, debit_card disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -3673,51 +3703,51 @@ paths: spa: Configuración del seller sobre la integración. por: Configuração do seller sobre a integração. properties: - notification_url: - type: string - description: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their transaction through Webhooks and Instant Payment Notifications (IPN). - spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). - por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). - return_url_default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - return_url_pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - return_url_failure: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. - por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. + notification_url: + type: string + description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). + spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). + por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). + return_url_default: + description: Default URL to redirect the buyer. + x-description-i18n: + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment. + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. + return_url_pending: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. + return_url_failure: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. + por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. order: type: object - description: Order containing all the essential information for the execution of a transaction. + description: Order containing all the essential information for the execution of a payment. x-description-i18n: - eng: Order containing all the essential information for the execution of a transaction. + eng: Order containing all the essential information for the execution of a payment. spa: Orden que contiene toda la información esencial para la ejecución de una transacción. por: Ordem contendo todas as informações essenciais para a execução de uma transação. properties: @@ -3740,9 +3770,9 @@ paths: description: type: string example: "my_order_description" - description: Reason for the order or transaction. + description: Reason for the order or payment. x-description-i18n: - eng: Reason for the order or transaction. + eng: Reason for the order or payment. spa: Motivo de la orden o transacción. por: Motivo da ordem ou transação. amount: @@ -3754,11 +3784,11 @@ paths: spa: Monto total que se desea cobrar. por: Valor total a ser pago. items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -3827,9 +3857,9 @@ paths: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector. + description: Amount of the payment corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector. + eng: Amount of the payment corresponding to the collector. spa: Monto de la transacción que corresponde al collector. por: Valor da transação correspondente ao collector. payer: @@ -3953,18 +3983,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: @@ -3976,9 +4006,9 @@ paths: spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. amount_details: - description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. x-description-i18n: - eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object @@ -3986,9 +4016,9 @@ paths: total: type: string example: "123.00" - description: Details of the total value of the transaction. + description: Details of the total value of the payment. x-description-i18n: - eng: Details of the total value of the transaction. + eng: Details of the total value of the payment. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -4016,9 +4046,9 @@ paths: spa: Monto cobrado por envío (incluido en total). por: Valor cobrado por envio (incluído no total). payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -4067,9 +4097,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -4083,11 +4113,11 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -4188,19 +4218,19 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -4584,20 +4614,20 @@ paths: enum: - 500--Unexpected Error. - 503--Service Unavailable. - /v1/transaction-intents/{id}/refund: + /v1/payment-intents/{id}/refund: put: tags: - - $ref: '#/tags/checkout-api' - summary: Refund Transaction Intent + - $ref: "#/tags/checkout-api" + summary: Refund Payment Intent x-summary-i18n: - eng: Refund Transaction Intent - spa: Reembolsar Transaction Intent - por: Reembolsar Transaction Intent - description: If a Transaction Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure + eng: Refund Payment Intent + spa: Reembolsar Payment Intent + por: Reembolsar Payment Intent + description: If a Payment Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure x-description-i18n: - eng: If a Transaction Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure - spa: Si una Transaction Intent se procesa con éxito y el cliente decide cancelar, este endpoint permite iniciar un procedimiento de reembolso - por: Se uma Transaction Intent for processada com sucesso e o cliente optar pelo cancelamento, este endpoint oferece a capacidade de iniciar um procedimento de reembolso + eng: If a Payment Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure + spa: Si una Payment Intent se procesa con éxito y el cliente decide cancelar, este endpoint permite iniciar un procedimiento de reembolso + por: Se uma Payment Intent for processada com sucesso e o cliente optar pelo cancelamento, este endpoint oferece a capacidade de iniciar um procedimento de reembolso parameters: - in: header name: Authorization @@ -4610,17 +4640,27 @@ paths: eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. + - in: header + name: X-Integrator-ID + schema: + type: string + required: false + description: Optinal ID for programmers or agencies who are part of the program. + x-description-i18n: + eng: Optinal ID for programmers or agencies who are part of the program. + spa: ID opcional para programadores o agencias que forman parte del programa . + por: ID opcional para programadores ou agências que fazem parte do programa . - in: path name: id schema: type: string required: true required: true - description: Alphanumeric ID of the Transaction Intent to get. + description: Alphanumeric ID of the Payment Intent to get. x-description-i18n: - eng: Alphanumeric ID of the Transaction Intent to get. - spa: ID alfanumérico de la Transaction Intent a obtener. - por: ID alfanumérico da Transaction Intent a ser obtida. + eng: Alphanumeric ID of the Payment Intent to get. + spa: ID alfanumérico de la Payment Intent a obtener. + por: ID alfanumérico da Payment Intent a ser obtida. responses: "200": description: success @@ -4632,31 +4672,31 @@ paths: id: type: string example: "00001njp2i" - description: ID of a created Transaction Intent. + description: ID of a created Payment Intent. x-description-i18n: - eng: ID of a created Transaction Intent. - spa: ID de la Transaction Intent creada. - por: ID da Transaction Intent criada. + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Transaction Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Transaction Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Transaction Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "reverted" - description: Current status of the Transaction Intent. + description: Current status of the Payment Intent. x-description-i18n: - eng: Current status of the Transaction Intent. - spa: Status actual de la Transaction Intent. - por: Status atual da Transaction Intent. + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. enum: - new--nova - - transaction_in_process--transação em processo + - payment_in_process--transação em processo - partially_processed--parcialmente processada - processed--processada - partially_reverted--revertida parcialmente @@ -4674,40 +4714,40 @@ paths: por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the transaction. + description: Predefined configuration parameters set by the seller before initiating the payment. x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the transaction. + eng: Predefined configuration parameters set by the seller before initiating the payment. spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: option: type: object - description: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the transaction. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the transaction process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the transaction is conducted. + eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string - description: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. x-description-i18n: - eng: Transaction purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. + eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. example: wallet_purchase, onboarding_credits payment_methods: type: object - description: Information related to the payment methods defined for the transaction. + description: Information related to the payment methods defined for the payment. x-description-i18n: - eng: Information related to the payment methods defined for the transaction. + eng: Information related to the payment methods defined for the payment. spa: Información relacionada con los medios de pago definidos para la transacción. por: Informações relacionadas aos meios de pagamento definidos para a transação. properties: coupons: - description: Coupons can be used as a methods of payment in the transaction. + description: Coupons can be used as a methods of payment in the payment. x-description-i18n: - eng: Coupons can be used as a methods of payment in the transaction. + eng: Coupons can be used as a methods of payment in the payment. spa: Los cupones pueden ser utilizados como medio de pago en la transacción. por: Os cupons podem ser utilizados como meio de pagamento na transação. type: object @@ -4747,9 +4787,9 @@ paths: type: string example: credit_card, debit_card disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the transaction, such as "credit card". + eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". type: array @@ -4841,46 +4881,46 @@ paths: spa: Configuración del seller sobre la integración. por: Configuração do seller sobre a integração. properties: - notification_url: - type: string - description: URL to which notifications will be sent. - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent. - spa: URL a la cual se enviarán las notificaciones. - por: URL para a qual as notificações serão enviadas. - return_url_default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - return_url_pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - return_url_failure: - description: Redirection URL for the event of buyer payment failure. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: Redirection URL for the event of buyer payment failure. - spa: URL de redirección para el caso de fallo en el pago del comprador. - por: URL de redirecionamento para o caso de falha no pagamento do comprador. + notification_url: + type: string + description: URL to which notifications will be sent. + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. + return_url_default: + description: Default URL to redirect the buyer. + x-description-i18n: + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment. + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. + return_url_pending: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. + return_url_failure: + description: Redirection URL for the event of buyer payment failure. + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: Redirection URL for the event of buyer payment failure. + spa: URL de redirección para el caso de fallo en el pago del comprador. + por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object description: Common Order attributes for request and response. @@ -4908,25 +4948,25 @@ paths: description: type: string example: "my_order_description" - description: Description for the order or transaction. + description: Description for the order or payment. x-description-i18n: - eng: Description for the order or transaction. + eng: Description for the order or payment. spa: Descripción de la orden o transacción. por: Descrição da ordem ou transação. amount: example: "233.00" type: string - description: Total value of the transaction. For example, "233.00". + description: Total value of the payment. For example, "233.00". x-description-i18n: - eng: Total value of the transaction. For example, "233.00". + eng: Total value of the payment. For example, "233.00". spa: Monto total de la transacción. Por ejemplo, "233.00".. por: Valor total da transação. Por exemplo, "233.00". items: - description: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Information relevant to the configuration of the items comprising the transaction, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the transaction, including the quantity of each item and the corresponding price for each of them. + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -4995,9 +5035,9 @@ paths: amount: type: string example: "50.00" - description: Amount of the transaction corresponding to the collector. + description: Amount of the payment corresponding to the collector. x-description-i18n: - eng: Amount of the transaction corresponding to the collector. + eng: Amount of the payment corresponding to the collector. spa: Monto de la transacción que corresponde al collector. por: Valor da transação correspondente ao collector. payer: @@ -5121,18 +5161,18 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced transaction. + description: Options for advanced payment. x-description-i18n: - eng: Options for advanced transaction. + eng: Options for advanced payment. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: Enables requesting a final transaction response during the initial processing, disabling any options for offline or asynchronous processing. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. sponsor_id: @@ -5144,9 +5184,9 @@ paths: spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. amount_details: - description: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. x-description-i18n: - eng: This field encompasses transaction value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object @@ -5154,9 +5194,9 @@ paths: total: type: string example: "123.00" - description: Details of the total value of the transaction. + description: Details of the total value of the payment. x-description-i18n: - eng: Details of the total value of the transaction. + eng: Details of the total value of the payment. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -5184,9 +5224,9 @@ paths: spa: Monto cobrado por envío (incluido en el otal). por: Valor cobrado por envio (incluído no total). payment_method: - description: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Detailed information about the available payment methods during the transaction, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. type: object @@ -5235,9 +5275,9 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. installments: @@ -5251,11 +5291,11 @@ paths: statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -5356,19 +5396,19 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and transaction analysis purposes. + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the transaction. It provides a brief description that assists the customer in recognizing the nature of the transaction conducted. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: From 5197b080e6ae81ab0e9309fee200dbe1db2bc852 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Wed, 30 Aug 2023 14:55:27 -0300 Subject: [PATCH 33/40] fixed typo --- reference/api/payment_intent_id.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/reference/api/payment_intent_id.yaml b/reference/api/payment_intent_id.yaml index b1ab6c258c..699cd37096 100644 --- a/reference/api/payment_intent_id.yaml +++ b/reference/api/payment_intent_id.yaml @@ -9,14 +9,14 @@ paths: get: tags: - $ref: "#/tags/checkout-api" - summary: Get payment intent by ID + summary: Get Payment Intent by ID x-summary-i18n: - eng: Get payment intent by ID - spa: Obtener payment intent por ID - por: Obter payment intent por ID + eng: Get Payment Intent by ID + spa: Obtener Payment Intent por ID + por: Obter Payment Intent por ID description: This endpoint allows you to retrieve an existing 'Payment Intent' using its ID as a parameter x-description-i18n: - eng: This endpoint allows you to retrieve an existing 'Payment Intent' using its ID as a parameter + eng: This endpoint allows you to retrieve an existing Payment Intent by using its ID as a parameter spa: Este endpoint permite consultar una Payment Intent ya existente mediante su ID por: Este endpoint permite consultar uma Payment Intent existente utilizando seu ID como parâmetro parameters: From 132d992734d0337a60ae6848c4c6737dc7e77a14 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Mon, 4 Sep 2023 11:33:35 -0300 Subject: [PATCH 34/40] updated create payment intent endpoint --- reference/api/payment_intent.yaml | 2223 +---------------------------- 1 file changed, 7 insertions(+), 2216 deletions(-) diff --git a/reference/api/payment_intent.yaml b/reference/api/payment_intent.yaml index cc3e090fed..e7e065a441 100644 --- a/reference/api/payment_intent.yaml +++ b/reference/api/payment_intent.yaml @@ -8,17 +8,17 @@ paths: /v1/payment-intents: post: tags: - - $ref: "#/tags/checkout-api" + - $ref: '#/tags/checkout-api' summary: Create Payment Intent x-summary-i18n: eng: Create Payment Intent spa: Crear Payment Intent por: Criar Payment Intent - description: This endpoint enables the creation of a new Payment Intent in Builder mode. Upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint + description: This endpoint enables the creation of a new Payment Intent in Builder or One shot mode. In mode Builder, upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint. In One shot mode, the payment is processed immediately after the creation of the Payment Intent. It's important to note that, in One Shot mode, the payment_method parameter is mandatory x-description-i18n: - eng: This endpoint enables the creation of a new Payment Intent in Builder mode. Upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint - spa: Este endpoint permite la creación de una nueva Payment Intent en modo Builder. Al obtener el ID de esta Payment Intent, es posible realizar ediciones a través del endpoint Patch y llevar a cabo el procesamiento utilizando el endpoint Process - por: Este endpoint possibilita a criação de uma nova Payment Intent no modo Builder. Ao obter o ID desta Payment Intent, é possível efetuar edições por meio do Endpoint Patch e realizar o processamento utilizando o Endpoint Process + eng: This endpoint enables the creation of a new Payment Intent in Builder or One shot mode. In mode Builder, upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint. In One shot mode, the payment is processed immediately after the creation of the Payment Intent. It's important to note that, in One Shot mode, the payment_method parameter is mandatory + spa: Este endpoint permite la creación de una nueva Payment Intent en modo Builder or modo One shot. En mode Builder, al obtener el ID de esta Payment Intent, es posible realizar ediciones a través del endpoint Patch y llevar a cabo el procesamiento utilizando el endpoint Process. En modo One shot, el pago se procesa inmediatamente después de la creación de la Payment Intent. Es importante destacar que, en el modo One Shot, el parámetro payment_method es obligatorio + por: Este endpoint possibilita a criação de uma nova Payment Intent no modo Builder ou modo One shot. No modo Builder. ao obter o ID desta Payment Intent, é possível efetuar edições por meio do Endpoint Patch e realizar o processamento utilizando o Endpoint Process. No modo One shot, o pagamento é processado imediatamente após a criação da Payment Intent. É importante salientar que, no modo One Shot, o parâmetro payment_method é obrigatório parameters: - in: header name: Authorization @@ -161,7 +161,7 @@ paths: x-description-i18n: eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. + por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. properties: purpose: type: string @@ -401,7 +401,7 @@ paths: x-description-i18n: eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -659,2215 +659,6 @@ paths: eng: Total value charged per shipment. spa: Monto cobrado por envío (incluido en total). por: Valor cobrado por envio (incluído no total). - payment_method: - description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - x-description-i18n: - eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. - por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object - properties: - credit_cards: - description: Credit cards. - x-description-i18n: - eng: Credit cards. - spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. - x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do Pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - atms: - description: ATM (Automated Teller Machine). - x-description-i18n: - eng: ATM (Automated Teller Machine). - spa: Cajero automático. - por: Caixa eletrônico. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - bank_transfers: - description: Bank transfers. - x-description-i18n: - eng: Bank transfers. - spa: Transferencias bancarias. - por: Transferências bancárias. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. - "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro - content: - application/json: - schema: - type: object - properties: - errorKey: - type: string - enum: - - 500--Unexpected Error. - - 503--Service Unavailable. - /v1/payment-intents/process: - post: - tags: - - $ref: '#/tags/checkout-api' - summary: Create and Process a Payment Intent - x-summary-i18n: - eng: Create and Process a Payment Intent - spa: Crear y procesar Payment Intent - por: Criar e processar Payment Intent - description: This endppoint allows you to creates and process a new Payment Intent - x-description-i18n: - eng: This endppoint allows you to creates and rocess a new Payment Intent - spa: Este endpoint permite crear y procesar una nueva Payment Intent - por: Este endpoint permite criar e processar uma nova Payment Intent - parameters: - - in: header - name: Authorization - schema: - type: string - example: "Bearer token-89987654567f-numeroToken" - required: true - description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. - x-description-i18n: - eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. - spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. - por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - - in: header - name: X-Integrator-ID - schema: - type: string - required: false - description: Optinal ID for programmers or agencies who are part of the program. - x-description-i18n: - eng: Optinal ID for programmers or agencies who are part of the program. - spa: ID opcional para programadores o agencias que forman parte del programa . - por: ID opcional para programadores ou agências que fazem parte do programa . - requestBody: - description: Complete body to create and process a Payment Intent. - x-description-i18n: - eng: Complete body to create and process a Payment Intent. - spa: Body completo para crear y procesar una Payment Intent. - por: Body completo para criar e processar uma Payment Intent. - content: - application/json: - schema: - type: object - properties: - active_to_date: - type: string - description: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - x-description-i18n: - eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". - por: Prazo máximo de processamento para a Payment Intent. Este prazo determina a data-limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". - format: date-time - example: "2023-09-06T10:00:00.000-03:00" - configuration: - type: object - description: Predefined configuration parameters set by the seller before initiating the payment. - x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. - properties: - options: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - payment_methods: - required: true - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a payment method during the payment. - x-description-i18n: - eng: Coupons can be used as a payment method during the payment. - spa: Los cupones se pueden utilizar como método de pago durante la transacción. - por: Os cupons podem ser utilizados como forma de pagamento durante a transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: [ "credit_card", "debit_card" ] - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: [ "visa", "master" ] - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier. For example, "credit_card". - x-description-i18n: - eng: Payment method identifier. For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a serem disponibilizadas. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a serem disponibilizadas. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: [ "ticket", "account_money" ] - default: - type: string - example: "credit_card" - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. - purpose: - type: string - description: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". - x-description-i18n: - eng: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". - example: [ "wallet_purchase", "onboarding_credits" ] - integration: - type: object - description: Configuration of the seller on integration. - x-description-i18n: - eng: Configuration of the seller on integration. - spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. - properties: - notifications: - description: Parameter concerning notification URL settings for conducted payments. - x-description-i18n: - eng: Parameter concerning notification URL settings for conducted payments. - spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. - por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). - por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt. - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt. - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. - properties: - default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - failure: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. - por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system. - x-description-i18n: - eng: Seller's identifier in the integrator's system. - spa: Identificador del seller en el sistema del integrador. - por: Identificador do vendedor no sistema do integrador. - order: - description: Order containing all the essential information for the execution of a payment. - x-description-i18n: - eng: Order containing all the essential information for the execution of a payment. - spa: Orden que contiene toda la información esencial para la ejecución de una transacción. - por: Ordem contendo todas as informações essenciais para a execução de uma transação. - type: object - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. - external_reference: - type: string - example: "my_order_id" - description: Reference of the order. - x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - reason: - type: string - example: "my_order_description" - description: Reason for the order or payment. - x-description-i18n: - eng: Reason for the order or payment. - spa: Motivo de la orden o transacción. - por: Motivo da ordem ou transação. - amount: - required: true - type: string - example: "50.00" - description: Total amount to be paid. - x-description-i18n: - eng: Total amount to be paid. - spa: Monto total que se desea cobrar. - por: Valor total a ser pago. - items: - description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - x-description-i18n: - eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array - items: - type: object - description: List of items included in the order. - x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. - properties: - id: - type: string - example: "x76ax" - description: Item identification code. For example, "x76ax". - x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". - quantity: - type: number - example: 4 - description: Number of item included in the order. - x-description-i18n: - eng: Number of item included in the order. - spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. - unit_price: - type: string - example: "100.00" - description: Unit value of the item. For example, "100.00". - x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. - x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - payer: - type: object - description: Buyer's information. - x-description-i18n: - eng: Buyer's information. - spa: Información del comprador. - por: Informações do comprador. - properties: - email: - required: true - type: string - description: Buyer's email. - x-description-i18n: - eng: Buyer's email. - spa: Email del comprador. - por: Email do comprador. - customer_id: - type: number - example: 123456 - description: Previously stored buyer identification number. - x-description-i18n: - eng: Previously stored buyer identification number. - spa: Número de identificación del comprador previamente almacenado. - por: Número de identificação do comprador previamente armazenado. - identification: - type: object - description: This field refers to the type and number of the document used to identify a person within the country. - x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. - properties: - number: - description: Number of the document. - x-description-i18n: - eng: Number of the document. - spa: Número del documento. - por: Número do documento. - type: string - example: "12345678098" - type: - description: Type of the document. - x-description-i18n: - eng: Type of the document. - spa: Tipo de documento. - por: Tipo de documento. - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name. - x-description-i18n: - eng: Buyer's name. - spa: Nombre del comprador. - por: Nome do comprador. - surname: - type: string - example: "Doe" - description: Buyer's surname. - x-description-i18n: - eng: Buyer's surname. - spa: Apellido del comprador. - por: Sobrenome do comprador. - address: - type: object - description: Address of the buyer. - x-description-i18n: - eng: Address of the buyer. - spa: Dirección del comprador. - por: Endereço do comprador. - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name. - x-description-i18n: - eng: Street name. - spa: Nombre de la calle. - por: Nome da rua. - street_number: - type: string - example: "100" - description: Street number. - x-description-i18n: - eng: Street number. - spa: Número de la calle. - por: Número da casa. - zip_code: - type: string - example: "57000-865" - description: Zip code. - x-description-i18n: - eng: Zip code. - spa: Código postal. - por: Código postal. - phone: - type: object - description: Buyer's phone number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - properties: - area_code: - type: string - description: Buyer's area code. - x-description-i18n: - eng: Buyer's area code. - spa: Código de área del comprador. - por: Código de área do comprador. - example: "11" - number: - type: string - description: Buyer's phone number number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - example: "99999999" - advanced: - type: object - description: Options for advanced payment. - x-description-i18n: - eng: Options for advanced payment. - spa: Agrupación de opciones avanzadas para la transacción. - por: Opções avançadas para a transação. - properties: - binary_mode: - type: boolean - example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - marketplace: - type: object - description: In the event of a marketplace-type integration, this configuration is applicable to the collector. - x-description-i18n: - eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. - spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. - por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. - properties: - fee: - type: string - example: "5" - description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - x-description-i18n: - eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. - por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account responsible for paying the commissions. - x-description-i18n: - eng: ID of the Mercado Pago account responsible for paying the commissions. - spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. - por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. - payment_method: - description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - x-description-i18n: - eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. - por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object - properties: - credit_cards: - description: Credit cards. - x-description-i18n: - eng: Credit cards. - spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. - x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do Pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - atms: - description: ATM (Automated Teller Machine). - x-description-i18n: - eng: ATM (Automated Teller Machine). - spa: Cajero automático. - por: Caixa eletrônico. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - bank_transfers: - description: Bank transfers. - x-description-i18n: - eng: Bank transfers. - spa: Transferencias bancarias. - por: Transferências bancárias. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - responses: - "200": - description: success - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: "00001njp2i" - description: ID of a created Payment Intent. - x-description-i18n: - eng: ID of a created Payment Intent. - spa: ID de la Payment Intent creada. - por: ID da Payment Intent criada. - created_date: - type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - x-description-i18n: - eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". - format: date-time - status: - type: string - example: "authorized" - description: Current status of the Payment Intent. - x-description-i18n: - eng: Current status of the Payment Intent. - spa: Status actual de la Payment Intent. - por: Status atual da Payment Intent. - enum: - - new--nova - - payment_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelada - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - x-description-i18n: - eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - configuration: - type: object - description: Predefined configuration parameters set by the seller before initiating the payment. - x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. - properties: - option: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - purpose: - type: string - description: payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - x-description-i18n: - eng: payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a methods of payment in the payment. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the payment. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: credit_card, debit_card - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: visa, master - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier For example, "credit_card". - x-description-i18n: - eng: Payment method identifier For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a oferecer. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a oferecer. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: ticket, account_money - default: - type: string - example: "credit_card" - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. - integration: - type: object - description: Configuration of the seller on integration. - x-description-i18n: - eng: Configuration of the seller on integration. - spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. - properties: - notification_url: - type: string - description: URL to which notifications will be sent. - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent. - spa: URL a la cual se enviarán las notificaciones. - por: URL para a qual as notificações serão enviadas. - return_url_default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - return_url_pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - return_url_failure: - description: Redirection URL for the event of buyer payment failure. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: Redirection URL for the event of buyer payment failure. - spa: URL de redirección para el caso de fallo en el pago del comprador. - por: URL de redirecionamento para o caso de falha no pagamento do comprador. - order: - type: object - description: Common Order attributes for request and response. - x-description-i18n: - eng: Common Order attributes for request and response. - spa: Atributos de Order comunes para el request y el response. - por: Atributos de Order comuns para o request e o response. - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - description: - type: string - example: "my_order_description" - description: Description for the order or payment. - x-description-i18n: - eng: Description for the order or payment. - spa: Descripción de la orden o transacción. - por: Descrição da ordem ou transação. - amount: - example: "233.00" - type: string - description: Total value of the payment. For example, "233.00". - x-description-i18n: - eng: Total value of the payment. For example, "233.00". - spa: Monto total de la transacción. Por ejemplo, "233.00".. - por: Valor total da transação. Por exemplo, "233.00". - items: - description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - x-description-i18n: - eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array - items: - type: object - description: List of items included in the order. - x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. - properties: - id: - type: string - example: "x76ax" - description: Item identification code. For example, "x76ax". - x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". - quantity: - type: number - example: 4 - description: Number of item included in the order. - x-description-i18n: - eng: Number of item included in the order. - spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. - unit_price: - type: string - example: "100.00" - description: Unit value of the item. For example, "100.00". - x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. - x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - collectors: - type: object - description: Seller user who receives the payment. - x-description-i18n: - eng: Seller user who receives the payment. - spa: Usuario vendedor que recibe el pago. - por: Usuário vendedor que recebe o pagamento. - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier. - x-description-i18n: - eng: Collector identifier. - spa: Identificador del collector. - por: Identificador do collector. - amount: - type: string - example: "50.00" - description: Amount of the payment corresponding to the collector. - x-description-i18n: - eng: Amount of the payment corresponding to the collector. - spa: Monto de la transacción que corresponde al collector. - por: Valor da transação correspondente ao collector. - payer: - type: object - description: Buyer's information. - x-description-i18n: - eng: Buyer's information. - spa: Información del comprador. - por: Informações do comprador. - properties: - email: - type: string - description: Buyer's email. - x-description-i18n: - eng: Buyer's email. - spa: Email del comprador. - por: Email do comprador. - customer_id: - type: number - example: 123456 - description: Previously stored buyer identification number. - x-description-i18n: - eng: Previously stored buyer identification number. - spa: Número de identificación del comprador previamente almacenado. - por: Número de identificação do comprador previamente armazenado. - identification: - type: object - description: This field refers to the type and number of the document used to identify a person within the country. - x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. - properties: - number: - description: Number of the document. - x-description-i18n: - eng: Number of the document. - spa: Número del documento. - por: Número do documento. - type: string - example: "12345678098" - type: - description: Type of the document. - x-description-i18n: - eng: Type of the document. - spa: Tipo de documento. - por: Tipo de documento. - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name. - x-description-i18n: - eng: Buyer's name. - spa: Nombre del comprador. - por: Nome do comprador. - surname: - type: string - example: "Doe" - description: Buyer's surname. - x-description-i18n: - eng: Buyer's surname. - spa: Apellido del comprador. - por: Sobrenome do comprador. - address: - type: object - description: Address of the buyer. - x-description-i18n: - eng: Address of the buyer. - spa: Dirección del comprador. - por: Endereço do comprador. - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name. - x-description-i18n: - eng: Street name. - spa: Nombre de la calle. - por: Nome da rua. - street_number: - type: string - example: "100" - description: Street number. - x-description-i18n: - eng: Street number. - spa: Número de la calle. - por: Número da casa. - zip_code: - type: string - example: "57000-865" - description: Zip code. - x-description-i18n: - eng: Zip code. - spa: Código postal. - por: Código postal. - phone: - description: Buyer's phone number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - type: object - properties: - area_code: - description: Buyer's area code. - x-description-i18n: - eng: Buyer's area code. - spa: Código de área del comprador. - por: Código de área do comprador. - type: string - example: "11" - number: - description: Buyer's phone number number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced payment. - x-description-i18n: - eng: Options for advanced payment. - spa: Agrupación de opciones avanzadas para la transacción. - por: Opções avançadas para a transação. - properties: - binary_mode: - type: boolean - example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - sponsor_id: - type: number - example: 123456789 - description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. - x-description-i18n: - eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. - spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. - por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. - amount_details: - description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - x-description-i18n: - eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. - por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the payment. - x-description-i18n: - eng: Details of the total value of the payment. - spa: Detalles del monto total de la transacción. - por: Detalhes do valor total da transação. - paid: - type: string - example: "100.00" - description: Total paid. - x-description-i18n: - eng: Total paid. - spa: Monto de la transacción pagado. - por: Valor pago. - refunded: - type: string - example: "100.00" - description: Total value refunded. - x-description-i18n: - eng: Total value refunded. - spa: Monto de la transacción devuelto. - por: Valor total reembolsado. - shipment: - type: string - example: "10.00" - description: Total value charged per shipment. - x-description-i18n: - eng: Total value charged per shipment. - spa: Monto cobrado por envío (incluido en el otal). - por: Valor cobrado por envio (incluído no total). payment_method: description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: From f38031087034fc6af78711fbb851ff8b20b96e48 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Fri, 15 Sep 2023 12:19:34 -0300 Subject: [PATCH 35/40] cancel endpoint update --- reference/api/payment_intent_id.yaml | 1217 ++------------------------ 1 file changed, 91 insertions(+), 1126 deletions(-) diff --git a/reference/api/payment_intent_id.yaml b/reference/api/payment_intent_id.yaml index 699cd37096..269b9d24b9 100644 --- a/reference/api/payment_intent_id.yaml +++ b/reference/api/payment_intent_id.yaml @@ -3439,17 +3439,17 @@ paths: /v1/payment-intents/{id}/cancel: put: tags: - - $ref: "#/tags/checkout-api" - summary: Cancel Payment Intent + - $ref: '#/tags/checkout-api' + summary: Cancel Payment-Intent x-summary-i18n: - eng: Cancel Payment Intent - spa: Cancelar Payment Intent - por: Cancelar Payment Intent - description: This endpoint allows to cancel a Payment Intent + eng: Cancel Payment-Intent + spa: Cancelar Payment-Intent + por: Cancelar Payment-Intent + description: This endpoint allows you to cancel a Payment-Intent only in the authorization flow x-description-i18n: - eng: This endpoint allows to cancel a Payment Intent - spa: Este endpoint permite cancelar una Payment Intent - por: Este endpoint permite cancelar uma Payment Intent + eng: This endpoint allows you to cancel a Payment-Intent only in the authorization flow + spa: Este endpoint le permite cancelar una Payment-Intent solo en el flujo de autorización + por: Este endpoint permite cancelar uma Payment-Intent apenas no fluxo de autorização parameters: - in: header name: Authorization @@ -3462,1127 +3462,70 @@ paths: eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - - in: header - name: X-Integrator-ID - schema: - type: string - required: false - description: Optinal ID for programmers or agencies who are part of the program. - x-description-i18n: - eng: Optinal ID for programmers or agencies who are part of the program. - spa: Opción de ID para programadores o agencias que forman parte del programa . - por: ID opcional para programadores ou agências que fazem parte do programa . - in: path name: id schema: type: string required: true required: true - description: Alphanumeric product ID, for example, 876542356788-mp. + description: Alphanumeric identification of the authorized Payment-Intent ID. For example 876542356788-mp. x-description-i18n: - eng: Alphanumeric product ID, for example, 876542356788-mp. - spa: Identificación alfanumérica del producto, por ejemplo, 876542356788-mp. - por: Identificação alfanumérica do produto, como por exemplo, 876542356788-mp. + eng: Alphanumeric identification of the authorized Payment-Intent ID. For example 876542356788-mp. + spa: Identificación alfanumérica del ID de Payment-Intent autorizado. Por ejemplo 876542356788-mp. + por: Identificação alfanumérica do ID do Payment-Intent autorizado, como por exemplo, 876542356788-mp. responses: - "200": - description: success + "204": + description: Payment-Intent cancelled + "400": + description: Bad Request + x-description-i18n: + eng: Bad Request + spa: Bad Request + por: Bad Request content: application/json: schema: type: object properties: - id: + errorKey: type: string - example: "00001njp2i" - description: ID of a created Payment Intent. - x-description-i18n: - eng: ID of a created Payment Intent. - spa: ID de la Payment Intent creada. - por: ID da Payment Intent criada. - created_date: + enum: + - Bad Request. + "401": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - x-description-i18n: - eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". - format: date-time - status: + enum: + - Forbidden. + "403": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: type: string - example: "authorized" - description: Current status of the Payment Intent. - x-description-i18n: - eng: Current status of the Payment Intent. - spa: Status actual de la Payment Intent. - por: Status atual da Payment Intent. enum: - - new--nova - - payment_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelada - - authorized--autorizada - init_point: + - Forbidden. + "404": + description: Not Found + content: + application/json: + schema: + type: object + properties: + errorKey: type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - x-description-i18n: - eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - configuration: - type: object - description: Predefined configuration parameters set by the seller before initiating the payment. - x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. - properties: - option: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - purpose: - type: string - description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - x-description-i18n: - eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. - example: wallet_purchase, onboarding_credits - payment_methods: - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - type: object - properties: - coupons: - description: Coupons can be used as a methods of payment in the payment. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the payment. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: credit_card, debit_card - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: visa, master - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier. For example, "credit_card". - x-description-i18n: - eng: Payment method identifier. For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a serem disponibilizadas. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a serem disponibilizadas. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: ticket, account_money - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão - integration: - type: object - description: Configuration of the seller on integration. - x-description-i18n: - eng: Configuration of the seller on integration. - spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. - properties: - notification_url: - type: string - description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). - por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). - return_url_default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - return_url_pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - return_url_failure: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. - por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. - order: - type: object - description: Order containing all the essential information for the execution of a payment. - x-description-i18n: - eng: Order containing all the essential information for the execution of a payment. - spa: Orden que contiene toda la información esencial para la ejecución de una transacción. - por: Ordem contendo todas as informações essenciais para a execução de uma transação. - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. - external_reference: - type: string - example: "my_order_id" - description: Reference of the order. - x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - description: - type: string - example: "my_order_description" - description: Reason for the order or payment. - x-description-i18n: - eng: Reason for the order or payment. - spa: Motivo de la orden o transacción. - por: Motivo da ordem ou transação. - amount: - example: "233.00" - type: string - description: Total amount to be paid. - x-description-i18n: - eng: Total amount to be paid. - spa: Monto total que se desea cobrar. - por: Valor total a ser pago. - items: - description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - x-description-i18n: - eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array - items: - type: object - description: List of items included in the order. - x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. - properties: - id: - type: string - example: "x76ax" - description: Item identification code. For example, "x76ax". - x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". - quantity: - type: number - example: 4 - description: Number of item included in the order. - x-description-i18n: - eng: Number of item included in the order. - spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. - unit_price: - type: string - example: "100.00" - description: Unit value of the item. For example, "100.00". - x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. - x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - collectors: - type: object - description: Seller user who receives the payment. - x-description-i18n: - eng: Seller user who receives the payment. - spa: Usuario vendedor que recibe el pago. - por: Usuário vendedor que recebe o pagamento. - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier. - x-description-i18n: - eng: Collector identifier. - spa: ID del collector. - por: Identificador do collector. - amount: - type: string - example: "50.00" - description: Amount of the payment corresponding to the collector. - x-description-i18n: - eng: Amount of the payment corresponding to the collector. - spa: Monto de la transacción que corresponde al collector. - por: Valor da transação correspondente ao collector. - payer: - type: object - description: Buyer's information. - x-description-i18n: - eng: Buyer's information. - spa: Información del comprador. - por: Informações do comprador. - properties: - email: - type: string - description: Buyer's email. - x-description-i18n: - eng: Buyer's email. - spa: Email del comprador. - por: Email do comprador. - customer_id: - type: number - example: 123456 - description: Previously stored buyer identification number. - x-description-i18n: - eng: Previously stored buyer identification number. - spa: Número de identificación del comprador previamente almacenado. - por: Número de identificação do comprador previamente armazenado. - identification: - type: object - description: This field refers to the type and number of the document used to identify a person within the country. - x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. - properties: - number: - description: Number of the document. - x-description-i18n: - eng: Number of the document. - spa: Número del documento. - por: Número do documento. - type: string - example: "12345678098" - type: - description: Type of the document. - x-description-i18n: - eng: Type of the document. - spa: Tipo de documento. - por: Tipo de documento. - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name. - x-description-i18n: - eng: Buyer's name. - spa: Nombre del comprador. - por: Nome do comprador. - surname: - type: string - example: "Doe" - description: Buyer's surname. - x-description-i18n: - eng: Buyer's surname. - spa: Apellido del comprador. - por: Sobrenome do comprador. - address: - type: object - description: Address of the buyer. - x-description-i18n: - eng: Address of the buyer. - spa: Dirección del comprador. - por: Endereço do comprador. - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name. - x-description-i18n: - eng: Street name. - spa: Nombre de la calle. - por: Nome da rua. - street_number: - type: string - example: "100" - description: Street number. - x-description-i18n: - eng: Street number. - spa: Número de la calle. - por: Número da casa. - zip_code: - type: string - example: "57000-865" - description: Zip code. - x-description-i18n: - eng: Zip code. - spa: Código postal. - por: Código postal. - phone: - type: object - description: Buyer's phone number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - properties: - area_code: - type: string - description: Buyer's area code. - x-description-i18n: - eng: Buyer's area code. - spa: Código de área del comprador. - por: Código de área do comprador. - example: "11" - number: - type: string - description: Buyer's phone number number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - example: "99999999" - advanced: - type: object - description: Options for advanced payment. - x-description-i18n: - eng: Options for advanced payment. - spa: Agrupación de opciones avanzadas para la transacción. - por: Opções avançadas para a transação. - properties: - binary_mode: - type: boolean - example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account responsible for paying the commissions. - x-description-i18n: - eng: ID of the Mercado Pago account responsible for paying the commissions. - spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. - por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. - amount_details: - description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - x-description-i18n: - eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. - por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the payment. - x-description-i18n: - eng: Details of the total value of the payment. - spa: Detalles del monto total de la transacción. - por: Detalhes do valor total da transação. - paid: - type: string - example: "100.00" - description: Total paid. - x-description-i18n: - eng: Total paid. - spa: Monto de la transacción pagado. - por: Valor pago. - refunded: - type: string - example: "100.00" - description: Total value refunded. - x-description-i18n: - eng: Total value refunded. - spa: Monto de la transacción devuelto. - por: Valor total reembolsado. - shipment: - type: string - example: "10.00" - description: Total value charged per shipment. - x-description-i18n: - eng: Total value charged per shipment. - spa: Monto cobrado por envío (incluido en total). - por: Valor cobrado por envio (incluído no total). - payment_method: - description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - x-description-i18n: - eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. - por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object - properties: - credit_cards: - description: Credit cards. - x-description-i18n: - eng: Credit cards. - spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. - x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do Pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - atms: - description: ATM (Automated Teller Machine). - x-description-i18n: - eng: ATM (Automated Teller Machine). - spa: Cajero automático. - por: Caixa eletrônico. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - bank_transfers: - description: Bank transfers. - x-description-i18n: - eng: Bank transfers. - spa: Transferencias bancarias. - por: Transferências bancárias. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + enum: + - Not Found. + "408": + description: Request Timeout content: application/json: schema: @@ -4591,19 +3534,31 @@ paths: errorKey: type: string enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. + - Request Timeout. + "409": + description: Conflict + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Conflict. + "422": + description: Unprocessable Entity + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unprocessable Entity. "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Unexpected Error content: application/json: schema: @@ -4612,8 +3567,18 @@ paths: errorKey: type: string enum: - - 500--Unexpected Error. - - 503--Service Unavailable. + - Unexpected Error. + "503": + description: Service Unavailable + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Service Unavailable. /v1/payment-intents/{id}/refund: put: tags: From 9b3f927d4368dc43be0e7c044127c81ab42f176f Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Fri, 15 Sep 2023 15:13:36 -0300 Subject: [PATCH 36/40] cancel update --- reference/api/payment_intent_id.yaml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/reference/api/payment_intent_id.yaml b/reference/api/payment_intent_id.yaml index 269b9d24b9..7478b805cf 100644 --- a/reference/api/payment_intent_id.yaml +++ b/reference/api/payment_intent_id.yaml @@ -3445,11 +3445,11 @@ paths: eng: Cancel Payment-Intent spa: Cancelar Payment-Intent por: Cancelar Payment-Intent - description: This endpoint allows you to cancel a Payment-Intent only in the authorization flow + description: This endpoint allows for the cancellation of a Payment-Intent solely during the authorization phase. A 204 response code confirms the successful cancellation, and as a result, the response body will be empty. x-description-i18n: - eng: This endpoint allows you to cancel a Payment-Intent only in the authorization flow - spa: Este endpoint le permite cancelar una Payment-Intent solo en el flujo de autorización - por: Este endpoint permite cancelar uma Payment-Intent apenas no fluxo de autorização + eng: This endpoint allows for the cancellation of a Payment-Intent solely during the authorization phase. A 204 response code confirms the successful cancellation, and as a result, the response body will be empty. + spa: Este endpoint permite cancelar una Payment-Intent únicamente en la fase de autorización. Un código de respuesta 204 confirma que el cancelamiento se ha realizado con éxito, y, por lo tanto, el cuerpo de la respuesta estará vacío. + por: Este endpoint possibilita o cancelamento de uma Payment-Intent apenas no fluxo de autorização. Um retorno de resposta 204 confirma o cancelamento bem-sucedido, e, consequentemente, o corpo da resposta estará vazio. parameters: - in: header name: Authorization @@ -3466,7 +3466,6 @@ paths: name: id schema: type: string - required: true required: true description: Alphanumeric identification of the authorized Payment-Intent ID. For example 876542356788-mp. x-description-i18n: From a17eac1e62c657128eb46485442a8e7eb271610b Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 19 Sep 2023 11:15:17 -0300 Subject: [PATCH 37/40] review all endpoints --- reference/api/payment_intent.yaml | 3852 ++++++++------------- reference/api/payment_intent_id.yaml | 4628 +++++++------------------- 2 files changed, 2722 insertions(+), 5758 deletions(-) diff --git a/reference/api/payment_intent.yaml b/reference/api/payment_intent.yaml index e7e065a441..f09b02dcb2 100644 --- a/reference/api/payment_intent.yaml +++ b/reference/api/payment_intent.yaml @@ -9,60 +9,124 @@ paths: post: tags: - $ref: '#/tags/checkout-api' - summary: Create Payment Intent + summary: Create a Payment Intent x-summary-i18n: - eng: Create Payment Intent + eng: Create a Payment Intent spa: Crear Payment Intent por: Criar Payment Intent - description: This endpoint enables the creation of a new Payment Intent in Builder or One shot mode. In mode Builder, upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint. In One shot mode, the payment is processed immediately after the creation of the Payment Intent. It's important to note that, in One Shot mode, the payment_method parameter is mandatory + description: This endpoint provides the functionality to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates x-description-i18n: - eng: This endpoint enables the creation of a new Payment Intent in Builder or One shot mode. In mode Builder, upon obtaining the ID of this Payment Intent, it is possible to make edits through the Patch Endpoint and carry out the processing using the Process Endpoint. In One shot mode, the payment is processed immediately after the creation of the Payment Intent. It's important to note that, in One Shot mode, the payment_method parameter is mandatory - spa: Este endpoint permite la creación de una nueva Payment Intent en modo Builder or modo One shot. En mode Builder, al obtener el ID de esta Payment Intent, es posible realizar ediciones a través del endpoint Patch y llevar a cabo el procesamiento utilizando el endpoint Process. En modo One shot, el pago se procesa inmediatamente después de la creación de la Payment Intent. Es importante destacar que, en el modo One Shot, el parámetro payment_method es obligatorio - por: Este endpoint possibilita a criação de uma nova Payment Intent no modo Builder ou modo One shot. No modo Builder. ao obter o ID desta Payment Intent, é possível efetuar edições por meio do Endpoint Patch e realizar o processamento utilizando o Endpoint Process. No modo One shot, o pagamento é processado imediatamente após a criação da Payment Intent. É importante salientar que, no modo One Shot, o parâmetro payment_method é obrigatório + eng: This endpoint provides the functionality to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates + spa: Este endpoint permite crear y procesar una nueva Payment Intent. Si desea evitar el procesamiento inmediato durante la creación, simplemente omita el parámetro "payment_method". Posteriormente, puede modificar la Intención de Pago utilizando el endpoint PATCH /v1/payment-intents/:id para actualizaciones + por: Este endpoint oferece a capacidade de criar e processar uma nova Payment Intent. Se você deseja evitar o processamento imediato durante a criação, basta omitir o parâmetro "payment_method". Posteriormente, é possível modificar a Intenção de Pagamento utilizando o endpoint PATCH /v1/payment-intents/:id para atualizações parameters: - in: header name: Authorization schema: type: string - example: "Bearer token-89987654567f-numeroToken" + example: "Bearer ACCESS_TOKEN" required: true - description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. x-description-i18n: - eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - in: header - name: X-Integrator-ID + name: X-Idempotency-Key schema: type: string - required: false - description: Optinal ID for programmers or agencies who are part of the program. + example: "0d5020ed-1af6-469c-ae06-c3bec19954bb" + description: This feature allows you to safely retry requests without the risk of accidentally performing the same action more than once. This is useful for avoiding errors, such as creating two identical Payment Intents, for example. To ensure that each request is unique, it's important to use an exclusive value in the header of your request. We suggest using a UUID V4 or random strings. x-description-i18n: - eng: Optinal ID for programmers or agencies who are part of the program. - spa: ID opcional para programadores o agencias que forman parte del programa . - por: ID opcional para programadores ou agências que fazem parte do programa . + eng: This feature allows you to safely retry requests without the risk of accidentally performing the same action more than once. This is useful for avoiding errors, such as creating two identical Payment Intents, for example. To ensure that each request is unique, it's important to use an exclusive value in the header of your request. We suggest using a UUID V4 or random strings. + spa: Esta función permite repetir solicitudes de manera segura, sin el riesgo de realizar la misma acción más de una vez por error. Esto es útil para evitar errores, como la creación de dos Payment Intents idénticas, por ejemplo. Para garantizar que cada solicitud sea única, es importante utilizar un valor exclusivo en el header de su solicitud. Sugerimos el uso de un UUID V4 o strings aleatorias. + por: Esta função permite repetir solicitações de forma segura, sem o risco de realizar a mesma ação mais de uma vez por engano. Isso é útil para evitar erros, como a criação de duas Payment-Intents idênticas, por exemplo. Para garantir que cada solicitação seja única, é importante usar um valor exclusivo no header da sua solicitação. Sugerimos o uso de um UUID V4 ou strings randômicas. - in: header - name: X-Frontend-Token + name: X-Auth-Method schema: - type: boolean - example: false - allowEmptyValue: false - description: Frontend Token - Boolean value indicating whether you want the application to return the client_token property, this property allows you to make calls directly from your frontend passing the client_token as authorization. + type: string + example: "payment_intent" + description: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". x-description-i18n: - eng: Frontend Token - Boolean value indicating whether you want the application to return the client_token property, this property allows you to make calls directly from your frontend passing the client_token as authorization. - spa: Frontend Token - Valor booleano que indica si desea que la aplicación devuelva la propiedad client_token, esta propiedad le permite realizar llamadas directamente desde su frontend pasando el client_token como autorización. - por: Frontend Token - Valor booleano indicando se deseja que a aplicação retorne a propriedade client_token, está propriedade permite que realize chamadas diretamente do seu frontend passando como autorização o client_token. + eng: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". + spa: Este campo especifica el método de autenticación en uso. Cuando se utiliza el "client token" como medio de autorización, este header se vuelve obligatorio. Establezca su valor como "payment_intent". + por: Este campo especifica o método de autenticação em uso. Quando se utiliza o "client token" como meio de autorização, este header é obrigatório. Defina seu valor como "payment_intent". requestBody: - description: Complete body for a Payment Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. + description: Complete body to create and process a Payment Intent. x-description-i18n: - eng: Complete body for a Payment Intent request in Builder mode. The minimum requirement for this body is a request containing the payer's email address and the order amount. - spa: Body completo para una solicitud de Payment Intent en modo Builder. El requisito mínimo para este body es una solicitud que contenga la dirección de correo electrónico del pagador y el monto del pedido. - por: Body completo para uma requisição de Payment Intent no modo Builder. O requisito mínimo para esse body consiste em um pedido contendo o endereço de e-mail do pagador e o valor do pedido. + eng: Complete body to create and process a Payment Intent. + spa: Body completo para crear y procesar una Payment Intent. + por: Body completo para criar e processar uma Payment Intent. content: application/json: schema: type: object properties: + active_to_date: + type: string + description: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + x-description-i18n: + eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Payment Intent. Este prazo determina a data-limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + configuration: + type: object + description: Predefined configuration parameters set by the seller before initiating the payment. + x-description-i18n: + eng: Predefined configuration parameters set by the seller before initiating the payment. + spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. + por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. + properties: + integration: + type: object + description: Configuration of the seller on integration. + x-description-i18n: + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do seller sobre a integração. + properties: + notification_url: + type: string + description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). + x-description-i18n: + eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). + spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). + por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). + example: "https://www.integrator-site.com/api/notifications" + return_url_default: + description: Status URLs available to redirect buyer after completion of payment attempt. + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt. + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. + type: string + example: "https://www.integrator-site.com/order/deafult" + return_url_success: + description: URL to redirect the buyer in case of successful payment. + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. + return_url_pending: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. + return_url_failure: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. + por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. order: description: Order containing all the essential information for the execution of a payment. x-description-i18n: @@ -71,15 +135,80 @@ paths: por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object properties: + external_reference: + type: string + example: "my_order_id" + description: Reference of the order. + x-description-i18n: + eng: Reference of the order. + spa: Referencia de lá order. + por: Referência da order. + description: + type: string + example: "my_order_description" + description: Description of the order or payment. + x-description-i18n: + eng: Description of the order or payment. + spa: Descricion de la orden o transacción. + por: Descrição da ordem ou transação. amount: required: true type: string example: "50.00" - description: Total amount to be paid. For example, "50.00". + description: Total amount to be paid. + x-description-i18n: + eng: Total amount to be paid. + spa: Monto total que se desea cobrar. + por: Valor total a ser pago. + items: + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: - eng: Total amount to be paid. For example, "50.00". - spa: Monto total que se desea cobrar. Por ejemplo, "50.00". - por: Valor total a ser pago. Por exemplo, "50.00". + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + type: array + items: + properties: + id: + type: string + example: "x76ax" + description: Item identification code. For example, "x76ax". + x-description-i18n: + eng: Item identification code. For example, "x76ax". + spa: Código de identificación del ítem. Por ejemplo, "x76ax". + por: Código de identificação do item. Por exemplo, "x76ax". + quantity: + type: number + example: 4 + description: Number of item included in the order. + x-description-i18n: + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos na ordem. + unit_price: + type: string + example: "100.00" + description: Unit value of the item. For example, "100.00". + x-description-i18n: + eng: Unit value of the item. For example, "100.00". + spa: Precio unitario del ítem. Por ejemplo, "100.00". + por: Preço unitário do item. Por exemplo, "100.00". + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the items comprising the list of products included in the order. + x-description-i18n: + eng: Description of the items comprising the list of products included in the order. + spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. + por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. payer: type: object description: Buyer's information. @@ -91,548 +220,630 @@ paths: email: required: true type: string + example: "test@test.com" description: Buyer's email. x-description-i18n: eng: Buyer's email. spa: Email del comprador. por: Email do comprador. - responses: - "200": - description: success - content: - application/json: - schema: - type: object - properties: - id: - type: string - example: "00001njp2i" - description: ID of a created Payment Intent. - x-description-i18n: - eng: ID of a created Payment Intent. - spa: ID de la Payment Intent creada. - por: ID da Payment Intent criada. - created_date: - type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - x-description-i18n: - eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". - format: date-time - status: - type: string - example: "authorized" - description: Current status of the Payment Intent. - x-description-i18n: - eng: Current status of the Payment Intent. - spa: Status actual de la Payment Intent. - por: Status atual da Payment Intent. - enum: - - new--nova - - payment_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelada - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - x-description-i18n: - eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - configuration: - type: object - description: Predefined configuration parameters set by the seller before initiating the payment. - x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. - properties: - option: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - purpose: - type: string - description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - x-description-i18n: - eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a payment method during the payment. - x-description-i18n: - eng: Coupons can be used as a payment method during the payment. - spa: Los cupones se pueden utilizar como método de pago durante la transacción. - por: Os cupons podem ser utilizados como forma de pagamento durante a transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - type: array - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - items: - type: string - example: credit_card, debit_card - disabled: - example: "credit_card" - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: visa, master - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier. For example, "credit_card". - x-description-i18n: - eng: Payment method identifier For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a oferecer. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a oferecer. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: ticket, account_money - default: - type: string - example: "credit_card" - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. - integration: - type: object - description: Configuration of the seller on integration. - x-description-i18n: - eng: Configuration of the seller on integration. - spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. - properties: - notification_url: - type: string - description: URL to which notifications will be sent - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent. - spa: URL a la cual se enviarán las notificaciones. - por: URL para a qual as notificações serão enviadas. - return_url_default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - return_url_pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - return_url_failure: - description: Redirection URL for the event of buyer payment failure. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: Redirection URL for the event of buyer payment failure. - spa: URL de redirección para el caso de fallo en el pago del comprador. - por: URL de redirecionamento para o caso de falha no pagamento do comprador. - order: - type: object - description: Common Order attributes for request and response. - x-description-i18n: - eng: Common Order attributes for request and response. - spa: Atributos de Order comunes para el request y el response. - por: Atributos de Order comuns para o request e o response. - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. - external_reference: - type: string - example: "my_order_id" - description: Reference of the order. - x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - description: - type: string - example: "my_order_description" - description: Description for the order or payment. - x-description-i18n: - eng: Description for the order or payment. - spa: Descripción de la orden o transacción. - por: Descrição da ordem ou transação. - amount: - example: "233.00" - type: string - description: Total value of the payment. For example, "233.00". - x-description-i18n: - eng: Total value of the payment. For example, "233.00". - spa: Monto total de la transacción. Por ejemplo, "233.00". - por: Valor total da transação. Por exemplo, "233.00". - items: - description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - x-description-i18n: - eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array - items: + customer_id: + type: string + example: "123456" + description: Previously stored buyer identification number. + x-description-i18n: + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. + identification: type: object - description: List of items included in the order. + description: This field refers to the type and number of the document used to identify a person within the country. x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. properties: - id: - type: string - example: "x76ax" - description: Item identification code. For example, "x76ax". + number: + description: Number of the document. x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". - quantity: - type: number - example: 4 - description: Number of item included in the order. + eng: Number of the document. + spa: Número del documento. + por: Número do documento. + type: string + example: "12345678098" + type: + description: Type of the document. x-description-i18n: - eng: Number of item included in the order. - spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. - unit_price: + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. type: string - example: "100.00" - description: Unit price of the item. For example, "100.00". + example: "CPF" + name: + type: string + example: "John" + description: Buyer's name. + x-description-i18n: + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. + surname: + type: string + example: "Doe" + description: Buyer's surname. + x-description-i18n: + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. + address: + type: object + description: Address of the buyer. + x-description-i18n: + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name. x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". - dimensions: + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. + street_number: type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. + example: "100" + description: Street number. x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: + eng: Street number. + spa: Número de la calle. + por: Número da casa. + zip_code: type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. + example: "57000-865" + description: Zip code. x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - collectors: - type: object - description: Seller user who receives the payment. - x-description-i18n: - eng: Seller user who receives the payment. - spa: Usuario vendedor que recibe el pago. - por: Usuário vendedor que recebe o pagamento. - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier. - x-description-i18n: - eng: Collector identifier. - spa: Identificador del collector. - por: Identificador do collector. - amount: - type: string - example: "50.00" - description: Amount of the payment corresponding to the collector. - x-description-i18n: - eng: Amount of the payment corresponding to the collector. - spa: Monto de la transacción que corresponde al collector. - por: Valor da transação correspondente ao collector. - payer: - type: object - description: Buyer's information. - x-description-i18n: - eng: Buyer's information. - spa: Información del comprador. - por: Informações do comprador. - properties: - email: - type: string - description: Buyer's email. - x-description-i18n: - eng: Buyer's email. - spa: Email del comprador. - por: Email do comprador. - example: test@test.com - customer_id: - type: number - example: 123456 - description: Previously stored buyer identification number. - x-description-i18n: - eng: Previously stored buyer identification number. - spa: Número de identificación del comprador previamente almacenado. - por: Número de identificação do comprador previamente armazenado. - identification: - type: object - description: This field refers to the type and number of the document used to identify a person within the country. - x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. + eng: Zip code. + spa: Código postal. + por: Código postal. + phone: + type: object + description: Buyer's phone number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + properties: + area_code: + type: string + description: Buyer's area code. + x-description-i18n: + eng: Buyer's area code. + spa: Código de área del comprador. + por: Código de área do comprador. + example: "11" + number: + type: string + description: Buyer's phone number number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + example: "99999999" + advanced: + type: object + description: Options for advanced payment. + x-description-i18n: + eng: Options for advanced payment. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. + properties: + binary_mode: + type: boolean + example: true + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. + x-description-i18n: + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. + payment_method: + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. This parameter is required for the create and process the payment-intent in the same flow. + x-description-i18n: + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. This parameter is required for the create and process the payment-intent in the same flow. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. Ese parámetro es obligatorio para crear y procesar el payment-intent en el mismo flujo. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. Este parametro é obrigatório para criar e processar o pagamento-intent no mesmo fluxo. + type: object + properties: + credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. + type: array + items: properties: - number: - description: Number of the document. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Number of the document. - spa: Número del documento. - por: Número do documento. + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: type: string - example: "12345678098" - type: - description: Type of the document. + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Type of the documento. - spa: Tipo de documento. - por: Tipo de documento. + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_method_id: type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name. - x-description-i18n: - eng: Buyer's name. - spa: Nombre del comprador. - por: Nome do comprador. - surname: - type: string - example: "Doe" - description: Buyer's surname. - x-description-i18n: - eng: Buyer's surname. - spa: Apellido del comprador. - por: Sobrenome do comprador. - address: - type: object - description: Address of the buyer. - x-description-i18n: - eng: Address of the buyer. - spa: Dirección del comprador. - por: Endereço do comprador. + example: "visa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + installments: + type: number + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + debit_cards: + description: Debit cards. + x-description-i18n: + eng: Debit cards. + spa: Tarjetas de débito. + por: Cartões de débito. + type: array + items: properties: - street_name: + amount: type: string - example: "Street MercadoLivre" - description: Street name + example: "50.00" + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Street name. - spa: Nombre de la calle. - por: Nome da rua. - street_number: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: type: string - example: "100" - description: Street number. + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the debit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Street number. - spa: Número de la calle. - por: Número da casa. - zip_code: + eng: Card token that represents securely the debit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_method_id: type: string - example: "57000-865" - description: Zip code. + example: "debvisa" + description: Identifier of the chosen payment method. x-description-i18n: - eng: Zip covered. - spa: Código postal. - por: Código postal. - phone: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + tickets: + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "pec" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + atms: + description: ATM (Automated Teller Machine). + x-description-i18n: + eng: ATM (Automated Teller Machine). + spa: Cajero automático. + por: Caixa eletrônico. + type: array + items: type: object - description: Buyer's phone number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. properties: - area_code: + amount: type: string - description: Buyer's area code. + example: "50.00" + description: Total amount to be paid with this payment method. x-description-i18n: - eng: Buyer's area code. - spa: Código de área del comprador. - por: Código de área do comprador. - example: "11" - number: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: type: string - description: Buyer's phone number number. + example: "bapropagos" + description: Identifier of the chosen payment method. x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - example: "99999999" - advanced: - type: object - description: Options for advanced payment. - x-description-i18n: - eng: Options for advanced payment. - spa: Agrupación de opciones avanzadas para la transacción. - por: Opções avançadas para a transação. + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + bank_transfers: + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. + type: array + items: + type: object + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "banco_mp" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + responses: + "200": + description: success + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Payment Intent. + x-description-i18n: + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. + client_token: + type: string + example: "" + description: Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. + x-description-i18n: + eng: Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. + spa: Client Token es el token generado a partir de la devolución de una intención de pago no procesada, estará disponible en la propiedad client_token, este token se puede usar para llamadas a partir de frontend. + por: Client Token é o token gerado a partir do retorno de uma payment intent não processada, estará disponibilizado na propriedade client_token, este token pode ser usado para chamadas de seu frontend. + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time + status: + type: string + example: "processed" + description: Current status of the Payment Intent. + x-description-i18n: + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. + enum: + - "new--it created but not processed" + - "transaction_in_process--it was processing, it is not conclusive. We can see the conclusive status in Webhook." + - "processed--it was processed with success." + - "partially_processed--it was partially processed, and it needs the second operation to finish with processed (specific to payment flow with two operations)." + - "partially_reverted--it was partially reverted. The revert is about some items, not total purchase." + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + integration: + type: object + description: Configuration of the seller on integration. + x-description-i18n: + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do vendedor sobre a integração. + properties: + notification_url: + type: string + description: URL to which notifications will be sent. + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. + return_url_default: + description: Default URL to redirect the buyer. + x-description-i18n: + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment. + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. + return_url_pending: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. + return_url_failure: + description: URL to redirect the buyer in case of failed payment. + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment. + spa: URL a la cual se redireccionará al comprador en caso de pago fallido. + por: URL para redirecionar o comprador em caso de pagamento falhou. + order: + type: object + description: Common Order attributes for request and response. + x-description-i18n: + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. + properties: + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: Description of the order or payment. + x-description-i18n: + eng: Description of the order or payment. + spa: Descricion de la orden o transacción. + por: Descrição da ordem ou transação. + amount: + type: string + example: "233.00" + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + items: + properties: + id: + type: string + example: "x76ax" + description: Item identification code. + x-description-i18n: + eng: Item identification code. + spa: Código de identificación del ítem. + por: Código de identificação do item. + quantity: + type: number + example: 4 + description: Number of item included in the order. + x-description-i18n: + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos no pedido. + unit_price: + type: string + example: "100.00" + description: Unit price of the item. + x-description-i18n: + eng: Unit value of the item. + spa: Precio unitario del ítem. + por: Preço unitário do item. + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items. + x-description-i18n: + eng: Description of the item that makes up the list of order items. + spa: Descripción del artículo que componen el listado de items de la orden. + por: Descrição do item que compõe a lista de itens do pedido. + payer: + type: object + description: Buyer's information. + x-description-i18n: + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. + properties: + email: + type: string + description: Buyer's email. + x-description-i18n: + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. + customer_id: + type: number + example: 123456 + description: Previously stored buyer identification number. + x-description-i18n: + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. + identification: + type: object + description: Type and number of legal document that identifies the person in the country. + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country. + spa: Tipo y número de documento legal que identifica a la persona en el país. + por: Tipo e número de documento que identifica a pessoa no país. + properties: + number: + type: string + example: "12345678098" + description: Number of the document. + x-description-i18n: + eng: Number of the document. + spa: Número del documento. + por: Número do documento. + type: + type: string + example: "CPF" + description: Type of the document. + x-description-i18n: + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. + address: + type: object + description: Address of the buyer. + x-description-i18n: + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name. + x-description-i18n: + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. + street_number: + type: string + example: "100" + description: Street number. + x-description-i18n: + eng: Street number. + spa: Número de la calle. + por: Número da casa. + zip_code: + type: string + example: "57000-865" + description: Zip code. + x-description-i18n: + eng: Zip code. + spa: Código postal. + por: Código postal. + phone: + type: object + description: Buyer's phone number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction. + x-description-i18n: + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - sponsor_id: - type: number - example: 123456789 - description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). x-description-i18n: - eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. - spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. - por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona). + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono). amount_details: - description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - x-description-i18n: - eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. - por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object + description: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + x-description-i18n: + eng: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + spa: Este campo incluye detalles relativos a los importes de las transacciones, incluido el importe pagado y, en situaciones de reembolso, el importe total reembolsado. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. properties: total: type: string example: "123.00" - description: Details of the total value of the payment. + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the payment. + eng: Details of the total value of the transaction. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -650,56 +861,56 @@ paths: x-description-i18n: eng: Total value refunded. spa: Monto de la transacción devuelto. - por: Valor total reembolsado. - shipment: - type: string - example: "10.00" - description: Total value charged per shipment. - x-description-i18n: - eng: Total value charged per shipment. - spa: Monto cobrado por envío (incluido en total). - por: Valor cobrado por envio (incluído no total). + por: Valor reembolsado. payment_method: + type: object description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object properties: credit_cards: + type: array description: Credit cards. x-description-i18n: eng: Credit cards. spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array + por: Cartão de crédito. items: properties: + installments: + type: number + example: 1 + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + payment_id: + type: number + example: 12345432 + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. + description: Card token that represents securely the credit card data. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: Card token that represents securely the credit card data. + spa: Card token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. payment_method_id: type: string example: "visa" @@ -716,14 +927,6 @@ paths: eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 statement_descriptor: type: string example: "MERCADOPAGO" @@ -731,50 +934,26 @@ paths: x-description-i18n: eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. @@ -782,45 +961,69 @@ paths: por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. type: array + description: Debit card. + x-description-i18n: + eng: Debit card. + spa: Tarjeta de débito. + por: Cartão de débito. items: properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. + description: Card token that represents securely the credit card data. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: Card token that represents securely the credit card data. + spa: card_token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. payment_method_id: type: string example: "debvisa" @@ -832,62 +1035,38 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + description: In case it is required, identifier of the card issuer entity. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + eng: In case it is required, identifier of the card issuer entity. + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta. + por: Caso seja requerido, identificador da entidade emissora do cartão. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. + description: Descriptor of the charge to be shown in the card statement. x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. + eng: descriptor of the charge to be shown in the card statement. + spa: Descriptor del cargo a utilizar en el resumen del emisor. + por: Descritor da cobrança a ser mostrada no extrato do cartão. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. @@ -895,192 +1074,193 @@ paths: por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. tickets: + type: array description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. x-description-i18n: eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array items: properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "pec" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. spa: Código del status del pago. - por: Código do status do Pagamento. + por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. + spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. atms: - description: ATM (Automated Teller Machine). + type: array + description: Automated Teller Machine. x-description-i18n: - eng: ATM (Automated Teller Machine). + eng: Automated Teller Machine. spa: Cajero automático. por: Caixa eletrônico. - type: array items: - type: object properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "bapropagos" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. completion_url: type: string + example: "" description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: eng: For offline payments, this is the URL that enables the continuation of the payment flow. spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. + status: + type: string + example: "pending" + description: Status of the payment. x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: + eng: Status of the payment. + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detailed information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. @@ -1088,115 +1268,168 @@ paths: por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. + por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. bank_transfers: + type: array description: Bank transfers. x-description-i18n: eng: Bank transfers. spa: Transferencias bancarias. por: Transferências bancárias. - type: array items: - type: object properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "banco_mp" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. + spa: Estado del pago. + por: Estado do pagamento. completion_url: type: string + example: "" description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: eng: For offline payments, this is the URL that enables the continuation of the payment flow. spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Bad Request + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Bad Request. + "401": + description: Unauthorized + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unauthorized. + "403": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Forbidden. + "404": + description: Not Found content: application/json: schema: @@ -1205,19 +1438,53 @@ paths: errorKey: type: string enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. + - Not Found. + "408": + description: Request Timeout + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Request Timeout. + "409": + description: Conflict + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Conflict. + "422": + description: Unprocessable Entity + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unprocessable Entity. "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Internal Server Error. + "503": + description: Service Unavailable content: application/json: schema: @@ -1226,8 +1493,7 @@ paths: errorKey: type: string enum: - - 500--Unexpected Error. - - 503--Service Unavailable. + - Service Unavailable. /v1/payment-intents/authorize: post: tags: @@ -1249,27 +1515,28 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. x-description-i18n: - eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. - spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. - por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. + eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - in: header - name: X-Integrator-ID + name: X-Idempotency-Key schema: type: string + example: "0d5020ed-1af6-469c-ae06-c3bec19954bb" required: false - description: Optinal ID for programmers or agencies who are part of the program. + description: This feature allows you to safely retry requests without the risk of accidentally performing the same action more than once. This is useful for avoiding errors, such as creating two identical Payment Intents, for example. To ensure that each request is unique, it's important to use an exclusive value in the header of your request. We suggest using a UUID V4 or random strings. x-description-i18n: - eng: Optinal ID for programmers or agencies who are part of the program. - spa: ID opcional para programadores o agencias que forman parte del programa . - por: ID opcional para programadores ou agências que fazem parte do programa . + eng: This feature allows you to safely retry requests without the risk of accidentally performing the same action more than once. This is useful for avoiding errors, such as creating two identical Payment Intents, for example. To ensure that each request is unique, it's important to use an exclusive value in the header of your request. We suggest using a UUID V4 or random strings. + spa: Esta función permite repetir solicitudes de manera segura, sin el riesgo de realizar la misma acción más de una vez por error. Esto es útil para evitar errores, como la creación de dos Payment Intents idénticas, por ejemplo. Para garantizar que cada solicitud sea única, es importante utilizar un valor exclusivo en el header de su solicitud. Sugerimos el uso de un UUID V4 o strings aleatorias. + por: Esta função permite repetir solicitações de forma segura, sem o risco de realizar a mesma ação mais de uma vez por engano. Isso é útil para evitar erros, como a criação de duas Payment-Intents idênticas, por exemplo. Para garantir que cada solicitação seja única, é importante usar um valor exclusivo no header da sua solicitação. Sugerimos o uso de um UUID V4 ou strings randômicas. requestBody: - description: Complete body for authorizing payments of a Payment Intents. + description: Complete body to authorize a Payment-Intent. x-description-i18n: - eng: Complete body for authorizing payments of a Payment Intents. - spa: Body completo para autorizar los pagos de una Payment Intents. - por: Body completo para autorização de pagamentos de uma Payment Intents. + eng: Complete body to authorize a Payment-Intent. + spa: Body completo para autorizar una Payment-Intent. + por: Body completo para autorizar uma Payment-Intent. content: application/json: schema: @@ -1277,11 +1544,11 @@ paths: properties: active_to_date: type: string - description: Maximum processing deadline for the payment intents. This deadline sets the date by which the Payment Intents is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + description: Maximum processing deadline for the Payment-Intent. This deadline sets the date by which the Payment-Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". x-description-i18n: - eng: Maximum processing deadline for the payment intents. This deadline sets the date by which the Payment Intents is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - spa: Plazo máximo de procesamiento para la Payment Intents. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intents sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". - por: Prazo máximo de processamento para a Payment Intents. Este prazo determina a data-limite até a qual se espera que a Payment Intents seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". + eng: Maximum processing deadline for the Payment-Intent. This deadline sets the date by which the Payment-Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment-Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment-Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". + por: Prazo máximo de processamento para a Payment-Intent. Este prazo determina a data-limite até a qual se espera que a Payment-Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" configuration: @@ -1292,160 +1559,6 @@ paths: spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: - options: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - payment_methods: - required: true - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a payment method during the payment. - x-description-i18n: - eng: Coupons can be used as a payment method during the payment. - spa: Los cupones se pueden utilizar como método de pago durante la transacción. - por: Os cupons podem ser utilizados como forma de pagamento durante a transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: [ "credit_card", "debit_card" ] - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: [ "visa", "master" ] - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier. For example, "credit_card". - x-description-i18n: - eng: Payment method identifier. For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a serem disponibilizadas. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a serem disponibilizadas. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: [ "ticket", "account_money" ] - default: - type: string - example: "credit_card" - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. - purpose: - type: string - description: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". - x-description-i18n: - eng: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". - example: [ "wallet_purchase", "onboarding_credits" ] integration: type: object description: Configuration of the seller on integration. @@ -1454,102 +1567,70 @@ paths: spa: Configuración del seller sobre la integración. por: Configuração do seller sobre a integração. properties: - notifications: - description: Parameter concerning notification URL settings for conducted payments. - x-description-i18n: - eng: Parameter concerning notification URL settings for conducted payments. - spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. - por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). - por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt. - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt. - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. - properties: - default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - failure: - description: URL to redirect the buyer in case of failed payment. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. - por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system. + notification_url: + type: string + description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). x-description-i18n: - eng: Seller's identifier in the integrator's system. - spa: Identificador del seller en el sistema del integrador. - por: Identificador do seller no sistema do integrador. + eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). + spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). + por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). + example: "https://www.integrator-site.com/api/notifications" + return_url_default: + description: Status URLs available to redirect buyer after completion of payment attempt. + x-description-i18n: + eng: Status URLs available to redirect buyer after completion of payment attempt. + spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. + por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. + type: string + example: "https://www.integrator-site.com/order/deafult" + return_url_success: + description: URL to redirect the buyer in case of successful payment. + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. + return_url_pending: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. + return_url_failure: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. + por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. order: description: Order containing all the essential information for the execution of a payment. x-description-i18n: - eng: Order containing all the essential information for the execution of a payment. - spa: Orden que contiene toda la información esencial para la ejecución de una transacción. - por: Ordem contendo todas as informações essenciais para a execução de uma transação. + eng: Order containing all the essential information for the execution of a payment. + spa: Orden que contiene toda la información esencial para la ejecución de una transacción. + por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string - example: "my_order_id" - description: Reference of the order. + example: "" + description: ID in integrator's external system. x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - reason: + eng: ID in integrator's external system. + spa: ID en sistema externo del integrador. + por: ID no sistema externo do integrador. + description: type: string example: "my_order_description" - description: Reason for the order or payment. + description: Reason or description of the order or transaction. x-description-i18n: - eng: Reason for the order or payment. - spa: Motivo de la orden o transacción. - por: Motivo da ordem ou transação. + eng: Reason or description of the order or transaction. + spa: Motivo o descripcion de la orden o transacción. + por: Motivo ou descrição da ordem ou transação. amount: required: true type: string @@ -1564,16 +1645,9 @@ paths: x-description-i18n: eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array - items: - type: object - description: List of items included in the order. - x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. - properties: + properties: id: type: string example: "x76ax" @@ -1625,14 +1699,15 @@ paths: email: required: true type: string + example: "test@test.com" description: Buyer's email. x-description-i18n: eng: Buyer's email. spa: Email del comprador. por: Email do comprador. customer_id: - type: number - example: 123456 + type: string + example: "123456" description: Previously stored buyer identification number. x-description-i18n: eng: Previously stored buyer identification number. @@ -1750,613 +1825,127 @@ paths: eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - marketplace: - type: object - description: In the event of a marketplace-type integration, this configuration is applicable to the collector. - x-description-i18n: - eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. - spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. - por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. - properties: - fee: - type: string - example: "5" - description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - x-description-i18n: - eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. - por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account responsible for paying the commissions. - x-description-i18n: - eng: ID of the Mercado Pago account responsible for paying the commissions. - spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. - por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. - payment_method: - description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + payment_method: + required: true + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object + properties: + credit_cards: + required: true + description: Credit cards. x-description-i18n: - eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. - por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object - properties: - credit_cards: - description: Credit cards. - x-description-i18n: - eng: Credit cards. - spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. - x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do Pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - atms: - description: ATM (Automated Teller Machine). - x-description-i18n: - eng: ATM (Automated Teller Machine). - spa: Cajero automático. - por: Caixa eletrônico. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - bank_transfers: - description: Bank transfers. - x-description-i18n: - eng: Bank transfers. - spa: Transferencias bancarias. - por: Transferências bancárias. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - responses: - "200": - description: accepted - content: - application/json: - schema: - type: object - properties: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. + type: array + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio de pago. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + x-description-i18n: + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + installments: + type: number + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + example: 1 + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + responses: + "200": + description: Success + content: + application/json: + schema: + type: object + properties: id: type: string example: "00001njp2i" - description: ID of a created Payment Intents. + description: ID of a created Payment-Intent. + x-description-i18n: + eng: ID of a created Payment-Intent. + spa: ID de la Payment-Intent creada. + por: ID da Payment-Intent criada. + client_token: + type: string + example: "" + description: Client Token is the token generated from the return of an unprocessed Payment-Intent, it will be available in the client_token property, this token can be used for calls from the frontend. x-description-i18n: - eng: ID of a created Payment Intents. - spa: ID de la Payment Intents creada. - por: ID da Payment Intents criada. + eng: Client Token is the token generated from the return of an unprocessed Payment-Intent, it will be available in the client_token property, this token can be used for calls from the frontend. + spa: Client Token es el token generado a partir de la devolución de una Payment-Intent no procesada, estará disponible en la propiedad client_token, este token se puede usar para llamadas a partir de frontend. + por: Client Token é o token gerado a partir do retorno de uma Payment-Intent não processada, estará disponibilizado na propriedade client_token, este token pode ser usado para chamadas de seu frontend. + active_to_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Maximum processing deadline for the Payment-Intent. This deadline sets the date by which the Payment-Intent is expected to be processed and completed. + x-description-i18n: + eng: Maximum processing deadline for the Payment-Intent. This deadline sets the date by which the Payment-Intent is expected to be processed and completed. + spa: Plazo máximo de procesamiento para la Payment-Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment-Intent sea procesada y completada. + por: Prazo máximo de processamento para Payment-Intent. Este prazo determina a data limite até a qual se espera que a Payment-Intent seja processada e finalizada. + format: date-time created_date: type: string example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Payment Intents. For example, "2023-09-06T08:00:00.000-03:00". + description: Date of creation of the Payment-Intent. For example, "2023-09-06T08:00:00.000-03:00". x-description-i18n: - eng: Date of creation of the Payment Intents. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Payment Intents. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Payment Intents. Por exemplo, "2023-09-06T08:00:00.000-03:00". + eng: Date of creation of the Payment-Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment-Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment-Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time status: type: string example: "authorized" - description: Current status of the Payment Intents. + description: Current status of the Payment-Intent. x-description-i18n: - eng: Current status of the Payment Intents. - spa: Status actual de la Payment Intents. - por: Status atual da Payment Intents. + eng: Current status of the Payment-Intent. + spa: Status actual de la Payment-Intent. + por: Status atual da Payment-Intent. enum: - - new--nova - - payment_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelada - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - x-description-i18n: - eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + - authorized--the status is an intermediary. It indicates that the payment was authorized and the amount was reserved. + - failed--processing failed, if there is any pending transaction it will be reverted. + - canceled--succession cancellation, it is only allowed for flows that the previous status was authorized. configuration: type: object description: Predefined configuration parameters set by the seller before initiating the payment. @@ -2365,158 +1954,6 @@ paths: spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. properties: - option: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - purpose: - type: string - description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - x-description-i18n: - eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. - payment_methods: - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a methods of payment in the payment. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the payment. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: credit_card, debit_card - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: visa, master - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier For example, "credit_card". - x-description-i18n: - eng: Payment method identifier For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a oferecer. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a oferecer. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: ticket, account_money - default: - type: string - example: "credit_card" - description: Payment method to offer by default - x-description-i18n: - eng: Payment method to offer by default - spa: Tipo de medio de pago a ofrecer por defecto - por: Tipos de meios de pagamento a oferecer por padrão integration: type: object description: Configuration of the seller on integration. @@ -2567,28 +2004,20 @@ paths: por: URL de redirecionamento para o caso de falha no pagamento do comprador. order: type: object - description: Common Order attributes for request and response. + description: Order containing all the essential information for the execution of a payment. x-description-i18n: - eng: Common Order attributes for request and response. - spa: Atributos de Order comunes para el request y el response. - por: Atributos de Order comuns para o request e o response. + eng: Order containing all the essential information for the execution of a payment. + spa: Orden que contiene toda la información esencial para la ejecución de una transacción. + por: Ordem contendo todas as informações essenciais para a execução de uma transação. properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" - description: Reference of the order + description: ID in integrator's external system. x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. + eng: ID in integrator's external system. + spa: ID en sistema externo del integrador. + por: ID no sistema externo do integrador. description: type: string example: "my_order_description" @@ -2603,14 +2032,14 @@ paths: description: Total value of the payment. For example, "233.00". x-description-i18n: eng: Total value of the payment. For example, "233.00". - spa: Monto total de la transacción. Por ejemplo, "233.00".. + spa: Monto total de la transacción. Por ejemplo, "233.00". por: Valor total da transação. Por exemplo, "233.00". items: description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. type: array items: type: object @@ -2660,22 +2089,6 @@ paths: eng: Description of the items comprising the list of products included in the order. spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - collectors: - type: object - description: Seller user who receives the payment. - x-description-i18n: - eng: Seller user who receives the payment. - spa: Usuario vendedor que recibe el pago. - por: Usuário vendedor que recebe o pagamento. - properties: - amount: - type: string - example: "50.00" - description: Amount of the payment corresponding to the collector. - x-description-i18n: - eng: Amount of the payment corresponding to the collector. - spa: Monto de la transacción que corresponde al collector. - por: Valor da transação correspondente ao collector. payer: type: object description: Buyer's information. @@ -2684,6 +2097,13 @@ paths: spa: Información del comprador. por: Informações do comprador. properties: + customer_id: + type: string + description: Previously stored buyer identification number. + x-description-i18n: + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. email: type: string description: Buyer's email. @@ -2691,6 +2111,20 @@ paths: eng: Buyer's email. spa: Email del comprador. por: Email do comprador. + name: + type: string + description: Buyer's name. + x-description-i18n: + eng: Buyer's name. + spa: Nombre del comprador. + por: Nome do comprador. + surname: + type: string + description: Buyer's surname. + x-description-i18n: + eng: Buyer's surname. + spa: Apellido del comprador. + por: Sobrenome do comprador. identification: type: object description: This field refers to the type and number of the document used to identify a person within the country. @@ -2752,7 +2186,7 @@ paths: x-description-i18n: eng: Buyer's phone number. spa: Número de teléfono del comprador. - por: Número de telefone do comprador. + por: Número de telefone do comprador. type: object properties: area_code: @@ -2773,407 +2207,68 @@ paths: example: "99999999" advanced: type: object - description: Options for advanced payment. - x-description-i18n: - eng: Options for advanced payment. - spa: Agrupación de opciones avanzadas para la transacción. - por: Opções avançadas para a transação. - properties: - binary_mode: - type: boolean - example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account responsible for paying the commissions. - x-description-i18n: - eng: ID of the Mercado Pago account responsible for paying the commissions. - spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. - por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. - amount_details: - description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - x-description-i18n: - eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. - por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the payment. - x-description-i18n: - eng: Details of the total value of the payment. - spa: Detalles del monto total de la transacción. - por: Detalhes do valor total da transação. - paid: - type: string - example: "100.00" - description: Total paid. - x-description-i18n: - eng: Total paid. - spa: Monto de la transacción pagado. - por: Valor pago. - refunded: - type: string - example: "100.00" - description: Total value refunded. - x-description-i18n: - eng: Total value refunded. - spa: Monto de la transacción devuelto. - por: Valor total reembolsado. - payment_method: - description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - x-description-i18n: - eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. - por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object - properties: - credit_cards: - description: Credit cards. - x-description-i18n: - eng: Credit cards. - spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. - x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do Pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - atms: - description: ATM (Automated Teller Machine). + description: Options for advanced payment. + x-description-i18n: + eng: Options for advanced payment. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. + properties: + binary_mode: + type: boolean + example: true + description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. x-description-i18n: - eng: ATM (Automated Teller Machine). - spa: Cajero automático. - por: Caixa eletrônico. + eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. + spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. + por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. + amount_details: + description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + x-description-i18n: + eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. + spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. + type: object + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the payment. + x-description-i18n: + eng: Details of the total value of the payment. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. + paid: + type: string + example: "100.00" + description: Total paid. + x-description-i18n: + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. + refunded: + type: string + example: "100.00" + description: Total value refunded. + x-description-i18n: + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor total reembolsado. + payment_method: + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + type: object + properties: + credit_cards: + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartões de crédito. type: array items: - type: object properties: amount: type: string @@ -3182,135 +2277,55 @@ paths: x-description-i18n: eng: Total amount to be paid with this payment method. spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: + por: Total a ser pago com este meio de pagamento. + token: type: string - example: "bapropagos" - description: Identifier of the chosen payment method. + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. + eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". + por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". payment_id: type: number - example: 12345432423 + example: 12345432 description: Payment ID corresponding to the payment method. x-description-i18n: eng: Payment ID corresponding to the payment method. spa: ID de Pago correspondiente al medio de pago. por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - bank_transfers: - description: Bank transfers. - x-description-i18n: - eng: Bank transfers. - spa: Transferencias bancarias. - por: Transferências bancárias. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "banco_mp" + example: "visa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: + issuer: type: string - example: "pending" - description: Status of the payment. + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + installments: + type: number + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + example: 1 + statement_descriptor: type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. refunds: description: List of refunds related to the payment method. x-description-i18n: @@ -3322,11 +2337,11 @@ paths: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID del reembolso. + por: ID do reembolso. refund_amount: type: string example: "50.00" @@ -3335,11 +2350,19 @@ paths: eng: Amount of the refund. spa: Monto del reembolso. por: Valor do reembolso. - status_detail: + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Status del pago. + por: Status do pagamento. + response_detail: type: object - description: Detailed information about the status of the payment. + description: Detail information about the status of the payment. x-description-i18n: - eng: Detailed information about the status of the payment. + eng: Information about the status of the payment. spa: Información detallada sobre el status del pago. por: Informações detalhadas sobre o status do pagamento. properties: @@ -3360,11 +2383,73 @@ paths: spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Bad Request + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Bad Request. + "401": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unauthorized. + "403": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Forbidden. + "404": + description: Not Found + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Not Found. + "408": + description: Request Timeout + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Request Timeout. + "409": + description: Conflict + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Conflict. + "422": + description: Unprocessable Entity content: application/json: schema: @@ -3373,19 +2458,20 @@ paths: errorKey: type: string enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. + - Unprocessable Entity. "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Internal Server Error. + "503": + description: Service Unavailable content: application/json: schema: @@ -3394,6 +2480,4 @@ paths: errorKey: type: string enum: - - 500--Unexpected Error. - - 503--Service Unavailable. - + - Service Unavailable. diff --git a/reference/api/payment_intent_id.yaml b/reference/api/payment_intent_id.yaml index 7478b805cf..b0c00ab049 100644 --- a/reference/api/payment_intent_id.yaml +++ b/reference/api/payment_intent_id.yaml @@ -14,9 +14,9 @@ paths: eng: Get Payment Intent by ID spa: Obtener Payment Intent por ID por: Obter Payment Intent por ID - description: This endpoint allows you to retrieve an existing 'Payment Intent' using its ID as a parameter + description: This endpoint allows you to retrieve an existing Payment Intent using its ID as a parameter x-description-i18n: - eng: This endpoint allows you to retrieve an existing Payment Intent by using its ID as a parameter + eng: This endpoint allows you to retrieve an existing Payment Intent using its ID as a parameter spa: Este endpoint permite consultar una Payment Intent ya existente mediante su ID por: Este endpoint permite consultar uma Payment Intent existente utilizando seu ID como parâmetro parameters: @@ -24,23 +24,23 @@ paths: name: Authorization schema: type: string - example: "Bearer token-89987654567f-numeroToken" + example: "Bearer ACCESS_TOKEN_or_CLIENT_TOKEN" required: true - description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. + description: Access Token or Client Token - Access Token is the application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. x-description-i18n: - eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. - spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. - por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. + eng: Access Token or Client Token - Access Token is the application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. + spa: Access Token o Client Token - Access Token es la clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. Client Token es el token generado a partir de la devolución de una intención de pago no procesada, estará disponible en la propiedad client_token, este token se puede usar para llamadas a partir de frontend. + por: Access Token ou Client Token - Access Token é a chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. Client Token é o token gerado a partir do retorno de uma payment intent não processada, estará disponibilizado na propriedade client_token, este token pode ser usado para chamadas de seu frontend. - in: header - name: X-Integrator-ID + name: X-Auth-Method schema: type: string - required: false - description: Optinal ID for programmers or agencies who are part of the program. + example: "payment_intent" + description: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". x-description-i18n: - eng: Optinal ID for programmers or agencies who are part of the program. - spa: ID opcional para programadores o agencias que forman parte del programa . - por: ID opcional para programadores ou agências que fazem parte do programa . + eng: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". + spa: Este campo especifica el método de autenticación en uso. Cuando se utiliza el "client token" como medio de autorización, este header se vuelve obligatorio. Establezca su valor como "payment_intent". + por: Este campo especifica o método de autenticação em uso. Quando se utiliza o "client token" como meio de autorização, este header é obrigatório. Defina seu valor como "payment_intent". - name: id description: Payment Intent's Id. x-description-i18n: @@ -68,6 +68,14 @@ paths: eng: ID of a created Payment Intent. spa: ID de la Payment Intent creada. por: ID da Payment Intent criada. + client_token: + type: string + example: "" + description: Generated by an unprocessed Payment-Intent, this token can be used for calls from your frontend, replacing the value of the Authorization parameter. + x-description-i18n: + eng: Generated by an unprocessed Payment-Intent, this token can be used for calls from your frontend, replacing the value of the Authorization parameter. + spa: Generado por una Payment-Intent no procesada, este token se puede usar para llamadas desde su interfaz, reemplazando el valor del parámetro Autorización.. + por: Gerado por uma Payment-Intent não processada, este token pode ser usado para chamadas a partir do seu frontend, substituindo o valor do parâmetro Authorization. created_date: type: string example: "2023-09-06T08:00:00.000-03:00" @@ -79,263 +87,79 @@ paths: format: date-time status: type: string - example: "authorized" + example: "processed" description: Current status of the Payment Intent. x-description-i18n: eng: Current status of the Payment Intent. spa: Status actual de la Payment Intent. por: Status atual da Payment Intent. enum: - - new--nova - - payment_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelada - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - x-description-i18n: - eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + - "new--it created but not processed" + - "transaction_in_process--it was processing, it is not conclusive. We can see the conclusive status in Webhook." + - "processed--it was processed with success." + - "partially_processed--it was partially processed, and it needs the second operation to finish with processed (specific to payment flow with two operations)." + - "partially_reverted--it was partially reverted. The revert is about some items, not total purchase." + - "reverted--it was reverted with success. It could happen in two cases. Case 01: the revert processed in total amount paid. Case 02: the payment was captured, but it was not processed appropriately, so it will be reverted." + - "failed--processing failed, if there is any pending transaction it will be reverted." + - "canceled--succession cancellation, it is only allowed for flows that the previous status was authorized." + - "authorized--the status is an intermediary. It indicates that the payment was authorized and the amount was reserved." + - "charged_back--the final status for a payer's contestation in your financial institution." configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the payment. + description: Configuration parameters defined by the seller before starting the transaction x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação properties: - option: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - purpose: - type: string - description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - x-description-i18n: - eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a methods of payment in the payment. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the payment. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: credit_card, debit_card - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: visa, master - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier For example, "credit_card". - x-description-i18n: - eng: Payment method identifier For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a oferecer. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a oferecer. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: ticket, account_money - default: - type: string - example: "credit_card" - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. integration: type: object description: Configuration of the seller on integration. x-description-i18n: eng: Configuration of the seller on integration. spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. + por: Configuração do vendedor sobre a integração. properties: - notifications: - description: Parameter related to the configuration of notification URLs for completed payments. + notification_url: + type: string + description: URL to which notifications will be sent. + example: "https://www.integrator-site.com/notifications" x-description-i18n: - eng: Parameter related to the configuration of notification URLs for completed payments. - spa: Parámetro relacionado con la configuración de las URLs de notificación para transacciones completadas. - por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. - type: object - properties: - notification_url: - type: string - description: URL to which notifications will be sent. - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent. - spa: URL a la cual se enviarán las notificaciones. - por: URL para a qual as notificações serão enviadas. - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt. - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt. - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. - properties: - default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - failure: - description: Redirection URL for the event of buyer payment failure. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: Redirection URL for the event of buyer payment failure. - spa: URL de redirección para el caso de fallo en el pago del comprador. - por: URL de redirecionamento para o caso de falha no pagamento do comprador. - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system. + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. + return_url_default: + description: Default URL to redirect the buyer. + x-description-i18n: + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment. + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. + return_url_pending: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. + return_url_failure: + description: URL to redirect the buyer in case of failed payment. + type: string + example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: Seller's identifier in the integrator's system. - spa: Identificador del seller en el sistema del integrador. - por: Identificador do vendedor no sistema do integrador. + eng: URL to redirect the buyer in case of failed payment. + spa: URL a la cual se redireccionará al comprador en caso de pago fallido. + por: URL para redirecionar o comprador em caso de pagamento falhou. order: type: object description: Common Order attributes for request and response. @@ -344,56 +168,47 @@ paths: spa: Atributos de Order comunes para el request y el response. por: Atributos de Order comuns para o request e o response. properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" description: Reference of the order x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - reason: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: type: string example: "my_order_description" - description: Reason for the order or payment. + description: Description of the order or payment. x-description-i18n: - eng: Reason for the order or payment. - spa: Motivo de la orden o transacción. - por: Motivo da ordem ou transação. + eng: Description of the order or payment. + spa: Descricion de la orden o transacción. + por: Descrição da ordem ou transação. amount: - example: "233.00" type: string - description: Total amount to be paid. + example: "233.00" + description: Total value of the transaction x-description-i18n: - eng: Total amount to be paid. - spa: Monto total que se desea cobrar. - por: Valor total a ser pago. + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação items: + type: array description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array items: - type: object properties: id: type: string example: "x76ax" - description: Item identification code. For example, "x76ax". + description: Item identification code. x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". + eng: Item identification code. + spa: Código de identificación del ítem. + por: Código de identificação do item. quantity: type: number example: 4 @@ -401,15 +216,15 @@ paths: x-description-i18n: eng: Number of item included in the order. spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. + por: Quantidade de itens incluídos no pedido. unit_price: type: string example: "100.00" - description: Unit value of the item. For example, "100.00". + description: Unit price of the item. x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". + eng: Unit value of the item. + spa: Precio unitario del ítem. + por: Preço unitário do item. dimensions: type: string example: "30x30x30" @@ -421,35 +236,11 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. + description: Description of the item that makes up the list of order items. x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - collectors: - type: object - description: Seller user who receives the payment. - x-description-i18n: - eng: Seller user who receives the payment. - spa: Usuario vendedor que recibe el pago. - por: Usuário vendedor que recebe o pagamento. - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier. - x-description-i18n: - eng: Collector identifier. - spa: Identificador del collector. - por: Identificador do collector. - amount: - type: string - example: "50.00" - description: Amount of the payment corresponding to the collector. - x-description-i18n: - eng: Amount of the payment corresponding to the collector. - spa: Monto de la transacción que corresponde al collector. - por: Valor da transação correspondente ao collector. + eng: Description of the item that makes up the list of order items. + spa: Descripción del artículo que componen el listado de items de la orden. + por: Descrição do item que compõe a lista de itens do pedido. payer: type: object description: Buyer's information. @@ -475,44 +266,28 @@ paths: por: Número de identificação do comprador previamente armazenado. identification: type: object - description: This field refers to the type and number of the document used to identify a person within the country. + description: Type and number of legal document that identifies the person in the country. x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. + eng: Type and number of legal document that identifies the person in the country. + spa: Tipo y número de documento legal que identifica a la persona en el país. + por: Tipo e número de documento que identifica a pessoa no país. properties: number: + type: string + example: "12345678098" description: Number of the document. x-description-i18n: eng: Number of the document. spa: Número del documento. por: Número do documento. - type: string - example: "12345678098" type: + type: string + example: "CPF" description: Type of the document. x-description-i18n: eng: Type of the document. spa: Tipo de documento. por: Tipo de documento. - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name. - x-description-i18n: - eng: Buyer's name. - spa: Nombre del comprador. - por: Nome do comprador. - surname: - type: string - example: "Doe" - description: Buyer's surname. - x-description-i18n: - eng: Buyer's surname. - spa: Apellido del comprador. - por: Sobrenome do comprador. address: type: object description: Address of the buyer. @@ -546,83 +321,49 @@ paths: spa: Código postal. por: Código postal. phone: + type: object description: Buyer's phone number. x-description-i18n: eng: Buyer's phone number. spa: Número de teléfono del comprador. por: Número de telefone do comprador. - type: object properties: area_code: - description: Buyer's area code. - x-description-i18n: - eng: Buyer's area code. - spa: Código de área del comprador. - por: Código de área do comprador. type: string example: "11" number: - description: Buyer's phone number number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. type: string example: "99999999" advanced: type: object - description: Options for advanced payment. + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced payment. + eng: Options for advanced transaction. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - marketplace: - type: object - description: In the event of a marketplace-type integration, this configuration is applicable to the collector. - x-description-i18n: - eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. - spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. - por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. - properties: - fee: - type: string - example: "5" - description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - x-description-i18n: - eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. - por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account responsible for paying the commissions. + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). x-description-i18n: - eng: ID of the Mercado Pago account responsible for paying the commissions. - spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. - por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona). + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono). amount_details: - description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - x-description-i18n: - eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. - por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object + description: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + x-description-i18n: + eng: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + spa: Este campo incluye detalles relativos a los importes de las transacciones, incluido el importe pagado y, en situaciones de reembolso, el importe total reembolsado. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. properties: total: type: string example: "123.00" - description: Details of the total value of the payment. + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the payment. + eng: Details of the total value of the transaction. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -640,56 +381,56 @@ paths: x-description-i18n: eng: Total value refunded. spa: Monto de la transacción devuelto. - por: Valor total reembolsado. - shipment: - type: string - example: "10.00" - description: Total value charged per shipment. - x-description-i18n: - eng: Total value charged per shipment. - spa: Monto cobrado por envío (incluido en el otal). - por: Valor cobrado por envio (incluído no total). + por: Valor reembolsado. payment_method: + type: object description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object properties: credit_cards: + type: array description: Credit cards. x-description-i18n: eng: Credit cards. spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array + por: Cartão de crédito. items: properties: + installments: + type: number + example: 1 + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + payment_id: + type: number + example: 12345432 + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. + description: Card token that represents securely the credit card data. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: Card token that represents securely the credit card data. + spa: Card token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. payment_method_id: type: string example: "visa" @@ -706,14 +447,6 @@ paths: eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 statement_descriptor: type: string example: "MERCADOPAGO" @@ -722,49 +455,25 @@ paths: eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. @@ -772,45 +481,69 @@ paths: por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. type: array + description: Debit card. + x-description-i18n: + eng: Debit card. + spa: Tarjeta de débito. + por: Cartão de débito. items: properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. + description: Card token that represents securely the credit card data. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: Card token that represents securely the credit card data. + spa: card_token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. payment_method_id: type: string example: "debvisa" @@ -822,62 +555,38 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + description: In case it is required, identifier of the card issuer entity. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + eng: In case it is required, identifier of the card issuer entity. + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta. + por: Caso seja requerido, identificador da entidade emissora do cartão. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. + description: Descriptor of the charge to be shown in the card statement. x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. + eng: descriptor of the charge to be shown in the card statement. + spa: Descriptor del cargo a utilizar en el resumen del emisor. + por: Descritor da cobrança a ser mostrada no extrato do cartão. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. @@ -885,308 +594,329 @@ paths: por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. + refunds: + type: object + description: List of refunds related to the payment method. x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. + tickets: + type: array + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. + items: + properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "pec" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. spa: Código del status del pago. - por: Código do status do Pagamento. + por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. + spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. atms: - description: ATM (Automated Teller Machine). + type: array + description: Automated Teller Machine. x-description-i18n: - eng: ATM (Automated Teller Machine). + eng: Automated Teller Machine. spa: Cajero automático. por: Caixa eletrônico. - type: array items: - type: object properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "bapropagos" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Estado del pago. + por: Estado do pagamento. + response_detail: + type: object + description: Payment status details. x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. + spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. bank_transfers: + type: array description: Bank transfers. x-description-i18n: eng: Bank transfers. spa: Transferencias bancarias. por: Transferências bancárias. - type: array items: - type: object properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "banco_mp" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. + spa: Estado del pago. + por: Estado do pagamento. completion_url: type: string + example: "" description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: eng: For offline payments, this is the URL that enables the continuation of the payment flow. spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Bad Request content: application/json: schema: @@ -1195,19 +925,9 @@ paths: errorKey: type: string enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. - "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + - Bad Request. + "401": + description: Unauthorized content: application/json: schema: @@ -1216,307 +936,153 @@ paths: errorKey: type: string enum: - - 500--Unexpected Error. - - 503--Service Unavailable. - patch: - tags: - - $ref: '#/tags/checkout-api' - summary: Modify Payment Intent - x-summary-i18n: - eng: Modify Payment Intent - spa: Modificar Payment Intent - por: Modificar Payment Intent - description: This endpoint allows for the modification of a Payment Intent created in Builder mode. By using the Payment Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It iss important to note that it is not necessary to send all fields filled, only those you want to modify or add - x-description-i18n: - eng: This endpoint allows for the modification of a Payment Intent created in Builder mode. By using the Payment Intent ID, it is possible to make edits through the PATCH endpoint. This enables the alteration or addition of fields in the intents body before its processing. It is important to note that it is not necessary to send all fields filled, only those you want to modify or add - spa: Este endpoint permite la modificación de una Payment Intent creada en el modo Builder. Utilizando el ID de la Payment Intent, es posible realizar ediciones a través del endpoint PATCH. Esto permite la modificación o adición de campos en el cuerpo de la intención antes de su procesamiento. Es importante tener en cuenta que no es necesario enviar todos los campos completos, solo aquellos que desea modificar o agregar - por: Este endpoint possibilita a modificação de uma Payment Intent criada no modo Builder. Utilizando o ID da Payment Intent, é possível realizar edições por meio do endpoint PATCH. Isso permite a alteração ou adição de campos no corpo da intenção antes de seu processamento. É importante observar que não é obrigatório enviar todos os campos preenchidos, apenas aqueles que você deseja modificar ou acrescentar - parameters: - - in: header - name: Authorization - schema: - type: string - example: "Bearer token-89987654567f-numeroToken" - required: true - description: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. - x-description-i18n: - eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. - spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. - por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - - in: header - name: X-Integrator-ID - schema: - type: string - required: false - description: Optinal ID for programmers or agencies who are part of the program. - x-description-i18n: - eng: Optinal ID for programmers or agencies who are part of the program. - spa: ID opcional para programadores o agencias que forman parte del programa . - por: ID opcional para programadores ou agências que fazem parte do programa . - - name: id - description: ID of a created Payment Intent. - x-description-i18n: - eng: ID of a created Payment Intent. - spa: ID de la Payment Intent creada. - por: ID da Payment Intent criada. - in: path - required: true - schema: - type: string - example: "00001njp2i" - requestBody: - description: Complete body of a Payment Intent. You can modify as needed. When updating, only send the fields you wish to change or add. - x-description-i18n: - eng: Complete body of a Payment Intent. You can modify as needed. When updating, only send the fields you wish to change or add. - spa: Body completo de una Payment Intent. Puedes modificarla según lo necesites. Al actualizar, envía solo los campos que desees cambiar o agregar. - por: Body completo de uma Payment Intent. Você pode modificar conforme necessário. Ao atualizar, envie apenas os campos que deseja alterar ou adicionar. - content: - application/json: + - Unauthorized. + "403": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Forbidden. + "404": + description: Not Found + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Not Found. + "408": + description: Request Timeout + content: + application/json: schema: type: object properties: - active_to_date: + errorKey: type: string - description: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - x-description-i18n: - eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the Payment Intent is expected to be processed and completed. For example - "2023-09-06T10:00:00.000-03:00". - spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T10:00:00.000-03:00". - por: Prazo máximo de processamento para a Payment Intent. Este prazo determina a data-limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo - "2023-09-06T10:00:00.000-03:00". - format: date-time - example: "2023-09-06T10:00:00.000-03:00" - configuration: - type: object - description: Predefined configuration parameters set by the seller before initiating the payment. - x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. - properties: - options: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - payment_methods: - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a payment method during the payment. - x-description-i18n: - eng: Coupons can be used as a payment method during the payment. - spa: Los cupones se pueden utilizar como método de pago durante la transacción. - por: Os cupons podem ser utilizados como forma de pagamento durante a transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: [ "credit_card", "debit_card" ] - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - type: array - example: [ "visa", "master" ] - items: - type: object - properties: - id: - type: string - description: Payment method identifier. For example, "credit_card". - x-description-i18n: - eng: Payment method identifier. For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a serem disponibilizadas. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a serem disponibilizadas. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: [ "ticket", "account_money" ] - default: - type: string - example: "credit_card" - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. - purpose: - type: string - description: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". - x-description-i18n: - eng: Identifier of the purpose of the payment, which allows load a predefined list of options. For example, "wallet_purchase" ou "onboarding_credits". - spa: Identificador del propósito de la transacción, que permite cargar un listado predefinido de opciones, cómo por ejemplo, "wallet_purchase" ou "onboarding_credits". - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas, como por exemplo, "wallet_purchase" ou "onboarding_credits". - example: [ "wallet_purchase", "onboarding_credits" ] - integration: - type: object - description: Configuration of the seller on integration. - x-description-i18n: - eng: Configuration of the seller on integration. - spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. - properties: - notifications: - description: Parameter concerning notification URL settings for conducted payments. - x-description-i18n: - eng: Parameter concerning notification URL settings for conducted payments. - spa: Parámetro relacionado con la configuración de URL de notificación para transacciones realizadas. - por: Parâmetro relacionado às configurações das URLs de notificação para transações efetuadas. - type: object - properties: - notification_url: - type: string - description: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - x-description-i18n: - eng: URL that provides the integrator with real-time information about the status of their payment through Webhooks and Instant Payment Notifications (IPN). - spa: URL que proporciona al integrador información en tiempo real sobre el status de su transacción a través de Webhooks y Notificaciones Instantáneas de Pago (IPN). - por: URL que oferece ao integrador informações atualizadas sobre o status de sua transação por meio de Webhooks e Notificações Instantâneas de Pagamento (IPN). - example: "https://www.integrator-site.com/api/notifications" - return_url: - type: object - description: Status URLs available to redirect buyer after completion of payment attempt. - x-description-i18n: - eng: Status URLs available to redirect buyer after completion of payment attempt. - spa: URLs a las cuales se podrá redireccionar al comprador luego de finalizar el intento de pago. - por: URLs disponíveis para redirecionar o comprador após a conclusão da tentativa de pagamento. - properties: - default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - failure: - description: URL to redirect the buyer in case of failed payment. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: URL to redirect the buyer in case of failed payment. - spa: URL a la cual se redireccionará al comprador en caso de fallo en el pago del comprador. - por: URL para redirecionar o comprador em caso de caso de falha no pagamento do comprador. - integrator_id: - type: number - example: 34567 - description: Seller's identifier in the integrator's system. - x-description-i18n: - eng: Seller's identifier in the integrator's system. - spa: Identificador del seller en el sistema del integrador. - por: Identificador do vendedor no sistema do integrador. + enum: + - Request Timeout. + "409": + description: Conflict + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Conflict. + "422": + description: Unprocessable Entity + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unprocessable Entity. + "500": + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Internal Server Error. + "503": + description: Service Unavailable + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Service Unavailable. + patch: + tags: + - $ref: '#/tags/checkout-api' + summary: Modify Payment Intent + x-summary-i18n: + eng: Modify Payment Intent + spa: Modificar Payment Intent + por: Modificar Payment Intent + description: This endpoint enables the modification of a Payment Intent. Such changes are only allowed for Payment Intents that have not yet been processed. After making the modifications, the Payment Intent will be available for processing + x-description-i18n: + eng: This endpoint enables the modification of a Payment Intent. Such changes are only allowed for Payment Intents that have not yet been processed. After making the modifications, the Payment Intent will be available for processing + spa: Este endpoint permite la modificación de una Payment Intent. Tales cambios sólo son permitidos para Payment Intents que aún no han sido procesadas. Después de realizar las modificaciones, la Payment Intent estará disponible para ser procesada + por: Este endpoint possibilita a modificação de uma Payment Intent. Essa alteração é permitida somente para Payment Intents que ainda não foram processadas. Após efetuar as modificações, a Payment Intent estará disponível para ser processada + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer ACCESS-TOKEN_or_CLIENT-TOKEN" + required: true + description: Access Token or Client Token - Access Token is the application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. + x-description-i18n: + eng: Access Token or Client Token - Access Token is the application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. + spa: Access Token o Client Token - Access Token es la clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. Client Token es el token generado a partir de la devolución de una intención de pago no procesada, estará disponible en la propiedad client_token, este token se puede usar para llamadas a partir de frontend. + por: Access Token ou Client Token - Access Token é a chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. Client Token é o token gerado a partir do retorno de uma payment intent não processada, estará disponibilizado na propriedade client_token, este token pode ser usado para chamadas de seu frontend. + - in: header + name: X-Auth-Method + schema: + type: string + example: "payment_intent" + required: false + description: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". + x-description-i18n: + eng: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". + spa: Este campo especifica el método de autenticación en uso. Cuando se utiliza el "client token" como medio de autorización, este header se vuelve obligatorio. Establezca su valor como "payment_intent". + por: Este campo especifica o método de autenticação em uso. Quando se utiliza o "client token" como meio de autorização, este header é obrigatório. Defina seu valor como "payment_intent". + - in: header + name: X-Idempotency-Key + schema: + type: string + example: "0d5020ed-1af6-469c-ae06-c3bec19954bb" + required: false + description: This feature allows you to safely retry requests without the risk of accidentally performing the same action more than once. This is useful for avoiding errors, such as creating two identical Payment Intents, for example. To ensure that each request is unique, it's important to use an exclusive value in the header of your request. We suggest using a UUID V4 or random strings. + x-description-i18n: + eng: This feature allows you to safely retry requests without the risk of accidentally performing the same action more than once. This is useful for avoiding errors, such as creating two identical Payment Intents, for example. To ensure that each request is unique, it's important to use an exclusive value in the header of your request. We suggest using a UUID V4 or random strings. + spa: Esta función permite repetir solicitudes de manera segura, sin el riesgo de realizar la misma acción más de una vez por error. Esto es útil para evitar errores, como la creación de dos Payment Intents idénticas, por ejemplo. Para garantizar que cada solicitud sea única, es importante utilizar un valor exclusivo en el header de su solicitud. Sugerimos el uso de un UUID V4 o strings aleatorias. + por: Esta função permite repetir solicitações de forma segura, sem o risco de realizar a mesma ação mais de uma vez por engano. Isso é útil para evitar erros, como a criação de duas Payment-Intents idênticas, por exemplo. Para garantir que cada solicitação seja única, é importante usar um valor exclusivo no header da sua solicitação. Sugerimos o uso de um UUID V4 ou strings randômicas. + - name: id + description: ID of a created Payment-Intent. + x-description-i18n: + eng: ID of a created Payment Intent. + spa: ID de la Payment-Intent creada. + por: ID da Payment-Intent criada. + in: path + required: true + schema: + type: string + example: "00321nj123" + requestBody: + description: Body for modifying a Payment-Intent. You can modify as needed. When updating, only send the fields you wish to change or add. + x-description-i18n: + eng: Body for modifying a Payment-Intent. You can modify as needed. When updating, only send the fields you wish to change or add. + spa: Body para modificar una Payment-Intent. Puedes modificarla según lo necesites. Al actualizar, envía solo los campos que deseas cambiar o agregar. + por: Body completo de uma Payment-Intent. Você pode modificar conforme necessário. Ao atualizar, envie apenas os campos que deseja alterar ou adicionar. + content: + application/json: + schema: + type: object + properties: order: description: Order containing all the essential information for the execution of a payment. x-description-i18n: @@ -1525,94 +1091,6 @@ paths: por: Ordem contendo todas as informações essenciais para a execução de uma transação. type: object properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. - external_reference: - type: string - example: "my_order_id" - description: Reference of the order. - x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - reason: - type: string - example: "my_order_description" - description: Reason for the order or payment. - x-description-i18n: - eng: Reason for the order or payment. - spa: Motivo de la orden o transacción. - por: Motivo da ordem ou transação. - amount: - required: true - type: string - example: "50.00" - description: Total amount to be paid. - x-description-i18n: - eng: Total amount to be paid. - spa: Monto total que se desea cobrar. - por: Valor total a ser pago. - items: - description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - x-description-i18n: - eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array - items: - type: object - description: List of items included in the order. - x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. - properties: - id: - type: string - example: "x76ax" - description: Item identification code. For example, "x76ax". - x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". - quantity: - type: number - example: 4 - description: Number of item included in the order. - x-description-i18n: - eng: Number of item included in the order. - spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. - unit_price: - type: string - example: "100.00" - description: Unit value of the item. For example, "100.00". - x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. - x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en la orden. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. payer: type: object description: Buyer's information. @@ -1622,45 +1100,13 @@ paths: por: Informações do comprador. properties: email: - required: true type: string - description: Buyer's email. - x-description-i18n: - eng: Buyer's email. - spa: Email del comprador. - por: Email do comprador. - customer_id: - type: number - example: 123456 - description: Previously stored buyer identification number. - x-description-i18n: - eng: Previously stored buyer identification number. - spa: Número de identificación del comprador previamente almacenado. - por: Número de identificação do comprador previamente armazenado. - identification: - type: object - description: This field refers to the type and number of the document used to identify a person within the country. + example: "testjohnupdate@test.com" + description: Buyer's email. It becomes mandatory when changing any payer information. x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. - properties: - number: - description: Number of the document. - x-description-i18n: - eng: Number of the document. - spa: Número del documento. - por: Número do documento. - type: string - example: "12345678098" - type: - description: Type of the document. - x-description-i18n: - eng: Type of the document. - spa: Tipo de documento. - por: Tipo de documento. - type: string - example: "CPF" + eng: Buyer's email. It becomes mandatory when changing any payer information. + spa: Email del comprador. Se vuelve obligatorio al cambiar cualquier información del pagador. + por: Email do comprador. Torna-se obrigatório ao alterar qualquer informação do pagador. name: type: string example: "John" @@ -1703,12 +1149,36 @@ paths: por: Número da casa. zip_code: type: string - example: "57000-865" + example: "00000-000" description: Zip code. x-description-i18n: eng: Zip code. spa: Código postal. por: Código postal. + identification: + type: object + description: This field refers to the type and number of the document used to identify a person within the country. + x-description-i18n: + eng: This field refers to the type and number of the document used to identify a person within the country. + spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. + por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. + properties: + number: + description: Number of the document. + x-description-i18n: + eng: Number of the document. + spa: Número del documento. + por: Número do documento. + type: string + example: "12345678098" + type: + description: Type of the document. + x-description-i18n: + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. + type: string + example: "CPF" phone: type: object description: Buyer's phone number. @@ -1733,578 +1203,195 @@ paths: spa: Número de teléfono del comprador. por: Número de telefone do comprador. example: "99999999" - advanced: + payment_method: type: object - description: Options for advanced payment. + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: - eng: Options for advanced payment. - spa: Agrupación de opciones avanzadas para la transacción. - por: Opções avançadas para a transação. + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. properties: - binary_mode: - type: boolean - example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. + credit_cards: + type: array + description: Credit cards. x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - marketplace: - type: object - description: In the event of a marketplace-type integration, this configuration is applicable to the collector. + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartão de crédito. + items: + properties: + installments: + type: number + example: 1 + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs123y3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. + x-description-i18n: + eng: Card token that represents securely the credit card data. + spa: Card token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + debit_cards: + type: array + description: Debit card. x-description-i18n: - eng: In the event of a marketplace-type integration, this configuration is applicable to the collector. - spa: En el caso de una integración tipo marketplace, esta configuración se aplica al colector. - por: No contexto de uma integração tipo marketplace, esta configuração é direcionada ao colletor. - properties: - fee: - type: string - example: "5" - description: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - x-description-i18n: - eng: Commission percentage corresponding to the amount assigned to the collector, which is owed to the Marketplace. - spa: Porcentaje de comisión correspondiente a la cantidad asignada al collector, que le corresponde al Marketplace. - por: Porcentagem de comissão correspondente ao montante atribuído ao collector, que é devida ao Marketplace. - sponsor_id: - type: number - example: 123456789 - description: ID of the Mercado Pago account responsible for paying the commissions. + eng: Debit card. + spa: Tarjeta de débito. + por: Cartão de débito. + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. + x-description-i18n: + eng: Card token that represents securely the credit card data. + spa: card_token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity. + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity. + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta. + por: Caso seja requerido, identificador da entidade emissora do cartão. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement. + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement. + spa: Descriptor del cargo a utilizar en el resumen del emisor. + por: Descritor da cobrança a ser mostrada no extrato do cartão. + tickets: + type: array + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "bolbradesco" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + atms: + type: array + description: Automated Teller Machine. x-description-i18n: - eng: ID of the Mercado Pago account responsible for paying the commissions. - spa: ID de la cuenta de Mercado Pago encargada de pagar las comisiones. - por: Identificação da conta do Mercado Pago responsável pelo pagamento das comissões. - payment_method: - description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + eng: Automated Teller Machine. + spa: Cajero automático. + por: Caixa eletrônico. + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + bank_transfers: + type: array + description: Bank transfers. x-description-i18n: - eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. - por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object - properties: - credit_cards: - description: Credit cards. - x-description-i18n: - eng: Credit cards. - spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. - x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do Pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - atms: - description: ATM (Automated Teller Machine). - x-description-i18n: - eng: ATM (Automated Teller Machine). - spa: Cajero automático. - por: Caixa eletrônico. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - bank_transfers: - description: Bank transfers. - x-description-i18n: - eng: Bank transfers. - spa: Transferencias bancarias. - por: Transferências bancárias. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. + items: + properties: + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "pix" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. responses: "200": description: success @@ -2315,7 +1402,7 @@ paths: properties: id: type: string - example: "00001njp2i" + example: "00321nj123" description: ID of a created Payment Intent. x-description-i18n: eng: ID of a created Payment Intent. @@ -2330,202 +1417,44 @@ paths: spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time + active_to_date: + type: string + description: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T08:00:00.000-03:00". + por: Prazo máximo de processamento para Payment Intent. Este prazo determina a data limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time + example: "2023-09-06T10:00:00.000-03:00" status: type: string - example: "authorized" + example: "new" description: Current status of the Payment Intent. x-description-i18n: eng: Current status of the Payment Intent. spa: Status actual de la Payment Intent. por: Status atual da Payment Intent. enum: - - new--nova - - payment_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelada - - authorized--autorizada - init_point: - type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - x-description-i18n: - eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". + - "new--it created but not processed" + - "transaction_in_process--it was processing, it is not conclusive. We can see the conclusive status in Webhook." + - "failed--processing failed, if there is any pending transaction it will be reverted." configuration: type: object - description: Predefined configuration parameters set by the seller before initiating the payment. + description: Configuration parameters defined by the seller before starting the transaction x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação properties: - option: + integration: type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. + description: Configuration of the seller on integration. x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do vendedor sobre a integração. properties: - purpose: - type: string - description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - x-description-i18n: - eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a methods of payment in the payment. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the payment. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: credit_card, debit_card - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: visa, master - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier For example, "credit_card". - x-description-i18n: - eng: Payment method identifier For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a oferecer. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a oferecer. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: ticket, account_money - default: - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. - type: string - example: "credit_card" - integration: - type: object - description: Configuration of the seller on integration. - x-description-i18n: - eng: Configuration of the seller on integration. - spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. - properties: - notification_url: + notification_url: type: string description: URL to which notifications will be sent. example: "https://www.integrator-site.com/notifications" @@ -2558,13 +1487,13 @@ paths: spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. por: URL para redirecionar o comprador em caso de pagamento pendente. return_url_failure: - description: Redirection URL for the event of buyer payment failure. + description: URL to redirect the buyer in case of failed payment. type: string example: "https://www.integrator-site.com/order/failed" x-description-i18n: - eng: Redirection URL for the event of buyer payment failure. - spa: URL de redirección para el caso de fallo en el pago del comprador. - por: URL de redirecionamento para o caso de falha no pagamento do comprador. + eng: URL to redirect the buyer in case of failed payment. + spa: URL a la cual se redireccionará al comprador en caso de pago fallido. + por: URL para redirecionar o comprador em caso de pagamento falhou. order: type: object description: Common Order attributes for request and response. @@ -2573,61 +1502,47 @@ paths: spa: Atributos de Order comunes para el request y el response. por: Atributos de Order comuns para o request e o response. properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. external_reference: type: string example: "my_order_id" description: Reference of the order x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador description: type: string example: "my_order_description" - description: Description for the order or payment. + description: Description of the order or payment. x-description-i18n: - eng: Description for the order or payment. - spa: Descripción de la orden o transacción. + eng: Description of the order or payment. + spa: Descricion de la orden o transacción. por: Descrição da ordem ou transação. amount: - example: "233.00" type: string - description: Total value of the payment. For example, "233.00". + example: "233.00" + description: Total value of the transaction x-description-i18n: - eng: Total value of the payment. For example, "233.00". - spa: Monto total de la transacción. Por ejemplo, "233.00".. - por: Valor total da transação. Por exemplo, "233.00". + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação items: + type: array description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. x-description-i18n: eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. items: - type: object - description: List of items included in the order. - x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. properties: id: type: string example: "x76ax" - description: Item identification code. For example, "x76ax". + description: Item identification code. x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". + eng: Item identification code. + spa: Código de identificación del ítem. + por: Código de identificação do item. quantity: type: number example: 4 @@ -2635,15 +1550,15 @@ paths: x-description-i18n: eng: Number of item included in the order. spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. + por: Quantidade de itens incluídos no pedido. unit_price: type: string example: "100.00" - description: Unit value of the item. For example, "100.00". + description: Unit price of the item. x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". + eng: Unit value of the item. + spa: Precio unitario del ítem. + por: Preço unitário do item. dimensions: type: string example: "30x30x30" @@ -2655,35 +1570,11 @@ paths: description: type: string example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. + description: Description of the item that makes up the list of order items. x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - collectors: - type: object - description: Seller user who receives the payment. - x-description-i18n: - eng: Seller user who receives the payment. - spa: Usuario vendedor que recibe el pago. - por: Usuário vendedor que recebe o pagamento. - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier. - x-description-i18n: - eng: Collector identifier. - spa: Identificador del collector. - por: Identificador do collector. - amount: - type: string - example: "50.00" - description: Amount of the payment corresponding to the collector. - x-description-i18n: - eng: Amount of the payment corresponding to the collector. - spa: Monto de la transacción que corresponde al collector. - por: Valor da transação correspondente ao collector. + eng: Description of the item that makes up the list of order items. + spa: Descripción del artículo que componen el listado de items de la orden. + por: Descrição do item que compõe a lista de itens do pedido. payer: type: object description: Buyer's information. @@ -2709,44 +1600,28 @@ paths: por: Número de identificação do comprador previamente armazenado. identification: type: object - description: This field refers to the type and number of the document used to identify a person within the country. + description: Type and number of legal document that identifies the person in the country. x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. + eng: Type and number of legal document that identifies the person in the country. + spa: Tipo y número de documento legal que identifica a la persona en el país. + por: Tipo e número de documento que identifica a pessoa no país. properties: number: + type: string + example: "12345678098" description: Number of the document. x-description-i18n: eng: Number of the document. spa: Número del documento. por: Número do documento. - type: string - example: "12345678098" type: + type: string + example: "CPF" description: Type of the document. x-description-i18n: eng: Type of the document. spa: Tipo de documento. por: Tipo de documento. - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name. - x-description-i18n: - eng: Buyer's name. - spa: Nombre del comprador. - por: Nome do comprador. - surname: - type: string - example: "Doe" - description: Buyer's surname. - x-description-i18n: - eng: Buyer's surname. - spa: Apellido del comprador. - por: Sobrenome do comprador. address: type: object description: Address of the buyer. @@ -2776,7 +1651,7 @@ paths: example: "57000-865" description: Zip code. x-description-i18n: - eng: Zip code + eng: Zip code. spa: Código postal. por: Código postal. phone: @@ -2788,59 +1663,51 @@ paths: por: Número de telefone do comprador. properties: area_code: + type: string description: Buyer's area code. - x-description-i18n: + x-description-i18n: eng: Buyer's area code. spa: Código de área del comprador. - por: Código de área do comprador. - type: string + por: Código de área do comprador. example: "11" number: + type: string description: Buyer's phone number number. x-description-i18n: - eng: Buyer's phone number. + eng: Buyer's phone number number. spa: Número de teléfono del comprador. por: Número de telefone do comprador. - type: string example: "99999999" advanced: type: object - description: Options for advanced payment. + description: Options for advanced transaction. x-description-i18n: - eng: Options for advanced payment. + eng: Options for advanced transaction. spa: Agrupación de opciones avanzadas para la transacción. por: Opções avançadas para a transação. properties: binary_mode: type: boolean example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - sponsor_id: - type: number - example: 123456789 - description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. - x-description-i18n: - eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. - spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. - por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona). + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono). amount_details: - description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - x-description-i18n: - eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. - por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. type: object + description: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + x-description-i18n: + eng: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + spa: Este campo incluye detalles relativos a los importes de las transacciones, incluido el importe pagado y, en situaciones de reembolso, el importe total reembolsado. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. properties: total: type: string example: "123.00" - description: Details of the total value of the payment. + description: Details of the total value of the transaction. x-description-i18n: - eng: Details of the total value of the payment. + eng: Details of the total value of the transaction. spa: Detalles del monto total de la transacción. por: Detalhes do valor total da transação. paid: @@ -2858,56 +1725,56 @@ paths: x-description-i18n: eng: Total value refunded. spa: Monto de la transacción devuelto. - por: Valor total reembolsado. - shipment: - type: string - example: "10.00" - description: Total value charged per shipment. - x-description-i18n: - eng: Total value charged per shipment. - spa: Monto cobrado por envío (incluido en el otal). - por: Valor cobrado por envio (incluído no total). + por: Valor reembolsado. payment_method: + type: object description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. x-description-i18n: eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object properties: credit_cards: + type: array description: Credit cards. x-description-i18n: eng: Credit cards. spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array + por: Cartão de crédito. items: properties: + installments: + type: number + example: 1 + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + payment_id: + type: number + example: 12345432 + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. + description: Card token that represents securely the credit card data. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: Card token that represents securely the credit card data. + spa: Card token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. payment_method_id: type: string example: "visa" @@ -2924,14 +1791,6 @@ paths: eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 statement_descriptor: type: string example: "MERCADOPAGO" @@ -2939,50 +1798,26 @@ paths: x-description-i18n: eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. @@ -2990,45 +1825,69 @@ paths: por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. type: array + description: Debit card. + x-description-i18n: + eng: Debit card. + spa: Tarjeta de débito. + por: Cartão de débito. items: properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. token: type: string example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. + description: Card token that represents securely the credit card data. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: Card token that represents securely the credit card data. + spa: card_token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. payment_method_id: type: string example: "debvisa" @@ -3040,62 +1899,38 @@ paths: issuer: type: string example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + description: In case it is required, identifier of the card issuer entity. x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + eng: In case it is required, identifier of the card issuer entity. + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta. + por: Caso seja requerido, identificador da entidade emissora do cartão. statement_descriptor: type: string example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. + description: Descriptor of the charge to be shown in the card statement. x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. + eng: descriptor of the charge to be shown in the card statement. + spa: Descriptor del cargo a utilizar en el resumen del emisor. + por: Descritor da cobrança a ser mostrada no extrato do cartão. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. @@ -3103,308 +1938,395 @@ paths: por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. tickets: + type: array description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. x-description-i18n: eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array items: properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "pec" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: + spa: Estado del pago. + por: Estado do pagamento. + response_detail: type: object - description: Detail information about the status of the payment. + description: Payment status details. x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. properties: code: type: string - example: "400" + example: "" description: Payment status code. x-description-i18n: eng: Payment status code. spa: Código del status del pago. - por: Código do status do Pagamento. + por: Código do status do pagamento. message: type: string - example: "acquirer rejected" + example: "" description: Payment status message. x-description-i18n: eng: Payment status message. spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. + spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. atms: - description: ATM (Automated Teller Machine). + type: array + description: Automated Teller Machine. x-description-i18n: - eng: ATM (Automated Teller Machine). + eng: Automated Teller Machine. spa: Cajero automático. por: Caixa eletrônico. - type: array items: - type: object properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "bapropagos" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Estado del pago. + por: Estado do pagamento. + response_detail: + type: object + description: Payment status details. x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. + spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. bank_transfers: + type: array description: Bank transfers. x-description-i18n: eng: Bank transfers. spa: Transferencias bancarias. por: Transferências bancárias. - type: array items: - type: object properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. amount: type: string example: "50.00" description: Total amount to be paid with this payment method. x-description-i18n: eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. + spa: Monto a pagar con este medio. por: Valor total a ser pago com este meio de pagamento. payment_method_id: type: string - example: "banco_mp" + example: "debvisa" description: Identifier of the chosen payment method. x-description-i18n: eng: Identifier of the chosen payment method. spa: Identificador del medio de pago elegido. por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. status: type: string example: "pending" description: Status of the payment. x-description-i18n: eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. + spa: Estado del pago. + por: Estado do pagamento. completion_url: type: string + example: "" description: For offline payments, this is the URL that enables the continuation of the payment flow. x-description-i18n: eng: For offline payments, this is the URL that enables the continuation of the payment flow. spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. refunds: + type: object description: List of refunds related to the payment method. x-description-i18n: eng: List of refunds related to the payment method. spa: Listado de devoluciones relacionadas al medio de pago. por: Lista de reembolsos relacionados ao meio de pagamento. - type: object properties: refund_id: type: number example: 123456789 - description: Refund identifier. + description: ID of the refund. x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. refund_amount: type: string example: "50.00" description: Amount of the refund. x-description-i18n: eng: Amount of the refund. - spa: Monto del reembolso. + spa: Monto de la devolución. por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Bad Request + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Bad Request. + "401": + description: Unauthorized + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unauthorized. + "403": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Forbidden. + "404": + description: Not Found + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Not Found. + "408": + description: Request Timeout + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Request Timeout. + "409": + description: Conflict + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Conflict. + "422": + description: Unprocessable Entity content: application/json: schema: @@ -3413,19 +2335,20 @@ paths: errorKey: type: string enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. + - Unprocessable Entity. "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Internal Server Error. + "503": + description: Service Unavailable content: application/json: schema: @@ -3434,22 +2357,21 @@ paths: errorKey: type: string enum: - - 500--Unexpected Error. - - 503--Service Unavailable. + - Service Unavailable. /v1/payment-intents/{id}/cancel: put: tags: - $ref: '#/tags/checkout-api' - summary: Cancel Payment-Intent + summary: Cancel Payment Intent x-summary-i18n: - eng: Cancel Payment-Intent - spa: Cancelar Payment-Intent - por: Cancelar Payment-Intent - description: This endpoint allows for the cancellation of a Payment-Intent solely during the authorization phase. A 204 response code confirms the successful cancellation, and as a result, the response body will be empty. + eng: Cancel Payment Intent + spa: Cancelar Payment Intent + por: Cancelar Payment Intent + description: This endpoint allows for the cancellation of a Payment Intent solely during the authorization phase. A 204 response code confirms the successful cancellation, and as a result, the response body will be empty. x-description-i18n: - eng: This endpoint allows for the cancellation of a Payment-Intent solely during the authorization phase. A 204 response code confirms the successful cancellation, and as a result, the response body will be empty. + eng: This endpoint allows for the cancellation of a Payment Intent solely during the authorization phase. A 204 response code confirms the successful cancellation, and as a result, the response body will be empty. spa: Este endpoint permite cancelar una Payment-Intent únicamente en la fase de autorización. Un código de respuesta 204 confirma que el cancelamiento se ha realizado con éxito, y, por lo tanto, el cuerpo de la respuesta estará vacío. - por: Este endpoint possibilita o cancelamento de uma Payment-Intent apenas no fluxo de autorização. Um retorno de resposta 204 confirma o cancelamento bem-sucedido, e, consequentemente, o corpo da resposta estará vazio. + por: Este endpoint possibilita o cancelamento de uma Payment Intent apenas no fluxo de autorização. Um retorno de resposta 204 confirma o cancelamento bem-sucedido, e, consequentemente, o corpo da resposta estará vazio. parameters: - in: header name: Authorization @@ -3466,21 +2388,18 @@ paths: name: id schema: type: string - required: true + required: true description: Alphanumeric identification of the authorized Payment-Intent ID. For example 876542356788-mp. x-description-i18n: eng: Alphanumeric identification of the authorized Payment-Intent ID. For example 876542356788-mp. spa: Identificación alfanumérica del ID de Payment-Intent autorizado. Por ejemplo 876542356788-mp. por: Identificação alfanumérica do ID do Payment-Intent autorizado, como por exemplo, 876542356788-mp. + example: 876542356788-mp responses: "204": description: Payment-Intent cancelled "400": description: Bad Request - x-description-i18n: - eng: Bad Request - spa: Bad Request - por: Bad Request content: application/json: schema: @@ -3491,7 +2410,7 @@ paths: enum: - Bad Request. "401": - description: Forbidden + description: Unauthorized content: application/json: schema: @@ -3500,7 +2419,7 @@ paths: errorKey: type: string enum: - - Forbidden. + - Unauthorized. "403": description: Forbidden content: @@ -3557,7 +2476,7 @@ paths: enum: - Unprocessable Entity. "500": - description: Unexpected Error + description: Internal Server Error content: application/json: schema: @@ -3566,7 +2485,7 @@ paths: errorKey: type: string enum: - - Unexpected Error. + - Internal Server Error. "503": description: Service Unavailable content: @@ -3587,11 +2506,11 @@ paths: eng: Refund Payment Intent spa: Reembolsar Payment Intent por: Reembolsar Payment Intent - description: If a Payment Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure + description: This endpoint allows you to initiate a refund process for already processed Payment Intents. Receiving a 204 response code indicates that the refund has been successfully executed. In this case, the response body will be empty as confirmation of the successful procedure x-description-i18n: - eng: If a Payment Intent is successfully processed and the client chooses to cancel, this endpoint allows for the initiation of a refund procedure - spa: Si una Payment Intent se procesa con éxito y el cliente decide cancelar, este endpoint permite iniciar un procedimiento de reembolso - por: Se uma Payment Intent for processada com sucesso e o cliente optar pelo cancelamento, este endpoint oferece a capacidade de iniciar um procedimento de reembolso + eng: This endpoint allows you to initiate a refund process for already processed Payment Intents. Receiving a 204 response code indicates that the refund has been successfully executed. In this case, the response body will be empty as confirmation of the successful procedure + spa: Este endpoint permite iniciar un proceso de reembolso para Payment Intents ya procesadas. Recibir un código de respuesta 204 indica que el reembolso se ha realizado con éxito. En este caso, el cuerpo de la respuesta estará vacío como confirmación del procedimiento exitoso + por: Este endpoint permite iniciar um processo de reembolso para Payment Intents já processadas. Receber um código de resposta 204 significa que o reembolso foi realizado com sucesso. Nesse caso, o corpo da resposta estará vazio como confirmação do procedimento bem-sucedido parameters: - in: header name: Authorization @@ -3604,1127 +2523,88 @@ paths: eng: Access Token - Application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. spa: Access Token - Clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. por: Access Token - Chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. - - in: header - name: X-Integrator-ID - schema: - type: string - required: false - description: Optinal ID for programmers or agencies who are part of the program. - x-description-i18n: - eng: Optinal ID for programmers or agencies who are part of the program. - spa: ID opcional para programadores o agencias que forman parte del programa . - por: ID opcional para programadores ou agências que fazem parte do programa . - in: path name: id schema: type: string required: true required: true - description: Alphanumeric ID of the Payment Intent to get. + description: Alphanumeric identification of the Payment-Intent ID processed. For example 876542356788-mp. x-description-i18n: - eng: Alphanumeric ID of the Payment Intent to get. - spa: ID alfanumérico de la Payment Intent a obtener. - por: ID alfanumérico da Payment Intent a ser obtida. + eng: Alphanumeric identification of the Payment-Intention ID processed. For example 876542356788-mp. + spa: Identificación alfanumérica del ID de una Payment-Intent procesado. Por ejemplo 876542356788-mp. + por: Identificação alfanumérica do ID de um Payment-Intent procesada. Por exemplo 876542356788-mp. responses: - "200": - description: success + "204": + description: Payment-Intent reverted + "400": + description: Bad Request content: application/json: schema: type: object properties: - id: + errorKey: type: string - example: "00001njp2i" - description: ID of a created Payment Intent. - x-description-i18n: - eng: ID of a created Payment Intent. - spa: ID de la Payment Intent creada. - por: ID da Payment Intent criada. - created_date: + enum: + - Bad Request. + "401": + description: Unauthorized + content: + application/json: + schema: + type: object + properties: + errorKey: type: string - example: "2023-09-06T08:00:00.000-03:00" - description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - x-description-i18n: - eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". - spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". - por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". - format: date-time - status: + enum: + - Unauthorized. + "403": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: type: string - example: "reverted" - description: Current status of the Payment Intent. - x-description-i18n: - eng: Current status of the Payment Intent. - spa: Status actual de la Payment Intent. - por: Status atual da Payment Intent. enum: - - new--nova - - payment_in_process--transação em processo - - partially_processed--parcialmente processada - - processed--processada - - partially_reverted--revertida parcialmente - - reverted--revertida - - failed--falhou - - cancelled--cancelada - - authorized--autorizada - init_point: + - Forbidden. + "404": + description: Not Found + content: + application/json: + schema: + type: object + properties: + errorKey: type: string - example: "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789" - description: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - x-description-i18n: - eng: URL that allows you to start the payment flow. For example, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - spa: URL que permite iniciar el flujo de pago. Por ejemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - por: URL que permite iniciar o fluxo de pagamento. Por exemplo, "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123456789". - configuration: - type: object - description: Predefined configuration parameters set by the seller before initiating the payment. - x-description-i18n: - eng: Predefined configuration parameters set by the seller before initiating the payment. - spa: Parámetros de configuración predefinidos por el seller antes de iniciar la transacción. - por: Parâmetros de configuração pré-definidos pelo seller antes de iniciar a transação. - properties: - option: - type: object - description: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - x-description-i18n: - eng: Seller-defined settings to determine the choices offered during the payment. This field refers to the configurations the seller establishes to provide diverse options to buyers throughout the payment process. This can encompass selections such as accepted payment methods, installment plans, shipping options, discounts, and other customizations that impact how the payment is conducted. - spa: Ajustes establecidos por el seller para determinar las opciones ofrecidas durante la transacción. Este campo se refiere a las configuraciones que el seller establece para proporcionar diferentes opciones a los compradores durante el proceso de transacción. Esto puede incluir elecciones como métodos de pago aceptados, cuotas, opciones de envío, descuentos y otras personalizaciones que afectan la forma en que se lleva a cabo la transacción. - por: Ajustes estabelecidos pelo seller para determinar as escolhas oferecidas durante a transação. Este campo e refere às configurações que o seller configura para fornecer diferentes opções aos compradores durante o processo de transação. Isso pode incluir escolhas como meios de pagamento aceitos, parcelamento, opções de envio, descontos e outras personalizações que afetam a forma como a transação é conduzida. - properties: - purpose: - type: string - description: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - x-description-i18n: - eng: Payment purpose identifier that enables loading a list of predefined options. For example, wallet_purchase, onboarding_credits. - spa: Identificador de propósito de transacción que permite cargar una lista de opciones predefinidas. Por ejemplo, wallet_purchase, onboarding_credits. - por: Identificador da finalidade da transação, que permite carregar uma lista de opções predefinidas. Por exemplo, wallet_purchase, onboarding_credits. - example: wallet_purchase, onboarding_credits - payment_methods: - type: object - description: Information related to the payment methods defined for the payment. - x-description-i18n: - eng: Information related to the payment methods defined for the payment. - spa: Información relacionada con los medios de pago definidos para la transacción. - por: Informações relacionadas aos meios de pagamento definidos para a transação. - properties: - coupons: - description: Coupons can be used as a methods of payment in the payment. - x-description-i18n: - eng: Coupons can be used as a methods of payment in the payment. - spa: Los cupones pueden ser utilizados como medio de pago en la transacción. - por: Os cupons podem ser utilizados como meio de pagamento na transação. - type: object - properties: - campaign_id: - type: number - example: 123456 - description: Identifier number of the campaign to which the coupon is linked. - x-description-i18n: - eng: Identifier number of the campaign to which the coupon is linked. - spa: Número identificador de la campaña a la cual el cupón está vinculado. - por: Número de identificação da campanha à qual o cupom está associado. - amount: - type: string - example: "100.00" - description: Total value of coupon. For example, "100.00". - x-description-i18n: - eng: Total value of coupon. For example, "100.00". - spa: Valor total del cupón. Por ejemplo, "100.00". - por: Valor total do cupom. Por exemplo, "100.00". - types: - type: object - description: Configuration by payment method type. - x-description-i18n: - eng: Configuration by payment method type. - spa: Configuración por tipo de medio de pago. - por: Configuração por tipo de meio de pagamento. - properties: - enabled: - description: List of Payment Types included. For example, credit_card, debit_card. - x-description-i18n: - eng: List of Payment Types included. For example, credit_card, debit_card. - spa: Lista de tipos de medios de pago incluidos. Por ejemplo, credit_card, debit_card. - por: Lista de tipos de meios de pagamento incluídos. Por exemplo, credit_card, debit_card. - type: array - items: - type: string - example: credit_card, debit_card - disabled: - description: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - x-description-i18n: - eng: Types of payment methods not covered. This parameter encompasses payments that will not be accepted in the payment, such as "credit card". - spa: Tipos de medios de pago no incluidos. Este parámetro abarca los pagos que no serán aceptados en la transacción, como por ejemplo, "credit card". - por: Tipos de meios de pagamento não abrangidos. Este parâmetro engloba os pagamentos que não serão aceitos na transação, como por exemplo, "credit card". - type: array - items: - type: string - example: "credit_card" - methods: - type: object - description: Configuration by specific payment method. - x-description-i18n: - eng: Configuration by specific payment method. - spa: Configuración por tipo específico de medio de pago. - por: Configuração por tipo específico de meio de pagamento. - properties: - enabled: - type: array - example: visa, master - description: Payment methods included. - x-description-i18n: - eng: Payment methods included. - spa: Medios de pago incluidos. - por: Meios de pagamento incluídos. - items: - type: object - properties: - id: - type: string - description: Payment method identifier For example, "credit_card". - x-description-i18n: - eng: Payment method identifier For example, "credit_card". - spa: Identificador del medio de pago. Por ejemplo, "credit_card". - por: Identificador do meio de pagamento. Por exemplo, "credit_card". - example: "credit_card" - installments: - type: object - description: Configuration of the installment quantity to be offered for each payment method. - x-description-i18n: - eng: Configuration of the installment quantity to be offered for each payment method. - spa: Configuración de la cantidad de cuotas a ofrecer para cada medio de pago. - por: Configuração da quantidade de parcelas a serem disponibilizadas para cada meio de pagamento. - properties: - default: - description: Number of installments to be offered by default. - x-description-i18n: - eng: Number of installments to be offered by default. - spa: Número de cuotas a ofrecer de forma predeterminada. - por: Número de parcelas a serem disponibilizadas por padrão. - type: string - example: "3" - max: - description: Maximum number of installments to offer. - x-description-i18n: - eng: Maximum number of installments to offer. - spa: Cantidad máxima de cuotas a ofrecer. - por: Quantidade máxima de parcelas a oferecer. - type: string - example: "6" - min: - description: Minimum number of installments to offer. - x-description-i18n: - eng: Minimum number of installments to offer. - spa: Cantidad mínima de cuotas a ofrecer. - por: Quantidade mínima de parcelas a oferecer. - type: string - example: "1" - disabled: - description: Payment methods not included. - x-description-i18n: - eng: Payment methods not included. - spa: Medios de pago no incluidos. - por: Meios de pagamento não incluídos. - type: array - items: - type: string - example: ticket, account_money - default: - type: string - example: "credit_card" - description: Types of payment methods to be offered by default. - x-description-i18n: - eng: Types of payment methods to be offered by default. - spa: Tipos de medios de pago que se ofrecerán de manera predeterminada. - por: Tipos de meios de pagamento a serem disponibilizados por padrão. - integration: - type: object - description: Configuration of the seller on integration. - x-description-i18n: - eng: Configuration of the seller on integration. - spa: Configuración del seller sobre la integración. - por: Configuração do seller sobre a integração. - properties: - notification_url: - type: string - description: URL to which notifications will be sent. - example: "https://www.integrator-site.com/notifications" - x-description-i18n: - eng: URL to which notifications will be sent. - spa: URL a la cual se enviarán las notificaciones. - por: URL para a qual as notificações serão enviadas. - return_url_default: - description: Default URL to redirect the buyer. - x-description-i18n: - eng: Default URL to redirect the buyer. - spa: URL por defecto a la cual se redireccionará al comprador. - por: URL padrão para redirecionar o comprador. - type: string - example: "https://www.integrator-site.com/order" - return_url_success: - description: URL to redirect the buyer in case of successful payment. - type: string - example: "https://www.integrator-site.com/order/success" - x-description-i18n: - eng: URL to redirect the buyer in case of successful payment. - spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. - por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. - return_url_pending: - description: URL to redirect the buyer in case of pending payment. - type: string - example: "https://www.integrator-site.com/order/pending" - x-description-i18n: - eng: URL to redirect the buyer in case of pending payment. - spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. - por: URL para redirecionar o comprador em caso de pagamento pendente. - return_url_failure: - description: Redirection URL for the event of buyer payment failure. - type: string - example: "https://www.integrator-site.com/order/failed" - x-description-i18n: - eng: Redirection URL for the event of buyer payment failure. - spa: URL de redirección para el caso de fallo en el pago del comprador. - por: URL de redirecionamento para o caso de falha no pagamento do comprador. - order: - type: object - description: Common Order attributes for request and response. - x-description-i18n: - eng: Common Order attributes for request and response. - spa: Atributos de Order comunes para el request y el response. - por: Atributos de Order comuns para o request e o response. - properties: - id: - type: number - example: 123456789 - description: ID of the order previously created in the integrator's system. - x-description-i18n: - eng: ID of the order previously created in the integrator's system. - spa: ID de orden previamente creada en el sistema del integrador. - por: ID da ordem criada anteriormente no sistema do integrador. - external_reference: - type: string - example: "my_order_id" - description: Reference of the order - x-description-i18n: - eng: Reference of the order. - spa: Referencia de lá orden. - por: Referência da ordem. - description: - type: string - example: "my_order_description" - description: Description for the order or payment. - x-description-i18n: - eng: Description for the order or payment. - spa: Descripción de la orden o transacción. - por: Descrição da ordem ou transação. - amount: - example: "233.00" - type: string - description: Total value of the payment. For example, "233.00". - x-description-i18n: - eng: Total value of the payment. For example, "233.00". - spa: Monto total de la transacción. Por ejemplo, "233.00".. - por: Valor total da transação. Por exemplo, "233.00". - items: - description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - x-description-i18n: - eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. - spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. - por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. - type: array - items: - type: object - description: List of items included in the order. - x-description-i18n: - eng: List of items included in the order. - spa: Listado de ítems incluidos en la órden. - por: Lista de itens incluídos na ordem. - properties: - id: - type: string - example: "x76ax" - description: Item identification code. For example, "x76ax". - x-description-i18n: - eng: Item identification code. For example, "x76ax". - spa: Código de identificación del ítem. Por ejemplo, "x76ax". - por: Código de identificação do item. Por exemplo, "x76ax". - quantity: - type: number - example: 4 - description: Number of item included in the order. - x-description-i18n: - eng: Number of item included in the order. - spa: Cantidad de ocurrencias del ítem incluidos en la órden. - por: Quantidade de itens incluídos na ordem. - unit_price: - type: string - example: "100.00" - description: Unit value of the item. For example, "100.00". - x-description-i18n: - eng: Unit value of the item. For example, "100.00". - spa: Precio unitario del ítem. Por ejemplo, "100.00". - por: Preço unitário do item. Por exemplo, "100.00". - dimensions: - type: string - example: "30x30x30" - description: Dimensions of the item - length x width x height. - x-description-i18n: - eng: Dimensions of the item - length x width x height. - spa: Dimensiones del ítem - largo x ancho x alto. - por: Dimensões do item - comprimento x largura x altura. - description: - type: string - example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " - description: Description of the items comprising the list of products included in the order. - x-description-i18n: - eng: Description of the items comprising the list of products included in the order. - spa: Descripción de los artículos que componen la lista de productos incluidos en el pedido. - por: Descrição dos itens que constituem a lista de produtos incluídos na ordem. - collectors: - type: object - description: Seller user who receives the payment. - x-description-i18n: - eng: Seller user who receives the payment. - spa: Usuario vendedor que recibe el pago. - por: Usuário vendedor que recebe o pagamento. - properties: - collector_id: - type: number - example: 123456789 - description: Collector identifier. - x-description-i18n: - eng: Collector identifier. - spa: Identificador del collector. - por: Identificador do collector. - amount: - type: string - example: "50.00" - description: Amount of the payment corresponding to the collector. - x-description-i18n: - eng: Amount of the payment corresponding to the collector. - spa: Monto de la transacción que corresponde al collector. - por: Valor da transação correspondente ao collector. - payer: - type: object - description: Buyer's information. - x-description-i18n: - eng: Buyer's information. - spa: Información del comprador. - por: Informações do comprador. - properties: - email: - type: string - description: Buyer's email. - x-description-i18n: - eng: Buyer's email. - spa: Email del comprador. - por: Email do comprador. - customer_id: - type: number - example: 123456 - description: Previously stored buyer identification number. - x-description-i18n: - eng: Previously stored buyer identification number. - spa: Número de identificación del comprador previamente almacenado. - por: Número de identificação do comprador previamente armazenado. - identification: - type: object - description: This field refers to the type and number of the document used to identify a person within the country. - x-description-i18n: - eng: This field refers to the type and number of the document used to identify a person within the country. - spa: Este campo se refiere al tipo y número del documento utilizado para identificar a una persona dentro del país. - por: Este campo se refere ao tipo e número do documento usado para identificar uma pessoa dentro do país. - properties: - number: - description: Number of the document. - x-description-i18n: - eng: Number of the document. - spa: Número del documento. - por: Número do documento. - type: string - example: "12345678098" - type: - description: Type of the document. - x-description-i18n: - eng: Type of the document. - spa: Tipo de documento. - por: Tipo de documento. - type: string - example: "CPF" - name: - type: string - example: "John" - description: Buyer's name. - x-description-i18n: - eng: Buyer's name. - spa: Nombre del comprador. - por: Nome do comprador. - surname: - type: string - example: "Doe" - description: Buyer's surname. - x-description-i18n: - eng: Buyer's surname. - spa: Apellido del comprador. - por: Sobrenome do comprador. - address: - type: object - description: Address of the buyer. - x-description-i18n: - eng: Address of the buyer. - spa: Dirección del comprador. - por: Endereço do comprador. - properties: - street_name: - type: string - example: "Street MercadoLivre" - description: Street name. - x-description-i18n: - eng: Street name. - spa: Nombre de la calle. - por: Nome da rua. - street_number: - type: string - example: "100" - description: Street number. - x-description-i18n: - eng: Street number. - spa: Número de la calle. - por: Número da casa. - zip_code: - type: string - example: "57000-865" - description: Zip code. - x-description-i18n: - eng: Zip code. - spa: Código postal. - por: Código postal. - phone: - type: object - description: Buyer's phone number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - properties: - area_code: - description: Buyer's area code. - x-description-i18n: - eng: Buyer's area code. - spa: Código de área del comprador. - por: Código de área do comprador. - type: string - example: "11" - number: - description: Buyer's phone number number. - x-description-i18n: - eng: Buyer's phone number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. - type: string - example: "99999999" - advanced: - type: object - description: Options for advanced payment. - x-description-i18n: - eng: Options for advanced payment. - spa: Agrupación de opciones avanzadas para la transacción. - por: Opções avançadas para a transação. - properties: - binary_mode: - type: boolean - example: true - description: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - x-description-i18n: - eng: Enables requesting a final payment response during the initial processing, disabling any options for offline or asynchronous processing. - spa: Permite solicitar una respuesta definitiva de la transacción durante el procesamiento inicial, deshabilitando cualquier opción de procesamiento fuera de línea o asíncrono. - por: Possibilita requerer uma resposta definitiva da transação no primeiro processamento, desabilitando quaisquer opções de processamento offline ou assíncrono. - sponsor_id: - type: number - example: 123456789 - description: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. - x-description-i18n: - eng: Identifier of the account in Mercado Pago that will be used to make commission payments. This means that when a commission is owed to someone, the funds will be withdrawn from this Mercado Pago account to make the payment. - spa: Identificador de la cuenta en Mercado Pago que se utilizará para realizar los pagos de comisiones. Esto significa que cuando se deba una comisión a alguien, los fondos se retirarán de esta cuenta de Mercado Pago para efectuar el pago. - por: Identificador da conta no Mercado Pago que será utilizada para efetuar os pagamentos das comissões. Isso significa que, quando uma comissão for devida a alguém, os fundos serão retirados dessa conta do Mercado Pago para realizar o pagamento. - amount_details: - description: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - x-description-i18n: - eng: This field encompasses payment value details, including the amount paid, and in cases of refunds, the total refunded amount. Additionally, it covers the costs associated with shipping the purchased product. - spa: Este campo abarca los detalles de valor de la transacción, incluyendo la cantidad pagada y, en casos de reembolso, la cantidad total reembolsada. Además, cubre los costos asociados con el envío del producto adquirido. - por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. Também engloba os custos associados ao envio do produto adquirido. - type: object - properties: - total: - type: string - example: "123.00" - description: Details of the total value of the payment. - x-description-i18n: - eng: Details of the total value of the payment. - spa: Detalles del monto total de la transacción. - por: Detalhes do valor total da transação. - paid: - type: string - example: "100.00" - description: Total paid. - x-description-i18n: - eng: Total paid. - spa: Monto de la transacción pagado. - por: Valor pago. - refunded: - type: string - example: "100.00" - description: Total value refunded. - x-description-i18n: - eng: Total value refunded. - spa: Monto de la transacción devuelto. - por: Valor total reembolsado. - shipment: - type: string - example: "10.00" - description: Total value charged per shipment. - x-description-i18n: - eng: Total value charged per shipment. - spa: Monto cobrado por envío (incluido en el otal). - por: Valor cobrado por envio (incluído no total). - payment_method: - description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - x-description-i18n: - eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. - spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. - por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. - type: object - properties: - credit_cards: - description: Credit cards. - x-description-i18n: - eng: Credit cards. - spa: Tarjetas de crédito. - por: Cartões de crédito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 12345432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "visa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - installments: - type: number - description: Quantity of installments. - x-description-i18n: - eng: Quantity of installments. - spa: Cantidad de cuotas deseadas. - por: Quantidade de parcelas desejadas. - example: 1 - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - debit_cards: - description: Debit cards. - x-description-i18n: - eng: Debit cards. - spa: Tarjetas de débito. - por: Cartões de débito. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Total a ser pago com este meio de pagamento. - token: - type: string - example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" - description: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - x-description-i18n: - eng: Card token that represents securely the credit card data. For example, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - spa: card_token que representa de manera segura los datos de tarjeta. Por ejemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - por: Card token que representa de maneira segura os dados do cartão. Por exemplo, "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb". - payment_id: - type: number - example: 1234565432 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - payment_method_id: - type: string - example: "debvisa" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - issuer: - type: string - example: "23" - description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - x-description-i18n: - eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. - spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. - por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. - statement_descriptor: - type: string - example: "MERCADOPAGO" - description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - x-description-i18n: - eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. - spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. - por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: ID of the refund. - x-description-i18n: - eng: ID of the refund. - spa: ID del reembolso. - por: ID do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - tickets: - description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - x-description-i18n: - eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. - spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. - por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. - type: array - items: - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "pec" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 1234567654 - description: Payment identification associated with the payment method used. - x-description-i18n: - eng: Payment identification associated with the payment method used. - spa: Identificación de pago asociada al medio de pago utilizado. - por: Identificação de pagamento associada ao meio de pagamento utilizado. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - status_detail: - type: object - description: Detail information about the status of the payment. - x-description-i18n: - eng: Information about the status of the payment. - spa: Información sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do Pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - atms: - description: ATM (Automated Teller Machine). - x-description-i18n: - eng: ATM (Automated Teller Machine). - spa: Cajero automático. - por: Caixa eletrônico. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "bapropagos" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 12345432423 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de reembolsos relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do pagamento. - bank_transfers: - description: Bank transfers. - x-description-i18n: - eng: Bank transfers. - spa: Transferencias bancarias. - por: Transferências bancárias. - type: array - items: - type: object - properties: - amount: - type: string - example: "50.00" - description: Total amount to be paid with this payment method. - x-description-i18n: - eng: Total amount to be paid with this payment method. - spa: Monto a pagar con este medio de pago. - por: Valor total a ser pago com este meio de pagamento. - payment_method_id: - type: string - example: "banco_mp" - description: Identifier of the chosen payment method. - x-description-i18n: - eng: Identifier of the chosen payment method. - spa: Identificador del medio de pago elegido. - por: Identificador do meio de pagamento escolhido. - payment_id: - type: number - example: 23421234543 - description: Payment ID corresponding to the payment method. - x-description-i18n: - eng: Payment ID corresponding to the payment method. - spa: ID de Pago correspondiente al medio de pago. - por: ID de pagamento correspondente ao meio de pagamento. - status: - type: string - example: "pending" - description: Status of the payment. - x-description-i18n: - eng: Status of the payment. - spa: Status del pago. - por: Status do pagamento. - completion_url: - type: string - description: For offline payments, this is the URL that enables the continuation of the payment flow. - x-description-i18n: - eng: For offline payments, this is the URL that enables the continuation of the payment flow. - spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. - por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. - refunds: - description: List of refunds related to the payment method. - x-description-i18n: - eng: List of refunds related to the payment method. - spa: Listado de devoluciones relacionadas al medio de pago. - por: Lista de reembolsos relacionados ao meio de pagamento. - type: object - properties: - refund_id: - type: number - example: 123456789 - description: Refund identifier. - x-description-i18n: - eng: Refund identifier. - spa: Identificador del reembolso. - por: Identificador do reembolso. - refund_amount: - type: string - example: "50.00" - description: Amount of the refund. - x-description-i18n: - eng: Amount of the refund. - spa: Monto del reembolso. - por: Valor do reembolso. - status_detail: - type: object - description: Detailed information about the status of the payment. - x-description-i18n: - eng: Detailed information about the status of the payment. - spa: Información detallada sobre el status del pago. - por: Informações detalhadas sobre o status do pagamento. - properties: - code: - type: string - example: "400" - description: Payment status code. - x-description-i18n: - eng: Payment status code. - spa: Código del status del pago. - por: Código do status do pagamento. - message: - type: string - example: "acquirer rejected" - description: Payment status message. - x-description-i18n: - eng: Payment status message. - spa: Mensaje del status del pago. - por: Mensagem do status do Pagamento. - "400": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + enum: + - Not Found. + "408": + description: Request Timeout + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Request Timeout. + "409": + description: Conflict + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Conflict. + "422": + description: Unprocessable Entity content: application/json: schema: @@ -4733,19 +2613,20 @@ paths: errorKey: type: string enum: - - 400--Bad Request. - - 401--Unauthorized. - - 403--Forbidden. - - 404--Not Found. - - 408--Request Timeout. - - 409--Conflict. - - 422--Unprocessable Entity. + - Unprocessable Entity. "500": - description: Error - x-description-i18n: - eng: Error - spa: Error - por: Erro + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Internal Server Error. + "503": + description: Service Unavailable content: application/json: schema: @@ -4754,5 +2635,4 @@ paths: errorKey: type: string enum: - - 500--Unexpected Error. - - 503--Service Unavailable. + - Service Unavailable. \ No newline at end of file From 02fec0085a47a544ddd3fcb83606372052a8c678 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 19 Sep 2023 11:23:56 -0300 Subject: [PATCH 38/40] updated endpoint description --- reference/api/payment_intent.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/api/payment_intent.yaml b/reference/api/payment_intent.yaml index f09b02dcb2..c1ce12490e 100644 --- a/reference/api/payment_intent.yaml +++ b/reference/api/payment_intent.yaml @@ -17,8 +17,8 @@ paths: description: This endpoint provides the functionality to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates x-description-i18n: eng: This endpoint provides the functionality to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates - spa: Este endpoint permite crear y procesar una nueva Payment Intent. Si desea evitar el procesamiento inmediato durante la creación, simplemente omita el parámetro "payment_method". Posteriormente, puede modificar la Intención de Pago utilizando el endpoint PATCH /v1/payment-intents/:id para actualizaciones - por: Este endpoint oferece a capacidade de criar e processar uma nova Payment Intent. Se você deseja evitar o processamento imediato durante a criação, basta omitir o parâmetro "payment_method". Posteriormente, é possível modificar a Intenção de Pagamento utilizando o endpoint PATCH /v1/payment-intents/:id para atualizações + spa: Este endpoint permite crear y procesar una nueva Payment Intent. Si desea evitar el procesamiento inmediato durante la creación, simplemente omita el parámetro "payment_method". Posteriormente, puede modificar la Payment Intent utilizando el endpoint PATCH /v1/payment-intents/:id para actualizaciones + por: Este endpoint oferece a capacidade de criar e processar uma nova Payment Intent. Se você deseja evitar o processamento imediato durante a criação, basta omitir o parâmetro "payment_method". Posteriormente, é possível modificar a Payment Intent utilizando o endpoint PATCH /v1/payment-intents/:id para atualizações parameters: - in: header name: Authorization From feea510547b84e86d32ab06e47ad267a7fefa2b1 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Tue, 19 Sep 2023 11:31:16 -0300 Subject: [PATCH 39/40] description adjustments --- reference/api/payment_intent.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/api/payment_intent.yaml b/reference/api/payment_intent.yaml index c1ce12490e..5ee9856220 100644 --- a/reference/api/payment_intent.yaml +++ b/reference/api/payment_intent.yaml @@ -14,11 +14,11 @@ paths: eng: Create a Payment Intent spa: Crear Payment Intent por: Criar Payment Intent - description: This endpoint provides the functionality to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates + description: This endpoint allows to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates x-description-i18n: - eng: This endpoint provides the functionality to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates + eng: This endpoint allows to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates spa: Este endpoint permite crear y procesar una nueva Payment Intent. Si desea evitar el procesamiento inmediato durante la creación, simplemente omita el parámetro "payment_method". Posteriormente, puede modificar la Payment Intent utilizando el endpoint PATCH /v1/payment-intents/:id para actualizaciones - por: Este endpoint oferece a capacidade de criar e processar uma nova Payment Intent. Se você deseja evitar o processamento imediato durante a criação, basta omitir o parâmetro "payment_method". Posteriormente, é possível modificar a Payment Intent utilizando o endpoint PATCH /v1/payment-intents/:id para atualizações + por: Este endpoint permite criar e processar uma nova Payment Intent. Se você deseja evitar o processamento imediato durante a criação, basta omitir o parâmetro "payment_method". Posteriormente, é possível modificar a Payment Intent utilizando o endpoint PATCH /v1/payment-intents/:id para atualizações parameters: - in: header name: Authorization From 0ab5a5a6f4d2bc4ac9cf4fc5afe0cdc7d1eaa6f2 Mon Sep 17 00:00:00 2001 From: rwaetemann Date: Mon, 9 Oct 2023 15:57:58 -0300 Subject: [PATCH 40/40] endpoints update --- reference/api/payment_intent.yaml | 67 +- reference/api/payment_intent_id.yaml | 1104 +++++++++++++++++++++++++- 2 files changed, 1126 insertions(+), 45 deletions(-) diff --git a/reference/api/payment_intent.yaml b/reference/api/payment_intent.yaml index 5ee9856220..58ca068fac 100644 --- a/reference/api/payment_intent.yaml +++ b/reference/api/payment_intent.yaml @@ -14,11 +14,11 @@ paths: eng: Create a Payment Intent spa: Crear Payment Intent por: Criar Payment Intent - description: This endpoint allows to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates + description: This endpoint allows you to creates and process a new Payment Intent. To not process the created Payment Intent, you need omit the parameter payment_method in the creation, and then you can modify and/or process the payment intent using the endpoint PATCH /v1/payment-intents/:id. x-description-i18n: - eng: This endpoint allows to create and process a new Payment Intent. If you wish to defer the processing at the time of creation, simply omit the "payment_method" parameter. Subsequently, you can modify the Payment Intent using the PATCH /v1/payment-intents/:id endpoint for updates - spa: Este endpoint permite crear y procesar una nueva Payment Intent. Si desea evitar el procesamiento inmediato durante la creación, simplemente omita el parámetro "payment_method". Posteriormente, puede modificar la Payment Intent utilizando el endpoint PATCH /v1/payment-intents/:id para actualizaciones - por: Este endpoint permite criar e processar uma nova Payment Intent. Se você deseja evitar o processamento imediato durante a criação, basta omitir o parâmetro "payment_method". Posteriormente, é possível modificar a Payment Intent utilizando o endpoint PATCH /v1/payment-intents/:id para atualizações + eng: This endpoint allows you to creates and process a new Payment Intent. To not process the created Payment Intent, you need omit the parameter payment_method in the creation, and then you can modify and/or process the payment intent using the endpoint PATCH /v1/payment-intents/:id. + spa: Este endpoint permite crear y procesar una nueva Payment Intent. Para no hacer el procesamiento durante la creacion, es necesario omitir el parametro payment_method en la creacion, y luego se puede modificar y/o procesar la payment intent usando el endpoint PATCH /v1/payment-intents/:id. + por: Este endpoint permite criar e processar uma nova Payment Intent. Para nao fazer o processamento durante a criação, é necessário omitir o parâmetro payment_method na criação, depois pode-se modificar a Payment-Intent usando o endpoint PATCH /v1/payment-intents/:id. parameters: - in: header name: Authorization @@ -570,6 +570,24 @@ paths: spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time + active_to_date: + type: string + description: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T08:00:00.000-03:00". + por: Prazo máximo de processamento para Payment Intent. Este prazo determina a data limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + last_updated_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of the last updated of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Date of the last updated of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de la última actualización de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data da última atualização da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time status: type: string example: "processed" @@ -1347,6 +1365,14 @@ paths: eng: For offline payments, this is the URL that enables the continuation of the payment flow. spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + qr_code_base64: + type: string + example: "" + description: For offline payments, this is information about the qr code to finish the payment. + x-description-i18n: + eng: For offline payments, this is information about the qr code to finish the payment. + spa: Para pagos offline, esta es la información del QR Code para finalizar el pago. + por: Para pagamentos realizados offline, é a informação do QR Code para finalizar o pagamento. response_detail: type: object description: Payment status details. @@ -1498,16 +1524,16 @@ paths: post: tags: - $ref: '#/tags/checkout-api' - summary: Authorize payments for a Payment Intent + summary: Authorize payments for a Payment Intents. x-summary-i18n: - eng: Authorize payments for a Payment Intent - spa: Autorizar pagos de una Payment Intent - por: Autorizar pagamentos de uma Payment Intent - description: This endpoint enables the authorization of payments for an existing Payment Intent + eng: Authorize payments for a Payment Intents. + spa: Autorizar pagos para una Payment Intents. + por: Autorizar pagamentos para uma Payment Intents. + description: Create a new Payment-Intent and reserves the amount on the customer's credit card. x-description-i18n: - eng: This endpoint enables the authorization of payments for an existing Payment Intent - spa: Este endpoint permite la autorización de pagos para una Payment Intent ya existente - por: Este endpoint possibilita a autorização de pagamentos para uma Payment Intent já existente + eng: Create a new Payment-Intent and reserves the amount on the customer's credit card. + spa: Crea una Payment-Intent de pago y reserva el monto en la tarjeta de crédito del cliente. + por: Cria uma nova Payment-Intent e reserva o valor no cartão de crédito cliente. parameters: - in: header name: Authorization @@ -1515,11 +1541,11 @@ paths: type: string example: "Bearer token-89987654567f-numeroToken" required: true - description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + description: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. x-description-i18n: - eng: Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. - spa: Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. - por: Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. + eng: Access Token - Application private key that must always be used in the backend to generate payments. It is essential that this information is kept secure on their servers. + spa: Access Token - Clave privada de la aplicación que siempre debe ser utilizada en el backend para generar pagos. Es fundamental que esta información se mantenga segura en sus servidores. + por: Access Token - Chave privada do aplicativo que deve ser sempre usada no backend para gerar pagamentos. É essencial que essas informações sejam mantidas seguras em seus servidores. - in: header name: X-Idempotency-Key schema: @@ -1934,6 +1960,15 @@ paths: spa: Fecha de creación de la Payment-Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". por: Data de criação da Payment-Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time + last_updated_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de la última actualización de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data da última atualização da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time status: type: string example: "authorized" diff --git a/reference/api/payment_intent_id.yaml b/reference/api/payment_intent_id.yaml index b0c00ab049..9ec0fd6b8e 100644 --- a/reference/api/payment_intent_id.yaml +++ b/reference/api/payment_intent_id.yaml @@ -9,14 +9,14 @@ paths: get: tags: - $ref: "#/tags/checkout-api" - summary: Get Payment Intent by ID + summary: Get payment intent by ID x-summary-i18n: - eng: Get Payment Intent by ID - spa: Obtener Payment Intent por ID - por: Obter Payment Intent por ID - description: This endpoint allows you to retrieve an existing Payment Intent using its ID as a parameter + eng: Get payment intent by ID + spa: Obtener payment intent por ID + por: Obter payment intent por ID + description: This endpoint allows you to retrieve an existing 'Payment Intent' using its ID as a parameter x-description-i18n: - eng: This endpoint allows you to retrieve an existing Payment Intent using its ID as a parameter + eng: This endpoint allows you to retrieve an existing 'Payment Intent' using its ID as a parameter spa: Este endpoint permite consultar una Payment Intent ya existente mediante su ID por: Este endpoint permite consultar uma Payment Intent existente utilizando seu ID como parâmetro parameters: @@ -42,11 +42,11 @@ paths: spa: Este campo especifica el método de autenticación en uso. Cuando se utiliza el "client token" como medio de autorización, este header se vuelve obligatorio. Establezca su valor como "payment_intent". por: Este campo especifica o método de autenticação em uso. Quando se utiliza o "client token" como meio de autorização, este header é obrigatório. Defina seu valor como "payment_intent". - name: id - description: Payment Intent's Id. + description: Payment Intent's Id. For example - "00001njp2i". x-description-i18n: - eng: Payment Intent's Id. - spa: ID de la Payment Intent. - por: ID da Payment Intent. + eng: Payment Intent's Id. For example - "00001njp2i". + spa: ID de la Payment Intent. Por ejemplo - "00001njp2i". + por: ID da Payment Intent. Por exemplo - "00001njp2i". in: path required: true schema: @@ -85,6 +85,24 @@ paths: spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time + active_to_date: + type: string + description: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T08:00:00.000-03:00". + por: Prazo máximo de processamento para Payment Intent. Este prazo determina a data limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + last_updated_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de la última actualización de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data da última atualização da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time status: type: string example: "processed" @@ -867,6 +885,14 @@ paths: eng: For offline payments, this is the URL that enables the continuation of the payment flow. spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + qr_code_base64: + type: string + example: "" + description: For offline payments, this is information about the qr code to finish the payment. + x-description-i18n: + eng: For offline payments, this is information about the qr code to finish the payment. + spa: Para pagos offline, esta es la información del código QR para finalizar el pago. + por: Para pagamentos realizados offline, é a informação do código QR para finalizar o pagamento. response_detail: type: object description: Payment status details. @@ -1022,11 +1048,11 @@ paths: eng: Modify Payment Intent spa: Modificar Payment Intent por: Modificar Payment Intent - description: This endpoint enables the modification of a Payment Intent. Such changes are only allowed for Payment Intents that have not yet been processed. After making the modifications, the Payment Intent will be available for processing + description: Modifying a Payment-Intent is a process only permitted for payment-intents that have not been processed. After making the changes, you can process your payment-intent x-description-i18n: - eng: This endpoint enables the modification of a Payment Intent. Such changes are only allowed for Payment Intents that have not yet been processed. After making the modifications, the Payment Intent will be available for processing - spa: Este endpoint permite la modificación de una Payment Intent. Tales cambios sólo son permitidos para Payment Intents que aún no han sido procesadas. Después de realizar las modificaciones, la Payment Intent estará disponible para ser procesada - por: Este endpoint possibilita a modificação de uma Payment Intent. Essa alteração é permitida somente para Payment Intents que ainda não foram processadas. Após efetuar as modificações, a Payment Intent estará disponível para ser processada + eng: Modifying a Payment-Intent is a process only permitted for payment-intents that have not been processed. After making the changes, you can process your payment-intent + spa: Modificar una Payment-Intent es un proceso que solo se permite para payment-intents que no han sido procesadas. Después de realizar los cambios, podrá procesar su payment-intent + por: A modificação de um Payment-Intent é um processo permitido apenas para payment-intents que não foram processadas. Após realizar as alterações é possível processar sua payment-intent parameters: - in: header name: Authorization @@ -1044,7 +1070,6 @@ paths: schema: type: string example: "payment_intent" - required: false description: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". x-description-i18n: eng: This field indicates the authentication method in use. When using the "client token" for authorization, this header becomes mandatory. Set its value to "payment_intent". @@ -1062,11 +1087,11 @@ paths: spa: Esta función permite repetir solicitudes de manera segura, sin el riesgo de realizar la misma acción más de una vez por error. Esto es útil para evitar errores, como la creación de dos Payment Intents idénticas, por ejemplo. Para garantizar que cada solicitud sea única, es importante utilizar un valor exclusivo en el header de su solicitud. Sugerimos el uso de un UUID V4 o strings aleatorias. por: Esta função permite repetir solicitações de forma segura, sem o risco de realizar a mesma ação mais de uma vez por engano. Isso é útil para evitar erros, como a criação de duas Payment-Intents idênticas, por exemplo. Para garantir que cada solicitação seja única, é importante usar um valor exclusivo no header da sua solicitação. Sugerimos o uso de um UUID V4 ou strings randômicas. - name: id - description: ID of a created Payment-Intent. + description: ID of a created Payment-Intent. For example - "00321nj123". x-description-i18n: - eng: ID of a created Payment Intent. - spa: ID de la Payment-Intent creada. - por: ID da Payment-Intent criada. + eng: ID of a created Payment Intent. For example - "00321nj123". + spa: ID de la Payment-Intent creada. Por ejemplo - "00321nj123". + por: ID da Payment-Intent criada. Por exemplo - "00321nj123". in: path required: true schema: @@ -1426,6 +1451,15 @@ paths: por: Prazo máximo de processamento para Payment Intent. Este prazo determina a data limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo, "2023-09-06T08:00:00.000-03:00". format: date-time example: "2023-09-06T10:00:00.000-03:00" + last_updated_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de la última actualización de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data da última atualização da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time status: type: string example: "new" @@ -1664,19 +1698,9 @@ paths: properties: area_code: type: string - description: Buyer's area code. - x-description-i18n: - eng: Buyer's area code. - spa: Código de área del comprador. - por: Código de área do comprador. example: "11" number: type: string - description: Buyer's phone number number. - x-description-i18n: - eng: Buyer's phone number number. - spa: Número de teléfono del comprador. - por: Número de telefone do comprador. example: "99999999" advanced: type: object @@ -2211,6 +2235,14 @@ paths: eng: For offline payments, this is the URL that enables the continuation of the payment flow. spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + qr_code_base64: + type: string + example: "" + description: For offline payments, this is information about the qr code to finish the payment. + x-description-i18n: + eng: For offline payments, this is information about the qr code to finish the payment. + spa: Para pagos offline, esta es la información del código QR para finalizar el pago. + por: Para pagamentos realizados offline, é a informação do código QR para finalizar o pagamento. response_detail: type: object description: Payment status details. @@ -2625,6 +2657,1020 @@ paths: type: string enum: - Internal Server Error. + "503": + description: Service Unavailable + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Service Unavailable. + /v1/payment-intents/{id}/process: + post: + tags: + - $ref: "#/tags/checkout-api" + summary: Process Payment Intent by ID + x-summary-i18n: + eng: Process Payment Intent by ID + spa: Procesar Payment Intent por ID + por: Processar Payment Intent por ID + description: This endpoint allows you to process an existing Payment Intent using its ID as a parameter + x-description-i18n: + eng: This endpoint allows you to process an existing Payment Intent using its ID as a parameter + spa: Este endpoint permite procesar una Payment Intent ya existente mediante su ID + por: Este endpoint permite processar uma Payment Intent existente utilizando seu ID como parâmetro + parameters: + - in: header + name: Authorization + schema: + type: string + example: "Bearer ACCESS_TOKEN_or_CLIENT_TOKEN" + required: true + description: Access Token or Client Token - Access Token is the application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. + x-description-i18n: + eng: Access Token or Client Token - Access Token is the application's private key that must be used exclusively in the backend for payment generation, requiring these pieces of information to be kept secure on its servers. Client Token is the token generated from the return of an unprocessed payment intention, it will be available in the client_token property, this token can be used for calls from the frontend. + spa: Access Token o Client Token - Access Token es la clave privada de la aplicación que debe ser utilizada exclusivamente en el backend para la generación de pagos, siendo necesario mantener esta información segura en sus servidores. Client Token es el token generado a partir de la devolución de una intención de pago no procesada, estará disponible en la propiedad client_token, este token se puede usar para llamadas a partir de frontend. + por: Access Token ou Client Token - Access Token é a chave privada do aplicativo que deve ser usada exclusivamente no backend para a geração de pagamentos, sendo necessário manter essas informações seguras em seus servidores. Client Token é o token gerado a partir do retorno de uma payment intent não processada, estará disponibilizado na propriedade client_token, este token pode ser usado para chamadas de seu frontend. + - name: id + description: Payment Intent's Id. For example - "00001njp2i" + x-description-i18n: + eng: Payment Intent's Id. For example - "00001njp2i" + spa: ID de la Payment Intent. Por ejemplo - "00001njp2i" + por: ID da Payment Intent. Por exemplo - "00001njp2i" + in: path + required: true + schema: + type: string + example: "00001njp2i" + responses: + "201": + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: string + example: "00001njp2i" + description: ID of a created Payment Intent. + x-description-i18n: + eng: ID of a created Payment Intent. + spa: ID de la Payment Intent creada. + por: ID da Payment Intent criada. + client_token: + type: string + example: "" + description: Generated by an unprocessed Payment-Intent, this token can be used for calls from your frontend, replacing the value of the Authorization parameter. + x-description-i18n: + eng: Generated by an unprocessed Payment-Intent, this token can be used for calls from your frontend, replacing the value of the Authorization parameter. + spa: Generado por una Payment-Intent no procesada, este token se puede usar para llamadas desde su interfaz, reemplazando el valor del parámetro Autorización.. + por: Gerado por uma Payment-Intent não processada, este token pode ser usado para chamadas a partir do seu frontend, substituindo o valor do parâmetro Authorization. + created_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Date of creation of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de creación de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data de criação da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time + active_to_date: + type: string + description: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Maximum processing deadline for the payment intent. This deadline sets the date by which the payment Intent is expected to be processed and completed. For example - "2023-09-06T08:00:00.000-03:00". + spa: Plazo máximo de procesamiento para la Payment Intent. Este plazo establece la fecha límite hasta la cual se espera que la Payment Intent sea procesada y completada. Por ejemplo - "2023-09-06T08:00:00.000-03:00". + por: Prazo máximo de processamento para Payment Intent. Este prazo determina a data limite até a qual se espera que a Payment Intent seja processada e finalizada. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time + example: "2023-09-06T10:00:00.000-03:00" + last_updated_date: + type: string + example: "2023-09-06T08:00:00.000-03:00" + description: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + x-description-i18n: + eng: Date of the last update of the Payment Intent. For example, "2023-09-06T08:00:00.000-03:00". + spa: Fecha de la última actualización de la Payment Intent. Por ejemplo, "2023-09-06T08:00:00.000-03:00". + por: Data da última atualização da Payment Intent. Por exemplo, "2023-09-06T08:00:00.000-03:00". + format: date-time + status: + type: string + example: "processed" + description: Current status of the Payment Intent. + x-description-i18n: + eng: Current status of the Payment Intent. + spa: Status actual de la Payment Intent. + por: Status atual da Payment Intent. + configuration: + type: object + description: Configuration parameters defined by the seller before starting the transaction + x-description-i18n: + eng: Configuration parameters defined by the seller before starting the transaction + spa: Parámetros de configuración definidos por el seller antes de iniciar la transacción + por: Configuração definida pelo seller antes de iniciar a transação + properties: + integration: + type: object + description: Configuration of the seller on integration. + x-description-i18n: + eng: Configuration of the seller on integration. + spa: Configuración del seller sobre la integración. + por: Configuração do vendedor sobre a integração. + properties: + notification_url: + type: string + description: URL to which notifications will be sent. + example: "https://www.integrator-site.com/notifications" + x-description-i18n: + eng: URL to which notifications will be sent. + spa: URL a la cual se enviarán las notificaciones. + por: URL para a qual as notificações serão enviadas. + return_url_default: + description: Default URL to redirect the buyer. + x-description-i18n: + eng: Default URL to redirect the buyer. + spa: URL por defecto a la cual se redireccionará al comprador. + por: URL padrão para redirecionar o comprador. + type: string + example: "https://www.integrator-site.com/order" + return_url_success: + description: URL to redirect the buyer in case of successful payment. + type: string + example: "https://www.integrator-site.com/order/success" + x-description-i18n: + eng: URL to redirect the buyer in case of successful payment. + spa: URL a la cual se redireccionará al comprador en caso de pago exitoso. + por: URL para redirecionar o comprador em caso de pagamento bem-sucedido. + return_url_pending: + description: URL to redirect the buyer in case of pending payment. + type: string + example: "https://www.integrator-site.com/order/pending" + x-description-i18n: + eng: URL to redirect the buyer in case of pending payment. + spa: URL a la cual se redireccionará al comprador en caso de pago pendiente. + por: URL para redirecionar o comprador em caso de pagamento pendente. + return_url_failure: + description: URL to redirect the buyer in case of failed payment. + type: string + example: "https://www.integrator-site.com/order/failed" + x-description-i18n: + eng: URL to redirect the buyer in case of failed payment. + spa: URL a la cual se redireccionará al comprador en caso de pago fallido. + por: URL para redirecionar o comprador em caso de pagamento falhou. + order: + type: object + description: Common Order attributes for request and response. + x-description-i18n: + eng: Common Order attributes for request and response. + spa: Atributos de Order comunes para el request y el response. + por: Atributos de Order comuns para o request e o response. + properties: + external_reference: + type: string + example: "my_order_id" + description: Reference of the order + x-description-i18n: + eng: ID of the order previously created in the integrator's system + spa: ID en sistema externo del integrador + por: ID da ordem criada anteriormente no sistema do integrador + description: + type: string + example: "my_order_description" + description: Description of the order or payment. + x-description-i18n: + eng: Description of the order or payment. + spa: Descricion de la orden o transacción. + por: Descrição da ordem ou transação. + amount: + type: string + example: "233.00" + description: Total value of the transaction + x-description-i18n: + eng: Total value of the transaction + spa: Monto total de la transacción + por: Valor total da transação + items: + type: array + description: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. + x-description-i18n: + eng: Information relevant to the configuration of the items comprising the payment, such as the list of items, their quantities, and prices. This encompasses details about the various products or services involved in the payment, including the quantity of each item and the corresponding price for each of them. + spa: Información relevante para la configuración de los elementos que componen la transacción, como la lista de elementos, sus cantidades y precios. Esto abarca detalles sobre los diferentes productos o servicios involucrados en la transacción, incluyendo la cantidad de cada elemento y el precio correspondiente a cada uno de ellos. + por: Informações pertinentes à configuração dos itens que constituem a transação, tais como a lista de itens, suas quantidades e preços. Isso abrange informações sobre os diferentes produtos ou serviços envolvidos na transação, incluindo a quantidade de cada item e o preço correspondente a cada um deles. + items: + properties: + id: + type: string + example: "x76ax" + description: Item identification code. + x-description-i18n: + eng: Item identification code. + spa: Código de identificación del ítem. + por: Código de identificação do item. + quantity: + type: number + example: 4 + description: Number of item included in the order. + x-description-i18n: + eng: Number of item included in the order. + spa: Cantidad de ocurrencias del ítem incluidos en la órden. + por: Quantidade de itens incluídos no pedido. + unit_price: + type: string + example: "100.00" + description: Unit price of the item. + x-description-i18n: + eng: Unit value of the item. + spa: Precio unitario del ítem. + por: Preço unitário do item. + dimensions: + type: string + example: "30x30x30" + description: Dimensions of the item - length x width x height. + x-description-i18n: + eng: Dimensions of the item - length x width x height. + spa: Dimensiones del ítem - largo x ancho x alto. + por: Dimensões do item - comprimento x largura x altura. + description: + type: string + example: "Beautifully handmade laptop case/sleeve made in the Himalaya. " + description: Description of the item that makes up the list of order items. + x-description-i18n: + eng: Description of the item that makes up the list of order items. + spa: Descripción del artículo que componen el listado de items de la orden. + por: Descrição do item que compõe a lista de itens do pedido. + payer: + type: object + description: Buyer's information. + x-description-i18n: + eng: Buyer's information. + spa: Información del comprador. + por: Informações do comprador. + properties: + email: + type: string + description: Buyer's email. + x-description-i18n: + eng: Buyer's email. + spa: Email del comprador. + por: Email do comprador. + customer_id: + type: number + example: 123456 + description: Previously stored buyer identification number. + x-description-i18n: + eng: Previously stored buyer identification number. + spa: Número de identificación del comprador previamente almacenado. + por: Número de identificação do comprador previamente armazenado. + identification: + type: object + description: Type and number of legal document that identifies the person in the country. + x-description-i18n: + eng: Type and number of legal document that identifies the person in the country. + spa: Tipo y número de documento legal que identifica a la persona en el país. + por: Tipo e número de documento que identifica a pessoa no país. + properties: + number: + type: string + example: "12345678098" + description: Number of the document. + x-description-i18n: + eng: Number of the document. + spa: Número del documento. + por: Número do documento. + type: + type: string + example: "CPF" + description: Type of the document. + x-description-i18n: + eng: Type of the document. + spa: Tipo de documento. + por: Tipo de documento. + address: + type: object + description: Address of the buyer. + x-description-i18n: + eng: Address of the buyer. + spa: Dirección del comprador. + por: Endereço do comprador. + properties: + street_name: + type: string + example: "Street MercadoLivre" + description: Street name. + x-description-i18n: + eng: Street name. + spa: Nombre de la calle. + por: Nome da rua. + street_number: + type: string + example: "100" + description: Street number. + x-description-i18n: + eng: Street number. + spa: Número de la calle. + por: Número da casa. + zip_code: + type: string + example: "57000-865" + description: Zip code. + x-description-i18n: + eng: Zip code. + spa: Código postal. + por: Código postal. + phone: + type: object + description: Buyer's phone number. + x-description-i18n: + eng: Buyer's phone number. + spa: Número de teléfono del comprador. + por: Número de telefone do comprador. + properties: + area_code: + type: string + example: "11" + number: + type: string + example: "99999999" + advanced: + type: object + description: Options for advanced transaction. + x-description-i18n: + eng: Options for advanced transaction. + spa: Agrupación de opciones avanzadas para la transacción. + por: Opções avançadas para a transação. + properties: + binary_mode: + type: boolean + example: true + description: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). + x-description-i18n: + eng: Allows to require a final response from the transaction in your first processing (by disabling any offline or asynchronous processing option). + spa: Permite exigir una respuesta final de la transacción en su primer procesamiento (deshabilitando cualquier opción de procesamiento offline o asíncrona). + por: Permite exigir uma resposta final da transação no primeiro processamento (desabilitando qualquer opção de processamento offline ou assíncrono). + amount_details: + type: object + description: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + x-description-i18n: + eng: This field covers details relating to transaction amounts, including the amount paid and, in refund situations, the total amount refunded. + spa: Este campo incluye detalles relativos a los importes de las transacciones, incluido el importe pagado y, en situaciones de reembolso, el importe total reembolsado. + por: Este campo abrange os detalhes relacionados aos montantes da transação, incluindo o valor pago e, em situações de reembolso, o montante total reembolsado. + properties: + total: + type: string + example: "123.00" + description: Details of the total value of the transaction. + x-description-i18n: + eng: Details of the total value of the transaction. + spa: Detalles del monto total de la transacción. + por: Detalhes do valor total da transação. + paid: + type: string + example: "100.00" + description: Total paid. + x-description-i18n: + eng: Total paid. + spa: Monto de la transacción pagado. + por: Valor pago. + refunded: + type: string + example: "100.00" + description: Total value refunded. + x-description-i18n: + eng: Total value refunded. + spa: Monto de la transacción devuelto. + por: Valor reembolsado. + payment_method: + type: object + description: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + x-description-i18n: + eng: Detailed information about the available payment methods during the payment, such as the total amount to be paid using a specific payment method, installment options, among others. + spa: Información detallada sobre los medios de pago disponibles durante la transacción, como por ejemplo, el monto total a pagar utilizando un método de pago específico, opciones de financiamiento, entre otros. + por: Informações detalhadas sobre os meios de pagamento disponíveis durante a transação, como por exemplo, valor total a ser pago com determinado meio de pagamento, parcelamento, entre outros. + properties: + credit_cards: + type: array + description: Credit cards. + x-description-i18n: + eng: Credit cards. + spa: Tarjetas de crédito. + por: Cartão de crédito. + items: + properties: + installments: + type: number + example: 1 + description: Quantity of installments. + x-description-i18n: + eng: Quantity of installments. + spa: Cantidad de cuotas deseadas. + por: Quantidade de parcelas desejadas. + payment_id: + type: number + example: 12345432 + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: ID de pagamento correspondente ao meio de pagamento. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. + x-description-i18n: + eng: Card token that represents securely the credit card data. + spa: Card token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. + payment_method_id: + type: string + example: "visa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + x-description-i18n: + eng: If required, this is the identifier of the card issuer entity. This identifier is used to record the source of the payment card. In certain situations, having this information is important for tracking, security, and payment analysis purposes. + spa: En caso de ser necesario, este es el identificador de la entidad emisora de la tarjeta. Este identificador se utiliza para registrar el origen de la tarjeta de pago. En ciertas situaciones, contar con esta información es importante para fines de seguimiento, seguridad y análisis de transacciones. + por: Se necessário, este é o identificador da instituição que emitiu o cartão. Esse identificador é usado para registrar a origem do cartão de pagamento. Em algumas situações, é importante ter essa informação para fins de rastreamento, segurança e análise de transações. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + x-description-i18n: + eng: Charge descriptor to be displayed on the card statement. The charge descriptor is the text or name that will appear on the customer's credit card statement to identify the payment. It provides a brief description that assists the customer in recognizing the nature of the payment conducted. + spa: Descriptor del cargo que se mostrará en el estado de cuenta de la tarjeta. El descriptor del cargo es el texto o nombre que aparecerá en el estado de cuenta de la tarjeta de crédito del cliente para identificar la transacción. Proporciona una breve descripción que ayuda al cliente a reconocer la naturaleza de la transacción realizada. + por: Descritor da cobrança a ser mostrada no extrato do cartão. O descritor da cobrança é o texto ou nome que aparecerá no extrato do cartão de crédito do cliente para identificar a transação. Ele fornece uma breve descrição que ajuda o cliente a reconhecer a natureza da transação realizada. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Estado del pago. + por: Estado do pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. + debit_cards: + type: array + description: Debit card. + x-description-i18n: + eng: Debit card. + spa: Tarjeta de débito. + por: Cartão de débito. + items: + properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + token: + type: string + example: "1234567897yhjdsnfs78ry3iuthrbnfuve8h4t3unbf7e4rgb" + description: Card token that represents securely the credit card data. + x-description-i18n: + eng: Card token that represents securely the credit card data. + spa: card_token que representa de manera segura los datos de tarjeta. + por: Card token que representa de maneira segura os dados do cartão. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + issuer: + type: string + example: "23" + description: In case it is required, identifier of the card issuer entity. + x-description-i18n: + eng: In case it is required, identifier of the card issuer entity. + spa: En caso que sea requerido, identificador de la entidad emisora de la tarjeta. + por: Caso seja requerido, identificador da entidade emissora do cartão. + statement_descriptor: + type: string + example: "MERCADOPAGO" + description: Descriptor of the charge to be shown in the card statement. + x-description-i18n: + eng: descriptor of the charge to be shown in the card statement. + spa: Descriptor del cargo a utilizar en el resumen del emisor. + por: Descritor da cobrança a ser mostrada no extrato do cartão. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Estado del pago. + por: Estado do pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. + tickets: + type: array + description: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + x-description-i18n: + eng: Tickets, boleto, and payments at Casas Lotérica. In summary, this field provides information related to offline payment methods. + spa: Tickets, boleto y pagos en agencias de lotería. En resumen, este campo proporciona información relacionada con métodos de pago fuera de línea. + por: Tickets, boletos e pagamentos em casas lotéricas. Em resumo, este campo fornece informações relacionadas a pagamentos realizados offline. + items: + properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Estado del pago. + por: Estado do pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. + atms: + type: array + description: Automated Teller Machine. + x-description-i18n: + eng: Automated Teller Machine. + spa: Cajero automático. + por: Caixa eletrônico. + items: + properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Estado del pago. + por: Estado do pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. + bank_transfers: + type: array + description: Bank transfers. + x-description-i18n: + eng: Bank transfers. + spa: Transferencias bancarias. + por: Transferências bancárias. + items: + properties: + payment_id: + type: number + example: 1234565432 + description: Payment ID corresponding to the payment method. + x-description-i18n: + eng: Payment ID corresponding to the payment method. + spa: ID de Pago correspondiente al medio. + por: ID de pagamento correspondente ao meio de pagamento. + amount: + type: string + example: "50.00" + description: Total amount to be paid with this payment method. + x-description-i18n: + eng: Total amount to be paid with this payment method. + spa: Monto a pagar con este medio. + por: Valor total a ser pago com este meio de pagamento. + payment_method_id: + type: string + example: "debvisa" + description: Identifier of the chosen payment method. + x-description-i18n: + eng: Identifier of the chosen payment method. + spa: Identificador del medio de pago elegido. + por: Identificador do meio de pagamento escolhido. + status: + type: string + example: "pending" + description: Status of the payment. + x-description-i18n: + eng: Status of the payment. + spa: Estado del pago. + por: Estado do pagamento. + completion_url: + type: string + example: "" + description: For offline payments, this is the URL that enables the continuation of the payment flow. + x-description-i18n: + eng: For offline payments, this is the URL that enables the continuation of the payment flow. + spa: Para pagos offline, esta es la URL que permite continuar con el flujo de pago. + por: Para pagamentos realizados offline, é a URL que possibilita a continuação do processo de pagamento. + qr_code_base64: + type: string + example: "" + description: For offline payments, this is information about the qr code to finish the payment. + x-description-i18n: + eng: For offline payments, this is information about the qr code to finish the payment. + spa: Para pagos offline, esta es la información del código QR para finalizar el pago. + por: Para pagamentos realizados offline, é a informação do código QR para finalizar o pagamento. + response_detail: + type: object + description: Payment status details. + x-description-i18n: + eng: Payment status details. + spa: Detalle del estado del pago. + por: Detalhes do estado do pagamento. + properties: + code: + type: string + example: "" + description: Payment status code. + x-description-i18n: + eng: Payment status code. + spa: Código del status del pago. + por: Código do status do pagamento. + message: + type: string + example: "" + description: Payment status message. + x-description-i18n: + eng: Payment status message. + spa: Mensaje del status del pago. + por: Mensagem do status do Pagamento. + refunds: + type: object + description: List of refunds related to the payment method. + x-description-i18n: + eng: List of refunds related to the payment method. + spa: Listado de devoluciones relacionadas al medio de pago. + por: Lista de reembolsos relacionados ao meio de pagamento. + properties: + refund_id: + type: number + example: 123456789 + description: ID of the refund. + x-description-i18n: + eng: ID of the refund. + spa: ID de la devolución. + por: ID do reembolso. + refund_amount: + type: string + example: "50.00" + description: Amount of the refund. + x-description-i18n: + eng: Amount of the refund. + spa: Monto de la devolución. + por: Valor do reembolso. + "400": + description: Bad Request + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Bad Request. + "401": + description: Unauthorized + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unauthorized. + "403": + description: Forbidden + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Forbidden. + "404": + description: Not Found + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Not Found. + "408": + description: Request Timeout + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Request Timeout. + "409": + description: Conflict + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Conflict. + "422": + description: Unprocessable Entity + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Unprocessable Entity. + "500": + description: Internal Server Error + content: + application/json: + schema: + type: object + properties: + errorKey: + type: string + enum: + - Internal Server Error. "503": description: Service Unavailable content: