From fb353bfa493dbacce236aca337b922fe2eb233cc Mon Sep 17 00:00:00 2001 From: Gabrielly Pereira Date: Fri, 31 Jan 2025 16:53:41 -0300 Subject: [PATCH 1/2] 1 --- guides/batch-payments-vault-migration/landing.en.md | 2 +- guides/batch-payments-vault-migration/landing.es.md | 2 +- guides/batch-payments-vault-migration/landing.pt.md | 2 +- .../vault-migration/vault-landing.en.md | 2 +- .../vault-migration/vault-landing.es.md | 2 +- .../vault-migration/vault-landing.pt.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/guides/batch-payments-vault-migration/landing.en.md b/guides/batch-payments-vault-migration/landing.en.md index 234e11db69..530c1a01d0 100644 --- a/guides/batch-payments-vault-migration/landing.en.md +++ b/guides/batch-payments-vault-migration/landing.en.md @@ -9,7 +9,7 @@ content_section_with_media: - title: Batch Payments - message: Mercado Pago's Batch Payments are a practical and secure solution for making mass payments. With this tool, companies can manage recurring payments without the need for complex integrations with APIs, simplifying the process of financial transactions. The functionality allows generating and managing payment recurrence by importing .csv files sent to an SFTP server, making financial management more efficient and streamlined. Mercado Pago processes these payments through multi-acquiring and returns a file that presents the status of each payment made, providing clear and detailed control of financial operations. - media_image: /batch-payments/landing1.png - - highlight_countries: mla + - highlight_countries: mla, mlu, mlm, mlc, mco, mpe - country_title: Availability by Country --- --- diff --git a/guides/batch-payments-vault-migration/landing.es.md b/guides/batch-payments-vault-migration/landing.es.md index de4059ab48..e5a739bcae 100644 --- a/guides/batch-payments-vault-migration/landing.es.md +++ b/guides/batch-payments-vault-migration/landing.es.md @@ -9,7 +9,7 @@ content_section_with_media: - title: Batch Payments - message: Batch Payments de Mercado Pago es una solución práctica y segura para la realización de pagos en masa. Con esta herramienta, las empresas pueden gestionar pagos recurrentes sin la necesidad de integraciones complejas con APIs, simplificando el proceso de transacciones financieras. La funcionalidad permite generar y gestionar la recurrencia de los pagos al importar archivos .csv enviados a un servidor SFTP, haciendo que la gestión financiera sea más eficiente y simplificada. Mercado Pago procesa estos pagos a través de la multiadquirencia y devuelve un archivo que presenta el estado de cada pago realizado, proporcionando un control claro y detallado de las operaciones financieras. - media_image: /batch-payments/landing1.png - - highlight_countries: mla + - highlight_countries: mla, mlu, mlm, mlc, mco, mpe - country_title: Disponibilidad por país --- --- diff --git a/guides/batch-payments-vault-migration/landing.pt.md b/guides/batch-payments-vault-migration/landing.pt.md index 3c2265d2cf..4d2d9a91cf 100644 --- a/guides/batch-payments-vault-migration/landing.pt.md +++ b/guides/batch-payments-vault-migration/landing.pt.md @@ -9,7 +9,7 @@ content_section_with_media: - title: Batch Payments - message: Os Batch Payments do Mercado Pago são uma solução prática e segura para a realização de pagamentos em massa. Com esta ferramenta, as empresas podem gerenciar pagamentos recorrentes sem a necessidade de integrações complexas com APIs, simplificando o processo de transações financeiras. A funcionalidade permite gerar e gerenciar a recorrência dos pagamentos ao importar arquivos .csv enviados a um servidor SFTP, tornando a gestão financeira mais eficiente e simplificada. O Mercado Pago processa esses pagamentos através da multiadquirência e devolve um arquivo que apresenta o status de cada pagamento realizado, proporcionando um controle claro e detalhado das operações financeiras. - media_image: /batch-payments/landing1.png - - highlight_countries: mla + - highlight_countries: mla, mlu, mlm, mlc, mco, mpe - country_title: Disponibilidade por país --- --- diff --git a/guides/batch-payments-vault-migration/vault-migration/vault-landing.en.md b/guides/batch-payments-vault-migration/vault-migration/vault-landing.en.md index 7b8389ace5..be51b1ae98 100644 --- a/guides/batch-payments-vault-migration/vault-migration/vault-landing.en.md +++ b/guides/batch-payments-vault-migration/vault-migration/vault-landing.en.md @@ -9,6 +9,6 @@ content_section_with_media: - title: Vault Migration - message: Vault Migration is Mercado Pago's solution for tokenizing cards, ensuring the security of payer information and offering better approval of their payments. - media_image: /batch-payments/landing1.png - - highlight_countries: mla, mlu, mlm, mpe, mco, mlc + - highlight_countries: mla, mlb, mlu, mlm, mpe, mco, mlc - country_title: Availability by country --- \ No newline at end of file diff --git a/guides/batch-payments-vault-migration/vault-migration/vault-landing.es.md b/guides/batch-payments-vault-migration/vault-migration/vault-landing.es.md index d85ad2afb1..dd36218628 100644 --- a/guides/batch-payments-vault-migration/vault-migration/vault-landing.es.md +++ b/guides/batch-payments-vault-migration/vault-migration/vault-landing.es.md @@ -9,6 +9,6 @@ content_section_with_media: - title: Migración de bóvedas - message: La Migración de bóvedas és la solución de Mercado Pago para tokenizar tarjetas, garantizando la seguridad de la información de los pagadores y ofreciendo una mejor aprobación de sus pagos. - media_image: /batch-payments/landing1.png - - highlight_countries: mla, mlu, mlm, mpe, mco, mlc + - highlight_countries: mla, mlb, mlu, mlm, mpe, mco, mlc - country_title: Disponibilidad por país --- \ No newline at end of file diff --git a/guides/batch-payments-vault-migration/vault-migration/vault-landing.pt.md b/guides/batch-payments-vault-migration/vault-migration/vault-landing.pt.md index 6cd11ce07b..7fe9a5645f 100644 --- a/guides/batch-payments-vault-migration/vault-migration/vault-landing.pt.md +++ b/guides/batch-payments-vault-migration/vault-migration/vault-landing.pt.md @@ -9,6 +9,6 @@ content_section_with_media: - title: Migração de Cofres - message: A Migração de Cofres é a solução do Mercado Pago para tokenizar cartões, garantindo a segurança das informações dos pagadores e oferecendo uma melhor aprovação de seus pagamentos. - media_image: /batch-payments/landing1.png - - highlight_countries: mla, mlu, mlm, mpe, mco, mlc + - highlight_countries: mla, mlb, mlu, mlm, mpe, mco, mlc - country_title: Disponibilidade por país --- \ No newline at end of file From 6a4134ca529b3809a5dd6585b94f0a74638db3d9 Mon Sep 17 00:00:00 2001 From: Heitor Galdino Date: Fri, 31 Jan 2025 16:57:05 -0300 Subject: [PATCH 2/2] heits --- reference/api-json/use-case-example.json | 7431 ---------------------- 1 file changed, 7431 deletions(-) delete mode 100644 reference/api-json/use-case-example.json diff --git a/reference/api-json/use-case-example.json b/reference/api-json/use-case-example.json deleted file mode 100644 index 7d596376d5..0000000000 --- a/reference/api-json/use-case-example.json +++ /dev/null @@ -1,7431 +0,0 @@ -{ - "url": "https://api.mercadopago.com", - "paths": { - "/v1/payments": { - "post": { - "tags": [ - "checkout-pro", - "subscriptions", - "checkout-api", - "checkout-bricks" - ], - "description": { - "en": "Create a payment and add all the information you need. Remember to add the payment details and the payer's information", - "pt": "Crie um pagamento e acrescente todas as informações que você precisa. Certifique-se de acrescentar os detalhes do pagamento e os detalhes do cliente", - "es": "Realiza la creación de un pago y agrega toda la información que necesites. Ten en cuenta de sumar el detalle del pago y los datos del pagador" - }, - "parameters": [ - { - "in": "header", - "name": "X-Idempotency-Key", - "required": false, - "schema": { - "type": "string", - "example": "0d5020ed-1af6-469c-ae06-c3bec19954bb" - }, - "description": { - "en": "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 payments, 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. It is important to note that, starting from 01/01, sending this parameter will become mandatory in all requests.", - "pt": "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 dois pagamentos idênticos, 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. É importante salientar que, a partir de 01/01, o envio deste parâmetro passará a ser obrigatório em todas as requisições.", - "es": "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 pagos idénticos, 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. Es importante destacar que, a partir del 01/01, el envío de este parámetro se volverá obligatorio en todas las solicitudes." - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "additional_info": { - "type": "object", - "description": { - "en": "At Payments level, it's only data, and we only forward that information to other APIs like Risk, to perform scoring and prevent fraud, or to Tax, to determine them for international payments.", - "pt": "No nível de Pagamentos, são apenas dados e apenas encaminhamos essas informações para outras APIS, como Risco, para realizar pontuação e prevenir fraudes, para Impostos para determiná-los para pagamentos internacionais.", - "es": "En el nivel de Pagos, son solo datos y únicamente reenviamos esa información a otras API, como Riesgo, para realizar puntajes y prevenir fraudes, o a Impuestos, para determinarlos para pagos internacionales." - }, - "properties": { - "ip_address": { - "type": "string", - "description": { - "en": "Internal protocol (IP) that comes from the request (for bank transfer only).", - "pt": "Protocolo interno (IP) que provém do request (apenas para transferência bancária).", - "es": "Protocolo interno (IP) que proviene del request (solo para transferencia bancaria)." - } - }, - "items": { - "type": "array", - "description": { - "en": "List of items to be paid.", - "pt": "Lista de itens a pagar.", - "es": "Lista de ítems a pagar." - }, - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": { - "en": "It is the purchased product ad identifier. For example - “MLB2907679857”.", - "pt": "É o identificador do anúncio do produto comprado. Por exemplo - “MLB2907679857”.", - "es": "Es el identificador del anuncio del producto adquirido. Por ejemplo - “MLB2907679857”." - }, - "example": "MLB2907679857" - }, - "title": { - "type": "string", - "description": { - "en": "Item name.", - "pt": "Nome do item", - "es": "Nombre de ítem" - }, - "example": "Point Mini" - }, - "description": { - "type": "string", - "description": { - "en": "Long item description.", - "pt": "Descrição do artigo.", - "es": "Descripción de item." - }, - "example": "Point product for card payments via Bluetooth." - }, - "picture_url": { - "type": "string", - "description": { - "en": "Image URL.", - "pt": "URL da imagem.", - "es": "URL de imagen." - }, - "example": "https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium2x.png" - }, - "category_id": { - "type": "string", - "description": { - "en": "It is the category of the purchased item. It is possible to mention two main forms of category_id - categories inserted through a code, such as “MLB189908”, or those that are a tag, such as “phone”.", - "pt": "É a categoria do item que foi comprado. É possível citar duas formas principais de category_id - as categorias inseridas por meio de um código, como “MLB189908”, ou as que são uma tag, como “phone”.", - "es": "Es la categoría del ítem que se compró. Es posible citar dos formas principales de category_id - categorías insertadas a través de un código, como “MLB189908”, o aquellas que son una tag, como “phone”." - }, - "example": "electronics" - }, - "quantity": { - "type": "number", - "description": { - "en": "Item quantity. This parameter will return as an String.", - "pt": "Quantidade do produto. Este parâmetro será retornado como uma String.", - "es": "Cantidad de producto. Te devolveremos este parámetro como una String." - }, - "example": 1 - }, - "unit_price": { - "type": "number", - "description": { - "en": "Unit price of the purchased item. This parameter will return as an String.", - "pt": "Preço unitário do item comprado. Este parâmetro será retornado como uma String.", - "es": "Precio unitario del ítem comprado. Te devolveremos este parámetro como una String." - }, - "example": 58.8 - }, - "type": { - "type": "string", - "description": { - "en": "Type of item being sold", - "pt": "Tipo de item sendo vendido", - "es": "Tipo de ítem que se está vendiendo" - }, - "example": "electronics" - }, - "event_date": { - "type": "string", - "description": { - "en": "Event Date - Use the standard ISO 8601 format to input the date and time of the event. The format should be \"yyyy-MM-ddTHH:mm:ss.sssZ\". For example, to schedule an event for December 31, 2023, at 9:37:52 AM in the UTC-4 timezone, you would enter \"2023-12-31T09:37:52.000-04:00\".", - "pt": "Data do Evento - Utilize o formato padrão ISO 8601 para inserir a data e o horário do evento. O formato deve ser \"yyyy-MM-ddTHH:mm:ss.sssZ\". Por exemplo, para marcar um evento para o dia 31 de dezembro de 2023, às 9:37:52 AM, no fuso horário UTC-4, você deverá inserir - \"2023-12-31T09:37:52.000-04:00\".", - "es": "Fecha del Evento - Por favor, utilice el formato estándar ISO 8601 para introducir la fecha y hora del evento. El formato debe ser \"yyyy-MM-ddTHH:mm:ss.sssZ\". Por ejemplo, para programar un evento para el 31 de diciembre de 2023 a las 9:37:52 AM en la zona horaria UTC-4, deberá ingresar \"2023-12-31T09:37:52.000-04:00\"." - }, - "example": "2023-12-31T09:37:52.000-04:00" - }, - "warranty": { - "type": "boolean", - "description": { - "en": "Indicates if the product has warranty or not. True if it does, false if it doesn't.", - "pt": "Indica se o produto tem garantia ou não. True se tiver, false se não.", - "es": "Indica si el producto tiene garantía o no. True si tiene, false si no." - } - }, - "category_descriptor": { - "type": "object", - "properties": { - "passenger": { - "type": "object", - "properties": { - "first_name": { - "type": "string", - "description": { - "en": "Passenger's first name.", - "pt": "Primeiro nome do passageiro", - "es": "Nombre del pasajero" - } - }, - "last_name": { - "type": "string", - "description": { - "en": "Passenger's last name.", - "pt": "Sobrenome do passageiro", - "es": "Apellido del pasajero" - } - } - } - }, - "route": { - "type": "object", - "properties": { - "departure": { - "type": "string", - "description": { - "en": "Departure city.", - "pt": "Cidade de partida", - "es": "Ciudad de salida" - } - }, - "destination": { - "type": "string", - "description": { - "en": "Destination city.", - "pt": "Cidade de destino", - "es": "Ciudad de destino" - } - }, - "departure_date_time": { - "type": "string", - "description": { - "en": "Departure date and time. Valid format is as follows - \"yyyy-MM-ddTHH:mm:ss.sssZ\". Example - 2023-12-31T09:37:52.000-04:00.", - "pt": "Data e hora de partida. O formato válido é o seguinte - \"yyyy-MM-ddTHH:mm:ss.sssZ\". Exemplo - 2023-12-31T09:37:52.000-04:00.", - "es": "Fecha y hora de salida. El formato válido es el siguiente - \"yyyy-MM-ddTHH:mm:ss.sssZ\". Ejemplo - 2023-12-31T09:37:52.000-04:00." - } - }, - "arrival_date_time": { - "type": "string", - "description": { - "en": "Arrival date and time. Valid format is as follows - \"yyyy-MM-ddTHH:mm:ss.sssZ\". Example - 2023-12-31T09:37:52.000-04:00.", - "pt": "Data e hora de chegada. O formato válido é o seguinte - \"yyyy-MM-ddTHH:mm:ss.sssZ\". Exemplo - 2023-12-31T09:37:52.000-04:00.", - "es": "Fecha y hora de llegada. El formato válido es el siguiente - \"yyyy-MM-ddTHH:mm:ss.sssZ\". Ejemplo - 2023-12-31T09:37:52.000-04:00." - } - }, - "company": { - "type": "string", - "description": { - "en": "Company name.", - "pt": "Nome da empresa", - "es": "Nombre de la empresa" - } - } - } - } - } - } - } - } - }, - "payer": { - "type": "object", - "description": { - "en": "The payer is the one who makes the payment. This field is an object that has the payer's information.", - "pt": "O payer é aquele que faz o pagamento. Este campo é um objeto que possui as informações do pagador.", - "es": "El payer es quien realiza el pago. Este campo es un objeto que tiene la información del pagador." - }, - "required": true, - "properties": { - "first_name": { - "type": "string", - "description": { - "en": "Buyer's name.", - "pt": "Nome do comprador", - "es": "Nombre del comprador" - }, - "example": "Test" - }, - "last_name": { - "type": "string", - "description": { - "en": "It's the buyer's last name field.", - "pt": "É o campo do sobrenome do comprador.", - "es": "Es el campo de apellido del comprador." - }, - "example": "Test" - }, - "phone": { - "type": "object", - "description": { - "en": "Buyer's phone.", - "pt": "Telefone do comprador", - "es": "Teléfono del comprador" - }, - "properties": { - "area_code": { - "type": "string", - "description": { - "en": "Area code where the buyer resides.", - "pt": "Código de área onde reside o comprador.", - "es": "Código de área donde reside el comprador." - }, - "example": 11 - }, - "number": { - "type": "string", - "description": { - "en": "Buyer's fone number", - "pt": "Número de telefone do comprador.", - "es": "Número telefónico del comprador." - }, - "example": "987654321" - } - } - }, - "address": { - "type": "object", - "description": { - "en": "Buyer's address.", - "pt": "Endereço do comprador.", - "es": "Dirección del comprador." - }, - "properties": { - "zip_code": { - "type": "string", - "description": { - "en": "Buyer's zip code.", - "pt": "Código postal do comprador.", - "es": "Código postal del comprador." - } - }, - "street_name": { - "type": "string", - "description": { - "en": "Street where the buyer lives.", - "pt": "Rua onde mora o comprador.", - "es": "Calle donde vive el comprador." - } - }, - "street_number": { - "type": "number", - "description": { - "en": "Number of the property where the buyer lives.", - "pt": "Número do imóvel onde mora o comprador.", - "es": "Número de la propiedad donde vive el comprador." - } - } - } - }, - "registration_date": { - "type": "string", - "format": "date", - "description": { - "en": "Date of registration of the buyer (payer) on your website. The valid format of the attribute is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex - 2021-06-15T19:22:41.001-03:00.", - "pt": "Data de cadastro do comprador (payer) em seu site. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex - 2021-06-15T19:22:41.001-03:00.", - "es": "Fecha de registro del comprador (payer) en tu sitio web. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Ej - 2021-06-15T19:22:41.001-03:00." - } - }, - "is_prime_user": { - "type": "string", - "description": { - "en": "Indicates if the payer is a premium user. Valid values are as follows - \"1\" if it is, \"0\" if it isn't.", - "pt": "Indica se o pagador é um usuário premium. Os valores válidos são os seguintes - \"1\" se for, \"0\" se não for.", - "es": "Indica si el pagador es un usuario premium. Los valores válidos son los siguientes - \"1\" si lo es, \"0\" si no lo es." - } - }, - "is_first_purchase_online": { - "type": "string", - "description": { - "en": "Indicates if the payer has made a purchase on your website before. Valid values are as follows - \"1\" if it is, \"0\" if it isn't.", - "pt": "Indica se o pagador já realizou uma compra em seu site anteriormente. Os valores válidos são os seguintes - \"1\" se for, \"0\" se não for.", - "es": "Indica si el pagador ha realizado una compra en tu sitio web anteriormente. Los valores válidos son los siguientes - \"1\" si lo es, \"0\" si no lo es." - } - }, - "last_purchase": { - "type": "string", - "description": { - "en": "Date of the last purchase made by the payer on your website. The valid format of the attribute is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex - 2021-06-15T19:22:41.001-03:00.", - "pt": "Data da última compra realizada pelo pagador em seu site. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex - 2021-06-15T19:22:41.001-03:00.", - "es": "Fecha de la última compra realizada por el pagador en tu sitio web. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Ej - 2021-06-15T19:22:41.001-03:00." - } - }, - "authentication_type": { - "type": "string", - "description": { - "en": "Type of authentication used by payer", - "pt": "Tipo de autenticação utilizada pelo pagador", - "es": "Tipo de autenticación utilizada por el pagador" - }, - "enum": [ - { - "title": "Gmail", - "description": { - "en": "Authentication via Gmail", - "es": "Authentication via Gmail", - "pt": "Authentication via Gmail" - } - }, - { - "title": "Facebook", - "description": { - "en": "Authentication via Facebook login", - "es": "Authentication via Facebook login", - "pt": "Authentication via Facebook login" - } - }, - { - "title": "Native web", - "description": { - "en": "Authentication via web application", - "es": "Authentication via web application", - "pt": "Authentication via web application" - } - }, - { - "title": "Other", - "description": { - "en": "Other type of identification", - "es": "Other type of identification", - "pt": "Other type of identification" - } - } - ] - } - } - }, - "shipments": { - "type": "object", - "description": { - "en": "Object containing all the information for shipping the customer's purchase.", - "pt": "Objeto que compreende todas as informações para o envio da compra do cliente.", - "es": "Objeto que comprende toda la información para el envío de la compra del cliente." - }, - "properties": { - "receiver_address": { - "type": "object", - "description": { - "en": "Object comprising the address of the receiver of the purchase.", - "pt": "Objeto que compreende o endereço do destinatário da compra.", - "es": "Objeto que comprende la dirección del destinatario de la compra." - }, - "properties": { - "zip_code": { - "type": "string", - "description": { - "en": "Zip code.", - "pt": "Código postal", - "es": "Código postal" - }, - "example": "12312-123" - }, - "state_name": { - "type": "string", - "description": { - "en": "State.", - "pt": "Província", - "es": "Provincia" - }, - "example": "Rio de Janeiro" - }, - "city_name": { - "type": "string", - "description": { - "en": "City Name.", - "pt": "Cidade", - "es": "Ciudad" - }, - "example": "Buzios" - }, - "street_name": { - "type": "string", - "description": { - "en": "Street name.", - "pt": "Rua", - "es": "Calle" - }, - "example": "Av das Nacoes Unidas" - }, - "street_number": { - "type": "number", - "description": { - "en": "Number.", - "pt": "Número", - "es": "Número" - }, - "example": 3003 - }, - "floor": { - "type": "string", - "description": { - "en": "Delivery address floor.", - "pt": "Andar do endereço de entrega.", - "es": "Piso de la dirección de entrega" - } - }, - "apartment": { - "type": "string", - "description": { - "en": "Delivery address apartment number.", - "pt": "Número do apartamento do endereço de entrega.", - "es": "Número de departamento de la dirección de entrega." - } - } - } - }, - "width": { - "type": "number", - "description": { - "en": "Width of barcode.", - "pt": "Largura do código de barras", - "es": "Ancho del código de barras" - } - }, - "height": { - "type": "number", - "description": { - "en": "Height of barcode.", - "pt": "Altura do código de barras", - "es": "Altura del código de barras" - } - }, - "express_shipment": { - "type": "string", - "description": { - "en": "Indicates if the shipment is express or not. Valid values are as follows - \"1\" if it is, \"0\" if it isn't.", - "pt": "Indica se o envio é expresso ou não. Os valores válidos são os seguintes - \"1\" se for, \"0\" se não for.", - "es": "Indica si el envío es express o no. Los valores válidos son los siguientes - \"1\" si lo es, \"0\" si no lo es." - } - }, - "pick_up_on_seller": { - "type": "string", - "description": { - "en": "Indicates if the customer will pick up the product at the seller's address. Valid values are as follows - \"1\" if it is, \"0\" if it isn't.", - "pt": "Indica se o cliente irá retirar o produto no endereço do vendedor. Os valores válidos são os seguintes - \"1\" se for, \"0\" se não for.", - "es": "Indica si el cliente recogerá el producto en la dirección del vendedor. Los valores válidos son los siguientes - \"1\" si lo es, \"0\" si no lo es." - } - } - } - } - } - }, - "application_fee": { - "type": "number", - "description": { - "en": "Commission (fee) that third parties (integrators) charge their customers, in this case, sellers, for using the marketplace platform and other services. This is a value in reais to be defined by the integrator to the seller.", - "pt": "Comissão (taxa) que terceiros (integradores) cobram de seus clientes, neste caso, vendedores, pelo uso da plataforma do marketplace e de outros serviços. Esse é um valor em reais a ser definido pelo integrador ao vendedor.", - "es": "Comisión (fee) que los terceros (integradores) cobran a sus clientes, en este caso vendedores, por utilizar la plataforma del marketplace y otros servicios. Este es un valor en reales que será definido por el integrador para el vendedor." - } - }, - "binary_mode": { - "type": "boolean", - "description": { - "en": "When set to TRUE, payments can only be approved or rejected. Otherwise they can also result in_process.", - "pt": "Quando definido como TRUE, os pagamentos só podem ser aprovados ou rejeitados. Caso contrário, eles também podem resultar in_process.", - "es": "Cuando se configura como TRUE los pagos sólo pueden resultar aprobados o rechazados. Caso contrario también pueden resultar in_process." - } - }, - "callback_url": { - "type": "string", - "description": { - "en": "URL where mercadopago does the final redirect (only for bank transfers).", - "pt": "URL para a qual o Mercado Pago faz o redirecionamento final (apenas para transferência bancária).", - "es": "URL a la cual Mercado Pago hace la redirección final (sólo para transferencia bancaria)." - } - }, - "campaign_id": { - "type": "number", - "description": { - "en": "It is the identifier of the entity that models the nature of discounts. All coupons come from a single campaign. The campaign configures, among other things, the available budget balance, dates between which coupons can be used, rules for coupon application. It's the discount promise.", - "pt": "É o identificador da entidade que modela a natureza dos descontos. Todos os cupons vêm de uma única campanha. A campanha configura, entre outras coisas, o saldo orçamentário disponível, datas entre as quais os cupons podem ser utilizados, regras para aplicação de cupom, entre outros. É a promessa de desconto.", - "es": "Es el identificador de la entidad que modela la fuente de los descuentos. Todos los cupones provienen de una sola campaña. La campaña configura, entre otras cosas, el saldo presupuestario disponible, fechas entre las cuales se pueden utilizar los cupones, reglas para la aplicación de los mismos, etc. Es la promesa de descuento." - } - }, - "capture": { - "type": "boolean", - "description": { - "en": "It is a boolean field found in two-step payments (like debit card). In this type of payment, which is carried out asynchronously, the purchase value is first reserved (capture = false). This amount is captured and not debited from the account instantly. When the money is actually transferred to the collector (who receives the payment) the amount is captured (capture = true).", - "pt": "É um campo booleano existente em pagamentos de duas etapas (como o cartão de débito). Nesse tipo de pagamento, que é realizado de modo assíncrono, primeiro é feito a reserva do valor da compra (capture = false). Esse valor é capturado e não é debitado da conta instantaneamente. Quando o dinheiro é de fato transferido ao collector (quem recebe o pagamento) a captura do montante é feita (capture = true).", - "es": "Es un campo booleano que se encuentra en pagos de dos pasos (como tarjeta de débito). En este tipo de pago, que se realiza de forma asíncrona, primero se reserva el valor de la compra (capture = false). Esta cantidad se captura y no se debita de la cuenta al instante. Cuando el dinero se transfiere realmente al cobrador (que recibe el pago), se captura la cantidad (capture = true)." - } - }, - "coupon_amount": { - "type": "number", - "description": { - "en": "It is the value of the discount coupon. E.g. - BRL 14.50. The attribute's type is BigDecimal.", - "pt": "É o valor do cupom de desconto. Por exemplo - R$14,50. O tipo do atributo é BigDecimal.", - "es": "Es el valor del cupón de descuento. Por ejemplo - BRL 14,50. El tipo del atributo es BigDecimal." - } - }, - "coupon_code": { - "type": "string", - "description": { - "en": "Discount campaign with a specific code.", - "pt": "Campanha de desconto com um código específico", - "es": "Campaña de descuento con un código específico" - } - }, - "description": { - "type": "string", - "description": { - "en": "Purchased product’s description, the reason for payment. E.g. - \"Xiaomi Redmi Note 11S mobile phone 128gb 6gb Ram Original Global Blue Version\" (description of a product in the marketplace).", - "pt": "Descrição do produto comprado, a razão de pagamento. Por exemplo - \"Celular Xiaomi Redmi Note 11S 128gb 6gb Ram Versão Global Original azul\" (descrição de um produto no marketplace).", - "es": "Descripción del producto adquirido, el motivo del pago. Ej. - \"Celular Xiaomi Redmi Note 11S 128gb 6gb Ram Original Global Blue Version\" (descripción de un producto en el marketplace)." - }, - "example": "Payment for product", - "required": true - }, - "differential_pricing_id": { - "type": "number", - "description": { - "en": "Attribute that commonly contains an agreement on how much the user will be charged (generally, this field is more relevant for Marketplace payments). Pricing and fees are calculated based on this identifier.", - "pt": "Atributo que comumente contém um acordo de quanto vai ser cobrado do usuário (geralmente, este campo é mais relevante para pagamentos do Marketplace). A precificação e as taxas são calculadas com base nesse identificador.", - "es": "Atributo que comúnmente contiene un acuerdo sobre cuánto se le cobrará al usuario (generalmente, este campo es más relevante para los pagos de Marketplace). Los precios y las tarifas se calculan en función de este identificador." - } - }, - "date_of_expiration": { - "type": "string", - "format": "date", - "description": { - "en": "Payment’s expiration date. The valid format of the attribute is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex - 2022-11-17T09:37:52.000-04:00.", - "pt": "Data de expiração do pagamento. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Por exemplo - 2022-11-17T09:37:52.000-04:00.", - "es": "Fecha de vencimiento del pago. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Ej - 2022-11-17T09:37:52.000-04:00." - } - }, - "external_reference": { - "type": "string", - "description": { - "en": "It is a payment external reference. It could be, for example, a hashcode from the Central Bank, working as a transaction origin identifier.", - "pt": "É uma referência externa do pagamento. Pode ser, por exemplo, um hashcode do Banco Central, funcionando como identificador de origem da transação.", - "es": "Es una referencia de pago externa. Podría ser, por ejemplo, un hashcode del Banco Central, funcionando como identificador del origen de la transacción." - }, - "example": "MP0001" - }, - "installments": { - "type": "number", - "description": { - "en": "Number of installments selected.", - "pt": "Número de parcelas selecionado", - "es": "Cantidad seleccionada de cuotas" - }, - "required": true, - "example": 1 - }, - "issuer_id": { - "type": "string", - "description": { - "en": "It is the identifier of the card issuer being used in a credit or debit card payment.", - "pt": "É o identificador do emissor do cartão que está sendo utilizado em um pagamento com cartão de crédito ou débito.", - "es": "Es el identificador del emisor de la tarjeta que se utiliza en un pago con tarjeta de crédito o débito." - }, - "required": true - }, - "metadata": { - "type": "object", - "description": { - "en": "This is an optional key-value object where the customer can add additional information that needs to be recorded at checkout. Ex - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}", - "pt": "Este é um objeto opcional do tipo chave-valor no qual o cliente pode adicionar informações adicionais que precisam ser registradas no pagamento. Ex - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}", - "es": "Este es un objeto clave-valor opcional en el que el cliente puede agregar información adicional que debe registrarse al finalizar la compra. Por ejemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}" - } - }, - "notification_url": { - "type": "string", - "description": { - "en": "Notifications URL available to receive notifications of events related to Payment. The maximum number of characters allowed for submission in this parameter is 248 characters.", - "pt": "URL de notificações disponível para receber notificações de eventos relacionados ao Pagamento. A quantidade máxima de caracteres permitidos para envio neste parâmetro é de 248 caracteres.", - "es": "URL de Notificaciones disponibilizada para recibir las notificaciones de los eventos relacionados al Pago. La cantidad máxima de caracteres permitidos para enviar en este parámetro es de 248 caracteres." - } - }, - "payer": { - "type": "object", - "description": { - "en": "Identifies the buyer.", - "pt": "Id do pagador", - "es": "Identificador del pagador" - }, - "required": true, - "properties": { - "entity_type": { - "$ref": "#/components/schemas/entity_type" - }, - "type": { - "$ref": "#/components/schemas/payer_type" - }, - "id": { - "type": "string", - "description": { - "en": "Identification of the associated payer.", - "pt": "Identificação do pagador associado", - "es": "Identificación del pagador asociado" - } - }, - "email": { - "type": "string", - "description": { - "en": "Email associated with the payer. This value will only return a response when status=approved, status=refunded, or status=charged_back.", - "pt": "Email associado ao payer. Este valor só retornará uma resposta quando status=approved, status=refunded ou status=charged_back.", - "es": "Correo electrónico asociado al payer. Este valor sólo devolverá una respuesta cuando status=approved, status=refunded o status=charged_back." - }, - "example": "test_user_123@testuser.com", - "required": true - }, - "identification": { - "type": "object", - "description": { - "en": "User's personal identification. As an example, in Brazil, there is the CPF (Individual Taxpayer Registry) and the CNPJ (National Corporate Taxpayer Registry), for companies. Other possible identification codes are CURP (Mexico), CUIL (Argentina). This object will only return a response when status=approved, status=refunded or status=charged_back.", - "pt": "Identificação pessoal do usuário. Como exemplo, a nível Brasil, temos o CPF (Cadastro de Pessoa Física) e o CNPJ (Cadastro Nacional de Pessoas Jurídicas), para empresas. Outros códigos de identificação possíveis são o CURP (México), CUIL (Argentina), Este objeto só retornará uma response quando status=approved, status=refunded or status=charged_back.", - "es": "Identificación personal del usuario. Como ejemplo, en Brasil, existe el CPF (Registro de Contribuyentes Individuales) y el CNPJ (Registro Nacional de Personas Jurídicas) para empresas. Otros posibles códigos de identificación son CURP (México), CUIL (Argentina). Este objeto sólo devolverá una respuesta cuando status=approved, status=refunded or status=charged_back." - }, - "properties": { - "type": { - "type": "string", - "description": { - "en": "Refers to the type of identification. It can be one of the following types.", - "pt": "Refere-se ao tipo de identificação. Pode ser dos seguintes tipos.", - "es": "Se refiere al tipo de identificación. Puede ser de los siguientes tipos." - }, - "enum": [ - { - "title": "CPF", - "description": { - "en": "Individual Taxpayer Registration, Brazil.", - "es": "Individual Taxpayer Registration, Brazil.", - "pt": "Individual Taxpayer Registration, Brazil." - } - }, - { - "title": "CNPJ", - "description": { - "en": "National Register of Legal Entities, Brazil.", - "es": "National Register of Legal Entities, Brazil.", - "pt": "National Register of Legal Entities, Brazil." - } - }, - { - "title": "CUIT", - "description": { - "en": "Unique Tax Identification Code, Argentina.", - "es": "Unique Tax Identification Code, Argentina.", - "pt": "Unique Tax Identification Code, Argentina." - } - }, - { - "title": "CUIL", - "description": { - "en": "Unique Labor Identification Code, Argentina.", - "es": "Unique Labor Identification Code, Argentina.", - "pt": "Unique Labor Identification Code, Argentina." - } - }, - { - "title": "DNI", - "description": { - "en": "National Identity Document, Argentina.", - "es": "National Identity Document, Argentina.", - "pt": "National Identity Document, Argentina." - } - }, - { - "title": "CURP", - "description": { - "en": "Single Population Registration Code, Mexico.", - "es": "Single Population Registration Code, Mexico.", - "pt": "Single Population Registration Code, Mexico." - } - }, - { - "title": "RFC", - "description": { - "en": "Federal Registry of Taxpayers, Mexico.", - "es": "Federal Registry of Taxpayers, Mexico.", - "pt": "Federal Registry of Taxpayers, Mexico." - } - }, - { - "title": "CC", - "description": { - "en": "Citizenship Card, Colombia.", - "es": "Citizenship Card, Colombia.", - "pt": "Citizenship Card, Colombia." - } - }, - { - "title": "RUT", - "description": { - "en": "Single Tax List, Chile.", - "es": "Single Tax List, Chile.", - "pt": "Single Tax List, Chile." - } - }, - { - "title": "CI", - "description": { - "en": "Identity Card, Uruguay.", - "es": "Identity Card, Uruguay.", - "pt": "Identity Card, Uruguay." - } - } - ], - "example": "CPF" - }, - "number": { - "type": "string", - "description": { - "en": "The number refers to the identifier of the user in question. If it is a CPF, for example, it will have 11 numbers.", - "pt": "O número se refere ao identificador do usuário em questão. Se for um CPF, por exemplo, terá 11 números.", - "es": "El número hace referencia al identificador del usuario en cuestión. Si es un CPF, por ejemplo, tendrá 11 números." - }, - "example": "95749019047" - } - } - }, - "first_name": { - "type": "string", - "description": { - "en": "First name of the associated payer.", - "pt": "Nome do pagador associado", - "es": "Nombre del pagador asociado" - } - }, - "last_name": { - "type": "string", - "description": { - "en": "Last name of the associated payer.", - "pt": "Sobrenome do pagante associado", - "es": "Apellido del pagador asociado" - } - } - } - }, - "payment_method_id": { - "type": "string", - "description": { - "en": "It indicates the identifier of the payment method selected to make the transaction. Here are some examples. Get all available payment methods by consulting the 'Get payment Methods API'.", - "pt": "Indica o identificador do meio de pagamento selecionado para efetuar o pagamento. A seguir, apresentamos alguns exemplos. Obtenha todos os meios de pagamento disponíveis consultando a API de 'Obter meios de pagamento'.", - "es": "Identificador del medio de pago. Indica el ID del medio de pago seleccionado para realizar el pago. A continuación presentamos algunos ejemplos. Obtén todos los métodos de pago disponibles consultando la API de 'Obtener métodos de pago'." - }, - "enum": [ - { - "title": "Pix", - "description": { - "en": "Instant digital payment method used in Brazil.", - "es": "Instant digital payment method used in Brazil.", - "pt": "Instant digital payment method used in Brazil." - } - }, - { - "title": "Account_money", - "description": { - "en": "When the payment is debited directly from a Mercado Pago account.", - "es": "When the payment is debited directly from a Mercado Pago account.", - "pt": "When the payment is debited directly from a Mercado Pago account." - } - }, - { - "title": "Debin_transfer", - "description": { - "en": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization.", - "es": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization.", - "pt": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization." - } - }, - { - "title": "Ted", - "description": { - "en": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;", - "es": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;", - "pt": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;" - } - }, - { - "title": "Cvu", - "description": { - "en": "Payment method used in Argentina.", - "es": "Payment method used in Argentina.", - "pt": "Payment method used in Argentina." - } - } - ], - "required": true, - "example": "master" - }, - "statement_descriptor": { - "type": "string", - "description": { - "en": "Description that the payment will appear with in the card statement (eg MERCADOPAGO)", - "pt": "Descrição com a qual o pagamento aparecerá no resumo do cartão (ex. MERCADOPAGO)", - "es": "Descripción con la que aparecerá el pago en el resumen de tarjeta (ej. MERCADOPAGO)" - } - }, - "token": { - "type": "string", - "description": { - "en": "Token card identifier (mandatory for credit card). The card token is created from the card's own information, increasing security during the payment flow. In addition, once the token is used in a given purchase, it is discarded, requiring the creation of a new token for future purchases.", - "pt": "Identificador de token card (obrigatório para cartão de crédito). O token do cartão é criado a partir das próprias informações do cartão, aumentando a segurança durante o fluxo do pagamento. Além disso, uma vez que o token é utilizado em determinada compra, ele é descartado, sendo necessária a criação de um novo token para compras futuras.", - "es": "Identificador del token card. (obligatorio para tarjeta de crédito). El token de la tarjeta se crea a partir de la información de la propia tarjeta, aumentando la seguridad durante el flujo de pago. Además, una vez que el token se usa en una compra determinada, se descarta, lo que requiere la creación de un nuevo token para futuras compras." - }, - "required": true, - "example": "ff8080814c11e237014c1ff593b57b4d" - }, - "transaction_amount": { - "type": "number", - "description": { - "en": "Product’s cost. Example - The sale of a product for R$100.00 will have a transactionAmount = 100.", - "pt": "Custo do produto. Exemplo - A venda de um produto por R$100,00 terá um transactionAmount = 100.", - "es": "Costo del producto. Ejemplo - La venta de un producto por R$ 100,00 tendrá un transactionAmount = 100." - }, - "required": true, - "example": 58.8 - } - } - } - } - } - }, - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Success", - "en": "Success" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 20359978, - "description": { - "en": "Unique Payment Identifier, automatically generated by Mercado Pago", - "pt": "Identificador único de pagamento, gerado automaticamente pelo Mercado Pago", - "es": "Identificador único del pago, generado automáticamente por Mercado Pago" - } - }, - "date_created": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Payment creation date.", - "pt": "Data de criação do pagamento.", - "es": "Fecha de creación del Pago." - } - }, - "date_approved": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Payment approval date. A payment can be generated in an intermediate state and then approved, so the creation date will not always coincide with the Approval Date.", - "pt": "Data de aprovação do pagamento. Um pagamento pode ser gerado em um estado intermediário e depois aprovado, portanto, a data de criação nem sempre coincidirá com a Data de Aprovação.", - "es": "Fecha de aprobación del Pago. Un pago puede generarse en un estado intermedio y luego ser aprobado, por tanto la fecha de creación no siempre coincidirá con la Fecha de Aprobación." - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Date on which the last payment event was recorded.", - "pt": "Data em que o último evento de pagamento foi registrado.", - "es": "Fecha en la que se registró el ultimo evento sobre el pago." - } - }, - "date_of_expiration": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment’s expiration date. The attribute’s valid format is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "pt": "Data de expiração do pagamento. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "es": "Fecha de vencimiento del pago. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Ej. - 2022-11-17T09:37:52.000-04:00." - } - }, - "money_release_date": { - "type": "string", - "example": "2019-07-24T14:47:58.000Z", - "description": { - "en": "Date on which the payment is settled and the money is made available in the Mercado Pago account of the Collector (the one who receives the payment). The field can take on the values “pending” or “released”, where the first indicates that the payment has not yet been released (money held for a period) and “released” means that the money has already been released to the user's available balance.", - "pt": "Data em que o pagamento é liquidado e o dinheiro é disponibilizado na conta Mercado Pago do Collector (aquele que recebe o pagamento). O campo pode assumir os valores “pending” ou “released”, sendo que o primeiro indica que o pagamento ainda não foi liberado (dinheiro retido por tempo) e “released” significa que o dinheiro já foi liberado para o saldo disponível do usuário.", - "es": "Fecha en que se liquida el pago y se pone a disposición el dinero en la cuenta de Mercado Pago del Collector (el que recibe el pago). El campo puede tomar los valores “pending” o “released”, siendo que el primero indica que el pago todavía no fue liberado (dinero retenido por tiempo) y “released” significa que el dinero ya fue liberado al disponible del usuario." - } - }, - "operation_type": { - "$ref": "#/components/schemas/operation_type" - }, - "issuer_id": { - "type": "string", - "example": 25, - "description": { - "en": "It is the identifier of the card issuer that’s being used in a credit or debit card payment.", - "pt": "É o identificador do emissor do cartão que está sendo utilizado em um pagamento com cartão de crédito ou débito.", - "es": "Es el identificador del emisor de la tarjeta que se utiliza en un pago con tarjeta de crédito o débito." - } - }, - "payment_method_id": { - "type": "string", - "example": "visa", - "description": { - "en": "Payment method identifier. Indicates the ID of the payment method selected to make the payment.", - "pt": "Id do meio de pagamento. Indica o ID do meio de pagamento selecionado para efetuar o pagamento.", - "es": "Identificador del medio de pago. Indica el ID del medio de pago seleccionado para realizar el pago." - } - }, - "payment_type_id": { - "$ref": "#/components/schemas/payment_type_id" - }, - "status": { - "$ref": "#/components/schemas/status" - }, - "status_detail": { - "type": "string", - "example": "accredited", - "description": { - "en": "Detail in which the Collection resulted", - "pt": "Detalhe em que resultou a Coleção", - "es": "Detalle en el que resultó el Cobro" - }, - "enum": [ - { - "title": "Accredited", - "description": { - "en": "credited payment.", - "es": "credited payment.", - "pt": "credited payment." - } - }, - { - "title": "pending_contingency", - "description": { - "en": "the payment is being processed.", - "es": "the payment is being processed.", - "pt": "the payment is being processed." - } - }, - { - "title": "pending_review_manual", - "description": { - "en": "the payment is under review to determine its approval or rejection.", - "es": "the payment is under review to determine its approval or rejection.", - "pt": "the payment is under review to determine its approval or rejection." - } - }, - { - "title": "cc_rejected_bad_filled_date", - "description": { - "en": "incorrect expiration date.", - "es": "incorrect expiration date.", - "pt": "incorrect expiration date." - } - }, - { - "title": "cc_rejected_bad_filled_other", - "description": { - "en": "incorrect card details.", - "es": "incorrect card details.", - "pt": "incorrect card details." - } - }, - { - "title": "cc_rejected_bad_filled_security_code", - "description": { - "en": "incorrect CVV.", - "es": "incorrect CVV.", - "pt": "incorrect CVV." - } - }, - { - "title": "cc_rejected_blacklist", - "description": { - "en": "the card is on a black list for theft/complaints/fraud.", - "es": "the card is on a black list for theft/complaints/fraud.", - "pt": "the card is on a black list for theft/complaints/fraud." - } - }, - { - "title": "cc_rejected_call_for_authorize", - "description": { - "en": "the means of payment requires prior authorization of the amount of the operation.", - "es": "the means of payment requires prior authorization of the amount of the operation.", - "pt": "the means of payment requires prior authorization of the amount of the operation." - } - }, - { - "title": "cc_rejected_card_disabled", - "description": { - "en": "the card is inactive.", - "es": "the card is inactive.", - "pt": "the card is inactive." - } - }, - { - "title": "cc_rejected_duplicated_payment", - "description": { - "en": "transacción duplicada.", - "es": "transacción duplicada.", - "pt": "transacción duplicada." - } - }, - { - "title": "cc_rejected_high_risk", - "description": { - "en": "rechazo por Prevención de Fraude.", - "es": "rechazo por Prevención de Fraude.", - "pt": "rechazo por Prevención de Fraude." - } - }, - { - "title": "cc_rejected_insufficient_amount", - "description": { - "en": "insufficient amount.", - "es": "insufficient amount.", - "pt": "insufficient amount." - } - }, - { - "title": "cc_rejected_invalid_installments", - "description": { - "en": "invalid number of installments.", - "es": "invalid number of installments.", - "pt": "invalid number of installments." - } - }, - { - "title": "cc_rejected_max_attempts", - "description": { - "en": "exceeded maximum number of attempts.", - "es": "exceeded maximum number of attempts.", - "pt": "exceeded maximum number of attempts." - } - }, - { - "title": "cc_rejected_other_reason", - "description": { - "en": "generic error.", - "es": "generic error.", - "pt": "generic error." - } - } - ] - }, - "currency_id": { - "$ref": "#/components/schemas/currency_id" - }, - "description": { - "type": "string", - "example": "Point Mini a maquininha que dá o dinheiro de suas vendas na hora.", - "description": { - "en": "Description sent in the payment creation request. Ex. - In a pix payment, the description is “Payment of Installments without card”. In another cases, such as a purchase in a physical store where the customer uses the machine to pay, we can find the description “Sale in person”. In marketplace purchases, the purchase description usually corresponds to a purchased product - “Pendrive Multilaser Twist Pd590 64gb 2.0 Black And Silver + 1 product”.", - "pt": "Descrição enviada na solicitação de criação de pagamento. Por exemplo - Em um pagamento pix, há a descrição “Pagamento de parcelas de Linha de Crédito”. Em outro caso, uma compra em loja física onde o cliente utiliza a maquininha para pagar, podemos encontrar a descrição - “Venda presencial”. Já em compras do marketplace, a descrição da compra geralmente corresponde a um produto comprado - “ Pendrive Multilaser Twist Pd590 64gb 2.0 Preto E Prateado + 1 produto”.", - "es": "Descripción enviada en el request de creación de pago. Por ejemplo - En un pago con pix, se encuentra la descripción “Pagos sin Tarjeta”. En otro caso, una compra en una tienda física donde el cliente utiliza la máquina para pagar, podemos encontrar la descripción “Venta en persona”. En las compras en marketplace, la descripción de compra suele corresponder a un producto comprado - “Pendrive Multilaser Twist Pd590 64gb 2.0 Negro Y Plata + 1 producto”." - } - }, - "live_mode": { - "type": "boolean", - "description": { - "en": "Indicates whether the Payment was made in a production environment or in a Test environment. If TRUE, then the chargeback will be processed in production mode. If FALSE, then the chargeback will be processed in sandbox mode.", - "pt": "Indica se o Pagamento foi feito em ambiente de produção ou em ambiente de Teste. Se TRUE, o estorno será processado em modo de produção. Se FALSE, o estorno será processado no modo sandbox.", - "es": "Indica si el Pago se realizó en ambiente productivo o en un ambiente de Test. Si es TRUE, el contracargo se procesará en modo de producción. Si es FALSE, el contracargo se procesará en modo sandbox." - } - }, - "sponsor_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is deprecated and no longer in use.", - "pt": "Este campo está deprecado e não é mais utilizado.", - "es": "Este campo está deprecado y ya no se usa." - } - }, - "authorization_code": { - "type": "string", - "format": "nullable", - "description": { - "en": "Transaction’s authorization code for payments with “payment_method_type” of type “credit_card” (credit card), “debit_card” (debit card) and “voucher_card” (voucher card for benefits, such as Alelo). In summary, this code is used for card transactions. The code is numerical and has 6 digits.", - "pt": "Código de autorização de transação para pagamentos com “payment_method_type” do tipo “credit_card” (cartão de crédito), “debit_card” (cartão de crédito) e “voucher_card” (cartão de voucher para benefícios, como Alelo). Em síntese, este código é utilizado para transações com cartão. O código é numérico e possui 6 dígitos.", - "es": "Código de autorización de transacción para pagos con “payment_method_type” de tipo “credit_card” (tarjeta de crédito), “debit_card” (tarjeta de débito) y “voucher_card” (tarjeta de bono para beneficios, como Alelo). En resumen, este código se utiliza para transacciones con tarjeta. Es numérico y tiene 6 dígitos." - } - }, - "money_release_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is used to identify whether a payment is PNF (Payment in Flow). Payment in flow is a form of cash release in which the installments received by a seller are released over the months (which corresponds to the number of installments). Possible values ​​for this field are “null” or “payment_in_flow”.", - "pt": "Esse campo é usado para identificar se um pagamento é PNF (pagamento no fluxo). Pagamento no fluxo é uma forma de liberação de dinheiro em que as parcelas recebidas por um vendedor são liberadas com o passar dos meses (que corresponde ao número de parcelas). Os valores possíveis para este campo são “null” ou “payment_in_flow”.", - "es": "Este campo se utiliza para identificar si un pago es PNF (Pay in Flow). El pago en flujo es una forma de liberación de dinero en la que las cuotas recibidas por un vendedor se van liberando a lo largo de los meses (lo que corresponde al número de cuotas). Los valores posibles para este campo son \"null\" o \"payment_in_flow\"." - } - }, - "taxes_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Corresponds to the tax values ​​calculated for the payment.", - "pt": "Corresponde aos valores dos impostos calculados para o pagamento.", - "es": "Corresponde a los valores de impuestos calculados para el pago." - } - }, - "counter_currency": { - "type": "string", - "format": "nullable", - "description": { - "en": "Basically, it is an object that will allow you to convert payments of CBT type (Cross Border Trade) into dollars, which are international payments made in a foreign currency.", - "pt": "Basicamente, é um objeto que permitirá converter em dólares pagamentos do tipo CBT (Cross Border Trade), que são pagamentos internacionais, feitos em moeda estrangeira.", - "es": "Básicamente, es un objeto que te permitirá convertir pagos del tipo CBT (Cross Border Trade) en dólares, que son pagos internacionales realizados en moneda extranjera." - } - }, - "shipping_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Amount of charge for shipping the purchase. It is of type BigDecimal.", - "pt": "Valor da cobrança de envio da compra. É do tipo BigDecimal.", - "es": "Importe del cargo por el envío de la compra. Es de tipo BigDecimal." - } - }, - "pos_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Point of Sale (POS) digital identifier. They are physical points of sale that use a card machine for sales.", - "pt": "Identificador digital do ponto de vendas (PDV). São pontos de vendas físicos que utilizam maquininha de cartão para vendas.", - "es": "Identificador digital de Punto de Venta (PDV). Son puntos de venta físicos que utilizan una máquina de tarjetas para la venta." - } - }, - "store_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o caixa pertence", - "es": "Identificador de la sucursal a la que pertenece el Punto de Venta" - } - }, - "collector_id": { - "type": "number", - "example": 448876418, - "description": { - "en": "It is the user who receives the money. Ex - A user (payer) buys a cell phone through the marketplace. The identifier of the store/seller to receive the payment is the collector_id.", - "pt": "É o usuário que recebe o dinheiro. Por exemplo - Um usuário (payer) compra um celular pelo marketplace. O identificador da loja/vendedor a receber o pagamento é o collector_id.", - "es": "Es el usuario quien recibe el dinero. Por ejemplo - Un usuario (payer) compra un celular a través del marketplace. El identificador de la tienda/vendedor para recibir el pago es el collector_id." - } - }, - "payer": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "nullable", - "example": 123, - "description": { - "en": "Payer identifier generated by Mercado Pago.", - "pt": "Identificador de pagador gerado pelo Mercado Pago.", - "es": "Identificador del Payer generado por Mercado Pago." - }, - "required": true - }, - "email": { - "type": "string", - "required": true, - "example": "test_user_80507629@testuser.com", - "description": { - "en": "Email associated with the payer. This value will only return a response when status=approved, status=refunded, or status=charged_back.", - "pt": "Email associado ao payer. Este valor só retornará uma resposta quando status=approved, status=refunded ou status=charged_back.", - "es": "Correo electrónico asociado al payer. Este valor sólo devolverá una respuesta cuando el status=approved, status=refunded o status=charged_back." - } - }, - "identification": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": 19119119100, - "description": { - "en": "The number refers to the user’s identifier. If it is a CPF, for example, it will have 11 numbers.", - "pt": "O número se refere ao identificador do usuário em questão. Se for um CPF, por exemplo, terá 11 números.", - "es": "El número hace referencia al identificador del usuario en cuestión. Si es un CPF, por ejemplo, tendrá 11 números." - } - }, - "type": { - "type": "string", - "example": "CPF", - "description": { - "en": "Identification type.", - "pt": "Tipo de identificação", - "es": "Tipo de identificación" - } - } - }, - "description": { - "es": "Personal identification. This value will only return a response when status=approved, status=refunded or status=charged_back", - "pt": "Personal identification. This value will only return a response when status=approved, status=refunded or status=charged_back", - "en": "Personal identification. This value will only return a response when status=approved, status=refunded or status=charged_back" - } - }, - "type": { - "$ref": "#/components/schemas/payer_type" - } - }, - "description": { - "en": "Payer data - ID (identifying number), email address, identification (type and number of id)", - "pt": "Dados do pagador - ID (número de identificação), e-mail, identificação (tipo e número de documento)", - "es": "Datos del pagador - ID (número identificador), dirección de email, identificación (tipo y número de documento)" - } - }, - "metadata": { - "type": "object", - "description": { - "en": "This is an optional key-value object where the customer can add additional information that needs to be recorded at checkout. Ex - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "pt": "Este é um objeto opcional do tipo chave-valor no qual o cliente pode adicionar informações adicionais que precisam ser registradas no pagamento. Por exemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "es": "Este es un objeto clave-valor opcional en el que el cliente puede agregar información adicional que debe registrarse al finalizar la compra. Por ejemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}." - } - }, - "additional_info": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "PR0001", - "description": { - "en": "It is the purchased product ad identifier. Ex - “MLB2907679857”", - "pt": "É o identificador do anúncio do produto comprado. Por exemplo - “MLB2907679857”.", - "es": "Es el identificador del anuncio del producto adquirido. Por ejemplo - “MLB2907679857”." - } - }, - "title": { - "type": "string", - "example": "Point Mini", - "description": { - "en": "Item name.", - "pt": "Nome do item", - "es": "Nombre de ítem" - } - }, - "description": { - "type": "string", - "example": "Producto Point para cobros con tarjetas mediante bluetooth", - "description": { - "en": "Long item description.", - "pt": "Descrição do artigo", - "es": "Descripción de item" - } - }, - "picture_url": { - "type": "string", - "example": "https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium2x.png", - "description": { - "en": "Image URL.", - "pt": "URL da imagem", - "es": "URL de imagen" - } - }, - "category_id": { - "type": "string", - "example": "electronics", - "description": { - "en": "Category of the item.", - "pt": "Categoria do item", - "es": "Categoría del ítem" - } - }, - "quantity": { - "type": "number", - "example": 1, - "description": { - "en": "Item quantity.", - "pt": "Quantidade do produto", - "es": "Cantidad de producto" - } - }, - "unit_price": { - "type": "number", - "example": 58.8, - "description": { - "es": "Unit price.", - "pt": "Unit price.", - "en": "Unit price." - } - } - } - }, - "description": { - "en": "List of items to be paid.", - "pt": "Lista de itens a pagar", - "es": "Lista de ítems a pagar" - } - }, - "payer": { - "type": "object", - "properties": { - "registration_date": { - "type": "string", - "example": "2019-01-01T15:01:01.000Z", - "description": { - "en": "Date of registration of the buyer on your site.", - "pt": "Data de cadastro do comprador em seu site", - "es": "Fecha de registración del comprador en tu sitio" - } - } - }, - "description": { - "en": "Payer details.", - "pt": "Detalhes do pagador.", - "es": "Detalles del pagador." - } - }, - "shipments": { - "type": "object", - "properties": { - "receiver_address": { - "type": "object", - "properties": { - "street_name": { - "type": "string", - "example": "Av das Nacoes Unidas", - "description": { - "en": "Street name.", - "pt": "Rua", - "es": "Calle" - } - }, - "street_number": { - "type": "number", - "example": 3003, - "description": { - "en": "Number.", - "pt": "Número", - "es": "Número" - } - }, - "zip_code": { - "type": "string", - "example": 6233200, - "description": { - "en": "Zip code.", - "pt": "Código postal", - "es": "Código postal" - } - }, - "city_name": { - "type": "string", - "example": "Buzios", - "description": { - "en": "City Name.", - "pt": "Cidade", - "es": "Ciudad" - } - }, - "state_name": { - "type": "string", - "example": "Rio de Janeiro", - "description": { - "en": "State.", - "pt": "Província", - "es": "Provincia" - } - } - }, - "description": { - "en": "Buyer's address.", - "pt": "Endereço do comprador", - "es": "Dirección del comprador" - } - } - }, - "description": { - "en": "Shipping information.", - "pt": "Informações de envio", - "es": "Información de envío" - } - } - }, - "description": { - "en": "Additional information.", - "pt": "Informações adicionais", - "es": "Información adicional" - } - }, - "external_reference": { - "type": "string", - "example": "MP0001", - "description": { - "en": "It is a payment external reference. It could be, for example, a hashcode from the Central Bank, working as a transaction origin identifier.", - "pt": "É uma referência externa do pagamento. Pode ser, por exemplo, um hashcode do Banco Central, funcionando como identificador de origem da transação.", - "es": "Es una referencia de pago externa. Podría ser, por ejemplo, un hashcode del Banco Central, funcionando como identificador del origen de la transacción." - } - }, - "transaction_amount": { - "type": "number", - "example": 58.8, - "description": { - "en": "Product’s cost. Example - The sale of a product for R$100.00 will have a transactionAmount = 100.", - "pt": "Custo do produto. Exemplo - A venda de um produto por R$100,00 terá um transactionAmount = 100.", - "es": "Costo del producto. Ejemplo - La venta de un producto por R$ 100,00 tendrá un transactionAmount = 100." - } - }, - "transaction_amount_refunded": { - "type": "number", - "example": 0, - "description": { - "en": "Transaction amount refunded", - "pt": "Valor reembolsado da transação", - "es": "Monto reembolsado de transacción" - } - }, - "coupon_amount": { - "type": "number", - "example": 0, - "description": { - "en": "It is the value of the discount coupon. E.g. - BRL 14.50. The attribute's type is BigDecimal.", - "pt": "É o valor do cupom de desconto. Ex. - R$14,50. O tipo do atributo é BigDecimal.", - "es": "Es el valor del cupón de descuento. Por ejemplo - BRL 14,50. El tipo del atributo es BigDecimal." - } - }, - "differential_pricing_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Attribute that commonly contains an agreement on how much the user will be charged (generally, this field is more relevant for Marketplace payments). Pricing and fees are calculated based on this identifier.", - "pt": "Atributo que comumente contém um acordo de quanto vai ser cobrado do usuário (geralmente, este campo é mais relevante para pagamentos do Marketplace). A precificação e as taxas são calculadas com base nesse identificador.", - "es": "Atributo que comúnmente contiene un acuerdo sobre cuánto se le cobrará al usuario (generalmente, este campo es más relevante para los pagos de Marketplace). Los precios y las tarifas se calculan en función de este identificador." - } - }, - "deduction_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "Pricing Scheme applied by Mercado Pago. It is a field that represents the information of a type of financing (installment). Ex - “ahora12” is a schema that indicates that the payment is divided into 12 installments. In addition, financing may have an additional cost, such cost being included in that same answer and pointed out to whom this applies (payer/collector).", - "pt": "Esquema de Pricing aplicado pelo Mercado Pago. É um campo que representa as informações de um tipo de financiamento (parcelamento). Ex. - “ahora12” é um schema que indica que o pagamento está parcelado em 12 vezes. Em adição, o financiamento pode ter um custo adicional, sendo tal custo incluído nessa mesma resposta e apontado a quem se aplica isso (payer/collector).", - "es": "Esquema de precios aplicado por Mercado Pago. Es un campo que representa la información de un tipo de financiamiento (cuota). Ej - “ahora12” es un esquema que indica que el pago se divide en 12 cuotas. Además, el financiamiento puede tener un costo adicional, siendo incluido dicho costo en esa misma respuesta y señalándose a quién aplica (payer/collector)." - } - }, - "transaction_details": { - "type": "object", - "properties": { - "payment_method_reference_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Unique identifier of the payment method", - "pt": "Identificador único do meio de pagamento", - "es": "Identificador único del método de pago" - } - }, - "net_received_amount": { - "type": "number", - "example": 56.16, - "description": { - "en": "Net amount received", - "pt": "Valor líquido recebido", - "es": "Monto neto recibido" - } - }, - "total_paid_amount": { - "type": "number", - "example": 58.8, - "description": { - "en": "Total amount charged to the payer", - "pt": "Valor total cobrado ao pagador", - "es": "Monto total cobrado al payer" - } - }, - "overpaid_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Overpaid amount", - "pt": "Valor pago a mais", - "es": "Monto pagado en exceso" - } - }, - "external_resource_url": { - "type": "string", - "format": "nullable", - "description": { - "en": "External resource url", - "pt": "URL de recurso externo", - "es": "URL de recurso externo" - } - }, - "installment_amount": { - "type": "number", - "example": 58.8, - "description": { - "en": "Amount of the chosen financing fee.", - "pt": "Valor da taxa de financiamento escolhida.", - "es": "Monto de la cuota de financiación elegida." - } - }, - "financial_institution": { - "type": "string", - "format": "nullable", - "description": { - "en": "Financial institution", - "pt": "Instituição financeira", - "es": "Institución financiera" - } - }, - "payable_deferral_period": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment deferral period", - "pt": "Período de diferimento de pagamento", - "es": "Período de diferimiento del pago" - } - }, - "acquirer_reference": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer reference", - "pt": "Referência do adquirente", - "es": "Referencia de adquirente" - } - } - }, - "description": { - "en": "Transaction details", - "pt": "Detalhes da transação", - "es": "Detalles de la transacción" - } - }, - "fee_details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/fee_details_type" - }, - "amount": { - "type": "number", - "example": 2.64, - "description": { - "en": "Fee amount.", - "pt": "Valor da comissão", - "es": "Monto de la comisión" - } - }, - "fee_payer": { - "$ref": "#/components/schemas/fee_payer" - } - } - }, - "description": { - "en": "Fee detail.", - "pt": "Detalhe de comissão", - "es": "Detalle de comisión" - } - }, - "captured": { - "type": "boolean", - "description": { - "en": "Indicates if the payment amount was captured or is pending capture.", - "pt": "Indica se o valor do pagamento foi capturado ou está com captura pendente.", - "es": "Indica si el monto del pago fue capturado o se encuentra pendiente de captura." - } - }, - "binary_mode": { - "type": "boolean", - "description": { - "en": "When set to TRUE, payments can only be approved or rejected. Otherwise they can also result in_process.", - "pt": "Quando definido como TRUE, os pagamentos só podem ser aprovados ou rejeitados. Caso contrário, eles também podem resultar in_process.", - "es": "Cuando se configura como TRUE los pagos sólo pueden resultar aprobados o rechazados. Caso contrario también pueden resultar in_process." - } - }, - "call_for_authorize_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Identifier that is provided to the issuing bank so that payments can be authorized.", - "pt": "Identificador que é fornecido ao banco emissor para que os pagamentos possam ser autorizados.", - "es": "Identificador que se proporciona al banco emisor para que se pueda autorizar los pagos." - } - }, - "statement_descriptor": { - "type": "string", - "example": "MercadoPago", - "description": { - "en": "Description that the payment will appear with in the card statement (eg MERCADOPAGO)", - "pt": "Descrição com a qual o pagamento aparecerá no resumo do cartão (ex. MERCADOPAGO)", - "es": "Descripción con la que aparecerá el pago en el resumen de tarjeta (ej. MERCADOPAGO)" - } - }, - "installments": { - "type": "number", - "example": 1, - "description": { - "en": "Number of installments selected.", - "pt": "Número de parcelas selecionado", - "es": "Cantidad seleccionada de cuotas" - } - }, - "card": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Card ID.", - "pt": "Identificador de cartão", - "es": "Identificador de tarjeta" - } - }, - "first_six_digits": { - "type": "string", - "example": 423564, - "description": { - "en": "Card Bin", - "pt": "Bin do cartão", - "es": "Bin de la tarjeta" - } - }, - "last_four_digits": { - "type": "string", - "example": 5682, - "description": { - "en": "last 4 digits of the card", - "pt": "últimos 4 dígitos do cartão", - "es": "últimos 4 digitos de la tarjeta" - } - }, - "expiration_month": { - "type": "number", - "example": 6, - "description": { - "en": "Card's expiration month.", - "pt": "Mês de validade do cartão", - "es": "Mes de expiración de la tarjeta" - } - }, - "expiration_year": { - "type": "number", - "example": 2023, - "description": { - "en": "Card's expiration year.", - "pt": "Ano de validade do cartão", - "es": "Año de expiración de la tarjeta" - } - }, - "date_created": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Card registration date.", - "pt": "Data de registro do cartão.", - "es": "Fecha de registro de la tarjeta." - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Date on which the last payment event was recorded.", - "pt": "Data em que o último evento de pagamento foi registrado.", - "es": "Fecha en la que se registró el ultimo evento sobre el pago." - } - }, - "cardholder": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "APRO", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "identification": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": 19119119100, - "description": { - "en": "The number refers to the user’s identifier. If it is a CPF, for example, it will have 11 numbers.", - "pt": "O número se refere ao identificador do usuário em questão. Se for um CPF, por exemplo, terá 11 números.", - "es": "El número hace referencia al identificador del usuario en cuestión. Si es un CPF, por ejemplo, tendrá 11 números." - } - }, - "type": { - "type": "string", - "example": "CPF", - "description": { - "en": "Identification type.", - "pt": "Tipo de identificação", - "es": "Tipo de identificación" - } - } - }, - "description": { - "es": "Personal identification.", - "pt": "Personal identification.", - "en": "Personal identification." - } - } - }, - "description": { - "en": "Cardholder details.", - "pt": "Detalhes do titular do cartão.", - "es": "Detalles del titular de la tarjeta." - } - } - }, - "description": { - "en": "Card details.", - "pt": "Informações do cartão.", - "es": "Detalles de la tarjeta." - } - }, - "notification_url": { - "type": "string", - "example": "https://www.suaurl.com/notificacoes/", - "description": { - "en": "Notifications URL available to receive notifications of events related to Payment. The maximum number of characters allowed for submission in this parameter is 248 characters.", - "pt": "URL de notificações disponível para receber notificações de eventos relacionados ao Pagamento. A quantidade máxima de caracteres permitidos para envio neste parâmetro é de 248 caracteres.", - "es": "URL de Notificaciones disponibilizada para recibir las notificaciones de los eventos relacionados al Pago. La cantidad máxima de caracteres permitidos para enviar en este parámetro es de 248 caracteres." - } - }, - "processing_mode": { - "type": "string", - "example": "aggregator", - "description": { - "en": "Processing mode. There are two types.", - "pt": "Modo de processamento. Existem dois tipos.", - "es": "Modo de procesamiento. Existen dos tipos." - }, - "enum": [ - { - "title": "Aggregator", - "description": { - "en": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer.", - "es": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer.", - "pt": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer." - } - }, - { - "title": "Gateway", - "description": { - "en": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment.", - "es": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment.", - "pt": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment." - } - } - ] - }, - "merchant_account_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant store code identifier. Applies only to the gateway model (since the delivery of money to the merchant does not go through the Mercado Pago system).", - "pt": "Identificador do código da loja comerciante. Aplica-se somente ao modelo gateway (porque a entrega de dinheiro ao comerciante não passa pelo sistema do Mercado Pago).", - "es": "Identificador del código de la tienda del merchant. Aplica solo para el modelo de gateway (ya que la entrega de dinero al comercio no pasa por el sistema de Mercado Pago)." - } - }, - "acquirer": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer.", - "pt": "Adquirente.", - "es": "Adquirente." - } - }, - "merchant_number": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant number (Applies to gateway model).", - "pt": "Número da loja (aplica-se ao modelo de gateway).", - "es": "Número de comercio (Aplica para modelo gateway)." - } - }, - "point_of_interaction": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "PIX", - "description": { - "en": "Payment type identifier", - "pt": "Identificador do tipo de pagamento", - "es": "Identificador del tipo de pago" - } - }, - "sub_type": { - "type": "string", - "description": { - "en": "Secondary identifier of the payment type", - "pt": "Identificador secundário do tipo de pagamento", - "es": "Identificador secundario del tipo de pago" - } - }, - "application_data": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "NAME_SDK", - "description": { - "en": "Application name", - "pt": "Nome da aplicação", - "es": "Nombre de la aplicación" - } - }, - "version": { - "type": "string", - "example": "VERSION_NUMBER", - "description": { - "en": "Current version", - "pt": "Versão atual da aplicação", - "es": "Versión actual de la aplicación" - } - } - }, - "description": { - "en": "Information about the application that processes the payment", - "pt": "Informação da aplicação que processa o pagamento", - "es": "Información de la aplicación que procesa el pago" - } - }, - "transaction_data": { - "type": "object", - "properties": { - "qr_code_base64": { - "type": "string", - "example": "iVBORw0KGgoAAAANSUhEUgAABRQAAAUUCAYAAACu5p7oAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAIABJREFUeJzs2luO3LiWQNFmI+Y/Zd6vRt36KGNXi7ZOBtcagHD4kNLeiLX33v8DAAAAABD879sDAAAAAAA/h6AIAAAAAGSCIgAAAACQCYoAAAAAQCYoAgAAAACZoAgAAAAAZIIiAAAAAJAJigAAAABAJigCAAAAAJmgCAAAAABkgiIAAAAAkAmKAAAAAEAmKAIAAAAAmaAIAAAAAGSCIgAAAACQCYoAAAAAQCYoAgAAAACZoAgAAAAAZIIiAAAAAJAJigAAAABAJigCA...", - "description": { - "en": "Base64 representation of the image of the QR code to be scanned to finalize the payment", - "pt": "Representação em Base64 da imagem do código QR a ser digitalizado para finalização do pagamento", - "es": "Representación en base64 de la imagen del código QR a escanear para finalizar el pago" - } - }, - "qr_code": { - "type": "string", - "example": "00020126600014br.gov.bcb.pix0117test@testuser.com0217dados adicionais520400005303986540510.005802BR5913Maria Silva6008Brasilia62070503***6304E2CA", - "description": { - "en": "Alphanumeric code to copy and paste, used to finalize the payment", - "pt": "Código alfanumérico para copiar e colar, para finalizar o pagamento", - "es": "Código alfanumérico para copiar y pegar, para finalizar el pago" - } - }, - "ticket_url": { - "type": "string", - "example": "https://www.mercadopago.com.br/payments/123456789/ticket?caller_id=123456&hash=123e4567-e89b-12d3-a456-426655440000", - "description": { - "es": "A link to the rendered pix, with QR codes and instructions to pay", - "pt": "A link to the rendered pix, with QR codes and instructions to pay", - "en": "A link to the rendered pix, with QR codes and instructions to pay" - } - } - }, - "description": { - "en": "Information on the pending payment that was generated", - "pt": "Informação do pagamento pendente que foi gerado", - "es": "Información del pago pendiente que fue generado" - } - } - }, - "description": { - "en": "Information from the application that processes the payment and receives regulatory data", - "pt": "Informação da aplicação que processa o pagamento e recebe dados regulatórios", - "es": "Información de la aplicación que procesa el pago y recibe datos regulatorios" - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "Params Error.", - "es": "Params Error.", - "pt": "Params Error." - } - }, - { - "title": "3", - "description": { - "en": "Token must be for test.", - "es": "Token must be for test.", - "pt": "Token must be for test." - } - }, - { - "title": "5", - "description": { - "en": "Must provide your access_token to proceed.", - "es": "Must provide your access_token to proceed.", - "pt": "Must provide your access_token to proceed." - } - }, - { - "title": "23", - "description": { - "en": "The following parameters must be valid date and format (yyyy-MM-dd'T'HH:mm:ssz) date_of_expiration.", - "es": "The following parameters must be valid date and format (yyyy-MM-dd'T'HH:mm:ssz) date_of_expiration.", - "pt": "The following parameters must be valid date and format (yyyy-MM-dd'T'HH:mm:ssz) date_of_expiration." - } - }, - { - "title": "1000", - "description": { - "en": "Number of rows exceeded the limits.", - "es": "Number of rows exceeded the limits.", - "pt": "Number of rows exceeded the limits." - } - }, - { - "title": "1001", - "description": { - "en": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.", - "es": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.", - "pt": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ." - } - }, - { - "title": "2001", - "description": { - "en": "Already posted the same request in the last minute.", - "es": "Already posted the same request in the last minute.", - "pt": "Already posted the same request in the last minute." - } - }, - { - "title": "2002", - "description": { - "en": "Customer not found.", - "es": "Customer not found.", - "pt": "Customer not found." - } - }, - { - "title": "2004", - "description": { - "en": "POST to Gateway Transactions API fail.", - "es": "POST to Gateway Transactions API fail.", - "pt": "POST to Gateway Transactions API fail." - } - }, - { - "title": "2006", - "description": { - "en": "Card Token not found.", - "es": "Card Token not found.", - "pt": "Card Token not found." - } - }, - { - "title": "2007", - "description": { - "en": "Connection to Card Token API fail.", - "es": "Connection to Card Token API fail.", - "pt": "Connection to Card Token API fail." - } - }, - { - "title": "2009", - "description": { - "en": "Card token issuer can't be null.", - "es": "Card token issuer can't be null.", - "pt": "Card token issuer can't be null." - } - }, - { - "title": "2034", - "description": { - "en": "Invalid users involved 2041 – GET to API APPLICATION fail.", - "es": "Invalid users involved 2041 – GET to API APPLICATION fail.", - "pt": "Invalid users involved 2041 – GET to API APPLICATION fail." - } - }, - { - "title": "2060", - "description": { - "en": "The customer can't be equal to the collector.", - "es": "The customer can't be equal to the collector.", - "pt": "The customer can't be equal to the collector." - } - }, - { - "title": "2062", - "description": { - "en": "Invalid card token.", - "es": "Invalid card token.", - "pt": "Invalid card token." - } - }, - { - "title": "2072", - "description": { - "en": "Invalid value for transaction_amount.", - "es": "Invalid value for transaction_amount.", - "pt": "Invalid value for transaction_amount." - } - }, - { - "title": "2077", - "description": { - "en": "Deferred capture not supported.", - "es": "Deferred capture not supported.", - "pt": "Deferred capture not supported." - } - }, - { - "title": "2123", - "description": { - "en": "Invalid operators users involved.", - "es": "Invalid operators users involved.", - "pt": "Invalid operators users involved." - } - }, - { - "title": "2131", - "description": { - "en": "Cannot infer Payment Method.", - "es": "Cannot infer Payment Method.", - "pt": "Cannot infer Payment Method." - } - }, - { - "title": "3000", - "description": { - "en": "You must provide your cardholder_name with your card data.", - "es": "You must provide your cardholder_name with your card data.", - "pt": "You must provide your cardholder_name with your card data." - } - }, - { - "title": "3001", - "description": { - "en": "You must provide your cardissuer_id with your card data.", - "es": "You must provide your cardissuer_id with your card data.", - "pt": "You must provide your cardissuer_id with your card data." - } - }, - { - "title": "3003", - "description": { - "en": "Invalid card_token_id.", - "es": "Invalid card_token_id.", - "pt": "Invalid card_token_id." - } - }, - { - "title": "3004", - "description": { - "en": "Invalid parameter site_id.", - "es": "Invalid parameter site_id.", - "pt": "Invalid parameter site_id." - } - }, - { - "title": "3005", - "description": { - "en": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource.", - "es": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource.", - "pt": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource." - } - }, - { - "title": "3006", - "description": { - "en": "Invalid parameter cardtoken_id.", - "es": "Invalid parameter cardtoken_id.", - "pt": "Invalid parameter cardtoken_id." - } - }, - { - "title": "3007", - "description": { - "en": "The parameter client_id can not be null or empty.", - "es": "The parameter client_id can not be null or empty.", - "pt": "The parameter client_id can not be null or empty." - } - }, - { - "title": "3008", - "description": { - "en": "Not found Cardtoken.", - "es": "Not found Cardtoken.", - "pt": "Not found Cardtoken." - } - }, - { - "title": "3009", - "description": { - "en": "unauthorized client_id.", - "es": "unauthorized client_id.", - "pt": "unauthorized client_id." - } - }, - { - "title": "3010", - "description": { - "en": "Not found card on whitelist.", - "es": "Not found card on whitelist.", - "pt": "Not found card on whitelist." - } - }, - { - "title": "3011", - "description": { - "en": "Not found payment_method.", - "es": "Not found payment_method.", - "pt": "Not found payment_method." - } - }, - { - "title": "3012", - "description": { - "en": "Invalid parameter security_code_length.", - "es": "Invalid parameter security_code_length.", - "pt": "Invalid parameter security_code_length." - } - }, - { - "title": "3013", - "description": { - "en": "The parameter security_code is a required field can not be null or empty.", - "es": "The parameter security_code is a required field can not be null or empty.", - "pt": "The parameter security_code is a required field can not be null or empty." - } - }, - { - "title": "3014", - "description": { - "en": "Invalid parameter payment_method.", - "es": "Invalid parameter payment_method.", - "pt": "Invalid parameter payment_method." - } - }, - { - "title": "3015", - "description": { - "en": "Invalid parameter card_number_length.", - "es": "Invalid parameter card_number_length.", - "pt": "Invalid parameter card_number_length." - } - }, - { - "title": "3016", - "description": { - "en": "Invalid parameter card_number.", - "es": "Invalid parameter card_number.", - "pt": "Invalid parameter card_number." - } - }, - { - "title": "3017", - "description": { - "en": "The parameter card_number_id can not be null or empty.", - "es": "The parameter card_number_id can not be null or empty.", - "pt": "The parameter card_number_id can not be null or empty." - } - }, - { - "title": "3018", - "description": { - "en": "The parameter expiration_month can not be null or empty.", - "es": "The parameter expiration_month can not be null or empty.", - "pt": "The parameter expiration_month can not be null or empty." - } - }, - { - "title": "3019", - "description": { - "en": "The parameter expiration_year can not be null or empty.", - "es": "The parameter expiration_year can not be null or empty.", - "pt": "The parameter expiration_year can not be null or empty." - } - }, - { - "title": "3020", - "description": { - "en": "The parameter cardholder.name can not be null or empty.", - "es": "The parameter cardholder.name can not be null or empty.", - "pt": "The parameter cardholder.name can not be null or empty." - } - }, - { - "title": "3021", - "description": { - "en": "The parameter cardholder.document.number can not be null or empty.", - "es": "The parameter cardholder.document.number can not be null or empty.", - "pt": "The parameter cardholder.document.number can not be null or empty." - } - }, - { - "title": "3022", - "description": { - "en": "The parameter cardholder.document.type can not be null or empty.", - "es": "The parameter cardholder.document.type can not be null or empty.", - "pt": "The parameter cardholder.document.type can not be null or empty." - } - }, - { - "title": "3023", - "description": { - "en": "The parameter cardholder.document.subtype can not be null or empty.", - "es": "The parameter cardholder.document.subtype can not be null or empty.", - "pt": "The parameter cardholder.document.subtype can not be null or empty." - } - }, - { - "title": "3024", - "description": { - "en": "Not valid action - partial refund unsupported for this transaction.", - "es": "Not valid action - partial refund unsupported for this transaction.", - "pt": "Not valid action - partial refund unsupported for this transaction." - } - }, - { - "title": "3025", - "description": { - "en": "Invalid Auth Code.", - "es": "Invalid Auth Code.", - "pt": "Invalid Auth Code." - } - }, - { - "title": "3026", - "description": { - "en": "Invalid card_id for this payment_method_id.", - "es": "Invalid card_id for this payment_method_id.", - "pt": "Invalid card_id for this payment_method_id." - } - }, - { - "title": "3027", - "description": { - "en": "Invalid payment_type_id.", - "es": "Invalid payment_type_id.", - "pt": "Invalid payment_type_id." - } - }, - { - "title": "3028", - "description": { - "en": "Invalid payment_method_id.", - "es": "Invalid payment_method_id.", - "pt": "Invalid payment_method_id." - } - }, - { - "title": "3029", - "description": { - "en": "Invalid card expiration month.", - "es": "Invalid card expiration month.", - "pt": "Invalid card expiration month." - } - }, - { - "title": "3030", - "description": { - "en": "Invalid card expiration year.", - "es": "Invalid card expiration year.", - "pt": "Invalid card expiration year." - } - }, - { - "title": "3031", - "description": { - "en": "Secure_code_id can't be null.", - "es": "Secure_code_id can't be null.", - "pt": "Secure_code_id can't be null." - } - }, - { - "title": "3032", - "description": { - "en": "Invalid security_code_length 3033 3034 - Invalid card_number_validation.", - "es": "Invalid security_code_length 3033 3034 - Invalid card_number_validation.", - "pt": "Invalid security_code_length 3033 3034 - Invalid card_number_validation." - } - }, - { - "title": "4000", - "description": { - "en": "card atributte can't be null.", - "es": "card atributte can't be null.", - "pt": "card atributte can't be null." - } - }, - { - "title": "4001", - "description": { - "en": "payment_method_id atributte can't be null.", - "es": "payment_method_id atributte can't be null.", - "pt": "payment_method_id atributte can't be null." - } - }, - { - "title": "4002", - "description": { - "en": "transaction_amount atributte can't be null.", - "es": "transaction_amount atributte can't be null.", - "pt": "transaction_amount atributte can't be null." - } - }, - { - "title": "4003", - "description": { - "en": "transaction_amount atributte must be numeric.", - "es": "transaction_amount atributte must be numeric.", - "pt": "transaction_amount atributte must be numeric." - } - }, - { - "title": "4004", - "description": { - "en": "installments atributte can't be null.", - "es": "installments atributte can't be null.", - "pt": "installments atributte can't be null." - } - }, - { - "title": "4005", - "description": { - "en": "installments atributte must be numeric.", - "es": "installments atributte must be numeric.", - "pt": "installments atributte must be numeric." - } - }, - { - "title": "4006", - "description": { - "en": "payer atributte is malformed.", - "es": "payer atributte is malformed.", - "pt": "payer atributte is malformed." - } - }, - { - "title": "4007", - "description": { - "en": "site_id atributte can't be null.", - "es": "site_id atributte can't be null.", - "pt": "site_id atributte can't be null." - } - }, - { - "title": "4012", - "description": { - "en": "payer.id atributte can't be null.", - "es": "payer.id atributte can't be null.", - "pt": "payer.id atributte can't be null." - } - }, - { - "title": "4013", - "description": { - "en": "payer.type atributte can't be null.", - "es": "payer.type atributte can't be null.", - "pt": "payer.type atributte can't be null." - } - }, - { - "title": "4015", - "description": { - "en": "payment_method_reference_id atributte can't be null.", - "es": "payment_method_reference_id atributte can't be null.", - "pt": "payment_method_reference_id atributte can't be null." - } - }, - { - "title": "4016", - "description": { - "en": "payment_method_reference_id atributte must be numeric.", - "es": "payment_method_reference_id atributte must be numeric.", - "pt": "payment_method_reference_id atributte must be numeric." - } - }, - { - "title": "4017", - "description": { - "en": "status atributte can't be null.", - "es": "status atributte can't be null.", - "pt": "status atributte can't be null." - } - }, - { - "title": "4018", - "description": { - "en": "payment_id atributte can't be null.", - "es": "payment_id atributte can't be null.", - "pt": "payment_id atributte can't be null." - } - }, - { - "title": "4019", - "description": { - "en": "payment_id atributte must be numeric.", - "es": "payment_id atributte must be numeric.", - "pt": "payment_id atributte must be numeric." - } - }, - { - "title": "4020", - "description": { - "en": "notificaction_url atributte must be url valid.", - "es": "notificaction_url atributte must be url valid.", - "pt": "notificaction_url atributte must be url valid." - } - }, - { - "title": "4021", - "description": { - "en": "notificaction_url atributte must be shorter than 500 characters.", - "es": "notificaction_url atributte must be shorter than 500 characters.", - "pt": "notificaction_url atributte must be shorter than 500 characters." - } - }, - { - "title": "4022", - "description": { - "en": "metadata atributte must be a valid JSON.", - "es": "metadata atributte must be a valid JSON.", - "pt": "metadata atributte must be a valid JSON." - } - }, - { - "title": "4023", - "description": { - "en": "transaction_amount atributte can't be null.", - "es": "transaction_amount atributte can't be null.", - "pt": "transaction_amount atributte can't be null." - } - }, - { - "title": "4024", - "description": { - "en": "transaction_amount atributte must be numeric.", - "es": "transaction_amount atributte must be numeric.", - "pt": "transaction_amount atributte must be numeric." - } - }, - { - "title": "4025", - "description": { - "en": "refund_id can't be null.", - "es": "refund_id can't be null.", - "pt": "refund_id can't be null." - } - }, - { - "title": "4026", - "description": { - "en": "Invalid coupon_amount.", - "es": "Invalid coupon_amount.", - "pt": "Invalid coupon_amount." - } - }, - { - "title": "4027", - "description": { - "en": "campaign_id atributte must be numeric.", - "es": "campaign_id atributte must be numeric.", - "pt": "campaign_id atributte must be numeric." - } - }, - { - "title": "4028", - "description": { - "en": "coupon_amount atributte must be numeric.", - "es": "coupon_amount atributte must be numeric.", - "pt": "coupon_amount atributte must be numeric." - } - }, - { - "title": "4029", - "description": { - "en": "Invalid payer type.", - "es": "Invalid payer type.", - "pt": "Invalid payer type." - } - }, - { - "title": "4037", - "description": { - "en": "Invalid transaction_amount.", - "es": "Invalid transaction_amount.", - "pt": "Invalid transaction_amount." - } - }, - { - "title": "4038", - "description": { - "en": "application_fee cannot be bigger than transaction_amount.", - "es": "application_fee cannot be bigger than transaction_amount.", - "pt": "application_fee cannot be bigger than transaction_amount." - } - }, - { - "title": "4039", - "description": { - "en": "application_fee cannot be a negative value.", - "es": "application_fee cannot be a negative value.", - "pt": "application_fee cannot be a negative value." - } - }, - { - "title": "4050", - "description": { - "en": "payer.email must be a valid email.", - "es": "payer.email must be a valid email.", - "pt": "payer.email must be a valid email." - } - }, - { - "title": "4051", - "description": { - "en": "payer.email must be shorter than 254 characters.", - "es": "payer.email must be shorter than 254 characters.", - "pt": "payer.email must be shorter than 254 characters." - } - }, - { - "title": "6033", - "description": { - "en": "User unavailable.", - "es": "User unavailable.", - "pt": "User unavailable." - } - }, - { - "title": "7523", - "description": { - "en": "Invalid expiration date.", - "es": "Invalid expiration date.", - "pt": "Invalid expiration date." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "4", - "description": { - "en": "The caller is not authorized to access this resource.", - "es": "The caller is not authorized to access this resource.", - "pt": "The caller is not authorized to access this resource." - } - }, - { - "title": "3002", - "description": { - "en": "The caller is not authorized to perform this action.", - "es": "The caller is not authorized to perform this action.", - "pt": "The caller is not authorized to perform this action." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "2000", - "description": { - "en": "Payment not found. This error will return a field called \"data\". This field contains the error date \"25-09-2023T16:57:53UTC\" and a Request ID, an ID that identifies payment traceability.", - "es": "Payment not found. This error will return a field called \"data\". This field contains the error date \"25-09-2023T16:57:53UTC\" and a Request ID, an ID that identifies payment traceability.", - "pt": "Payment not found. This error will return a field called \"data\". This field contains the error date \"25-09-2023T16:57:53UTC\" and a Request ID, an ID that identifies payment traceability." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Create payment", - "pt": "Criar pagamento", - "es": "Crear pago" - }, - "userCases": [ - { - "name": { - "en": "Create payment with visa", - "pt": "Criar pagamento visa", - "es": "Crear pago con visa " - } - }, - { - "name": { - "en": "Create payment with Rapipago", - "pt": "Criar pagamento Rapipago", - "es": "Crear pago con Rapipago" - }, - "siteId": [ - "MLA" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "payment_method_id": { - "example": "rapipago" - } - } - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "example": 123456 - }, - "payment_method_id": { - "example": "rapipago" - }, - "description": { - "example": "Test payment rapipago" - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "X-Idempotency-Key", - "schema": { - "example": "123445678901234" - } - } - ] - }, - { - "name": { - "en": "Create payment with master", - "pt": "Criar pagamento master", - "es": "Crear pago con master" - }, - "siteId": [ - "allSites" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "payment_method_id": { - "example": "master" - } - } - } - } - } - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "example": 123456 - }, - "payment_method_id": { - "example": "master" - }, - "description": { - "example": "Test payment master" - } - } - } - } - } - } - }, - "parameters": [ - { - "name": "X-Idempotency-Key", - "schema": { - "example": "0d5020ed-1af6-469c-ae06-c3bec19954bb" - } - } - ] - } - ] - } - }, - "/v1/payments/{id}": { - "get": { - "tags": [ - "checkout-pro", - "qr-code", - "subscriptions", - "checkout-api", - "mp-point" - ], - "description": { - "en": "See all the information of a payment through the payment ID", - "pt": "Consulte todas as informações de um pagamento através do ID de pagamento", - "es": "Consulta toda la información de un pago a través del ID del pago" - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Unique Payment Identifier, automatically generated by Mercado Pago", - "pt": "Identificador único de pagamento, gerado automaticamente pelo Mercado Pago", - "es": "Identificador único del pago, generado automáticamente por Mercado Pago" - }, - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Success", - "en": "Success" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": 1, - "description": { - "en": "Unique Payment Identifier, automatically generated by Mercado Pago", - "pt": "Identificador único de pagamento, gerado automaticamente pelo Mercado Pago", - "es": "Identificador único del pago, generado automáticamente por Mercado Pago" - } - }, - "date_created": { - "type": "string", - "example": "2017-08-31T11:26:38.000Z", - "description": { - "en": "Payment creation date.", - "pt": "Data de criação do pagamento.", - "es": "Fecha de creación del Pago." - } - }, - "date_approved": { - "type": "string", - "example": "2017-08-31T11:26:38.000Z", - "description": { - "en": "Payment approval date. A payment can be generated in an intermediate state and then approved, so the creation date will not always coincide with the Approval Date.", - "pt": "Data de aprovação do pagamento. Um pagamento pode ser gerado em um estado intermediário e depois aprovado, portanto, a data de criação nem sempre coincidirá com a Data de Aprovação.", - "es": "Fecha de aprobación del Pago. Un pago puede generarse en un estado intermedio y luego ser aprobado, por tanto la fecha de creación no siempre coincidirá con la Fecha de Aprobación." - } - }, - "date_last_updated": { - "type": "string", - "example": "2017-08-31T11:26:38.000Z", - "description": { - "en": "Date on which the last payment event was recorded.", - "pt": "Data em que o último evento de pagamento foi registrado.", - "es": "Fecha en la que se registró el ultimo evento sobre el pago." - } - }, - "date_of_expiration": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment’s expiration date. The attribute’s valid format is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "pt": "Data de expiração do pagamento. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "es": "Fecha de vencimiento del pago. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Ej. - 2022-11-17T09:37:52.000-04:00." - } - }, - "money_release_date": { - "type": "string", - "example": "2017-09-14T11:26:38.000Z", - "description": { - "en": "Date on which the payment is settled and the money is made available in the Mercado Pago account of the Collector (the one who receives the payment). The field can take on the values “pending” or “released”, where the first indicates that the payment has not yet been released (money held for a period) and “released” means that the money has already been released to the user's available balance.", - "pt": "Data em que o pagamento é liquidado e o dinheiro é disponibilizado na conta Mercado Pago do Collector (aquele que recebe o pagamento). O campo pode assumir os valores “pending” ou “released”, sendo que o primeiro indica que o pagamento ainda não foi liberado (dinheiro retido por tempo) e “released” significa que o dinheiro já foi liberado para o saldo disponível do usuário.", - "es": "Fecha en que se liquida el pago y se pone a disposición el dinero en la cuenta de Mercado Pago del Collector (el que recibe el pago). El campo puede tomar los valores “pending” o “released”, siendo que el primero indica que el pago todavía no fue liberado (dinero retenido por tiempo) y “released” significa que el dinero ya fue liberado al disponible del usuario." - } - }, - "operation_type": { - "$ref": "#/components/schemas/operation_type" - }, - "issuer_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Is the identifier of the card issuer being used in a credit or debit card payment.", - "pt": "É o identificador do emissor do cartão que está sendo utilizado em um pagamento com cartão de crédito ou débito.", - "es": "Es el identificador del emisor de la tarjeta que se utiliza en un pago con tarjeta de crédito o débito." - } - }, - "payment_method_id": { - "type": "string", - "example": "account_money", - "description": { - "en": "It indicates the identifier of the payment method selected to make the transaction. Here are some examples. Get all available payment methods by consulting the 'Get payment Methods API'.", - "pt": "Indica o identificador do meio de pagamento selecionado para efetuar o pagamento. A seguir, apresentamos alguns exemplos. Obtenha todos os meios de pagamento disponíveis consultando a API de 'Obter meios de pagamento'.", - "es": "Identificador del medio de pago. Indica el ID del medio de pago seleccionado para realizar el pago. A continuación presentamos algunos ejemplos. Obtén todos los métodos de pago disponibles consultando la API de 'Obtener métodos de pago'." - }, - "enum": [ - { - "title": "pix", - "description": { - "en": "Instant digital payment method used in Brazil;", - "es": "Instant digital payment method used in Brazil;", - "pt": "Instant digital payment method used in Brazil;" - } - }, - { - "title": "account_money", - "description": { - "en": "When the payment is debited directly from a Mercado Pago account;", - "es": "When the payment is debited directly from a Mercado Pago account;", - "pt": "When the payment is debited directly from a Mercado Pago account;" - } - }, - { - "title": "debin_transfer", - "description": { - "en": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization;", - "es": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization;", - "pt": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization;" - } - }, - { - "title": "ted", - "description": { - "en": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;", - "es": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;", - "pt": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;" - } - }, - { - "title": "cvu", - "description": { - "en": "Payment method used in Argentina;", - "es": "Payment method used in Argentina;", - "pt": "Payment method used in Argentina;" - } - }, - { - "title": "pse", - "description": { - "en": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts.", - "es": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts.", - "pt": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts." - } - } - ] - }, - "payment_type_id": { - "$ref": "#/components/schemas/payment_type_id" - }, - "status": { - "$ref": "#/components/schemas/status" - }, - "status_detail": { - "type": "string", - "example": "accredited", - "description": { - "en": "Detail in which the Collection resulted", - "pt": "Detalhe em que resultou a Coleção", - "es": "Detalle en el que resultó el Cobro" - }, - "enum": [ - { - "title": "Accredited", - "description": { - "en": "credited payment.", - "es": "credited payment.", - "pt": "credited payment." - } - }, - { - "title": "pending_contingency", - "description": { - "en": "the payment is being processed.", - "es": "the payment is being processed.", - "pt": "the payment is being processed." - } - }, - { - "title": "pending_review_manual", - "description": { - "en": "the payment is under review to determine its approval or rejection.", - "es": "the payment is under review to determine its approval or rejection.", - "pt": "the payment is under review to determine its approval or rejection." - } - }, - { - "title": "cc_rejected_bad_filled_date", - "description": { - "en": "incorrect expiration date.", - "es": "incorrect expiration date.", - "pt": "incorrect expiration date." - } - }, - { - "title": "cc_rejected_bad_filled_other", - "description": { - "en": "incorrect card details.", - "es": "incorrect card details.", - "pt": "incorrect card details." - } - }, - { - "title": "cc_rejected_bad_filled_security_code", - "description": { - "en": "incorrect CVV.", - "es": "incorrect CVV.", - "pt": "incorrect CVV." - } - }, - { - "title": "cc_rejected_blacklist", - "description": { - "en": "the card is on a black list for theft/complaints/fraud.", - "es": "the card is on a black list for theft/complaints/fraud.", - "pt": "the card is on a black list for theft/complaints/fraud." - } - }, - { - "title": "cc_rejected_call_for_authorize", - "description": { - "en": "the means of payment requires prior authorization of the amount of the operation.", - "es": "the means of payment requires prior authorization of the amount of the operation.", - "pt": "the means of payment requires prior authorization of the amount of the operation." - } - }, - { - "title": "cc_rejected_card_disabled", - "description": { - "en": "the card is inactive.", - "es": "the card is inactive.", - "pt": "the card is inactive." - } - }, - { - "title": "cc_rejected_duplicated_payment", - "description": { - "en": "transacción duplicada.", - "es": "transacción duplicada.", - "pt": "transacción duplicada." - } - }, - { - "title": "cc_rejected_high_risk", - "description": { - "en": "rechazo por Prevención de Fraude.", - "es": "rechazo por Prevención de Fraude.", - "pt": "rechazo por Prevención de Fraude." - } - }, - { - "title": "cc_rejected_insufficient_amount", - "description": { - "en": "insufficient amount.", - "es": "insufficient amount.", - "pt": "insufficient amount." - } - }, - { - "title": "cc_rejected_invalid_installments", - "description": { - "en": "invalid number of installments.", - "es": "invalid number of installments.", - "pt": "invalid number of installments." - } - }, - { - "title": "cc_rejected_max_attempts", - "description": { - "en": "exceeded maximum number of attempts.", - "es": "exceeded maximum number of attempts.", - "pt": "exceeded maximum number of attempts." - } - }, - { - "title": "cc_rejected_other_reason", - "description": { - "en": "generic error.", - "es": "generic error.", - "pt": "generic error." - } - } - ] - }, - "currency_id": { - "$ref": "#/components/schemas/currency_id" - }, - "description": { - "type": "string", - "example": "Pago Pizza", - "description": { - "en": "Description sent in the payment creation request. Ex. - In a pix payment, the description is “Payment of Installments without card”. In another cases, such as a purchase in a physical store where the customer uses the machine to pay, we can find the description “Sale in person”. In marketplace purchases, the purchase description usually corresponds to a purchased product - “Pendrive Multilaser Twist Pd590 64gb 2.0 Black And Silver + 1 product”.", - "pt": "Descrição enviada na solicitação de criação de pagamento. Por exemplo - Em um pagamento pix, há a descrição “Pagamento de parcelas de Linha de Crédito”. Em outro caso, uma compra em loja física onde o cliente utiliza a maquininha para pagar, podemos encontrar a descrição - “Venda presencial”. Já em compras do marketplace, a descrição da compra geralmente corresponde a um produto comprado - “\tPendrive Multilaser Twist Pd590 64gb 2.0 Preto E Prateado + 1 produto”.", - "es": "Descripción enviada en el request de creación de pago. Por ejemplo - En un pago con pix, se encuentra la descripción “Pagos sin Tarjeta”. En otro caso, una compra en una tienda física donde el cliente utiliza la máquina para pagar, podemos encontrar la descripción “Venta en persona”. En las compras en marketplace, la descripción de compra suele corresponder a un producto comprado - “Pendrive Multilaser Twist Pd590 64gb 2.0 Negro Y Plata + 1 producto”." - } - }, - "live_mode": { - "type": "boolean", - "description": { - "en": "Indicates whether the Payment was made in a production environment or in a Test environment. If TRUE, then the chargeback will be processed in production mode. If FALSE, then the chargeback will be processed in sandbox mode.", - "pt": "Indica se o Pagamento foi feito em ambiente de produção ou em ambiente de Teste. Se TRUE, o estorno será processado em modo de produção. Se FALSE, o estorno será processado no modo sandbox.", - "es": "Indica si el Pago se realizó en ambiente productivo o en un ambiente de Test. Si es TRUE, el contracargo se procesará en modo de producción. Si es FALSE, el contracargo se procesará en modo sandbox." - } - }, - "sponsor_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is deprecated and no longer used.", - "pt": "Este campo está deprecado e não é mais utilizado.", - "es": "Este campo está deprecado y ya no se usa." - } - }, - "authorization_code": { - "type": "string", - "format": "nullable", - "description": { - "en": "Transaction’s authorization code for payments with “payment_method_type” of type “credit_card” (credit card), “debit_card” (debit card) and “voucher_card” (voucher card for benefits, such as Alelo). In summary, this code is used for card transactions. The code is numerical and has 6 digits.", - "pt": "Código de autorização de transação para pagamentos com “payment_method_type” do tipo “credit_card” (cartão de crédito), “debit_card” (cartão de crédito) e “voucher_card” (cartão de voucher para benefícios, como Alelo). Em síntese, este código é utilizado para transações com cartão. O código é numérico e possui 6 dígitos.", - "es": "Código de autorización de transacción para pagos con “payment_method_type” de tipo “credit_card” (tarjeta de crédito), “debit_card” (tarjeta de débito) y “voucher_card” (tarjeta de bono para beneficios, como Alelo). En resumen, este código se utiliza para transacciones con tarjeta. Es numérico y tiene 6 dígitos." - } - }, - "money_release_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is used to identify whether a payment is PNF (Payment in Flow). Payment in flow is a form of cash release in which the installments received by a seller are released over the months (which corresponds to the number of installments). Possible values ​​for this field are “null” or “payment_in_flow”.", - "pt": "Esse campo é usado para identificar se um pagamento é PNF (pagamento no fluxo). Pagamento no fluxo é uma forma de liberação de dinheiro em que as parcelas recebidas por um vendedor são liberadas com o passar dos meses (que corresponde ao número de parcelas). Os valores possíveis para este campo são “null” ou “payment_in_flow”.", - "es": "Este campo se utiliza para identificar si un pago es PNF (Pay in Flow). El pago en flujo es una forma de liberación de dinero en la que las cuotas recibidas por un vendedor se van liberando a lo largo de los meses (lo que corresponde al número de cuotas). Los valores posibles para este campo son \"null\" o \"payment_in_flow\"." - } - }, - "counter_currency": { - "type": "string", - "format": "nullable", - "description": { - "en": "Basically, it is an object that will allow you to convert payments of the CBT (Cross Border Trade) type into dollars, which are international payments made in foreign currency.", - "pt": "Basicamente, é um objeto que permitirá converter em dólares pagamentos do tipo CBT (Cross Border Trade), que são pagamentos internacionais, feitos em moeda estrangeira.", - "es": "Básicamente, es un objeto que te permitirá convertir pagos del tipo CBT (Cross Border Trade) en dólares, que son pagos internacionales realizados en moneda extranjera." - } - }, - "collector_id": { - "type": "string", - "example": 2, - "description": { - "en": "It is the user who receives the money. Ex - A user (payer) buys a cell phone through the marketplace. The identifier of the store/seller to receive the payment is the collector_id.", - "pt": "É o usuário que recebe o dinheiro. Por exemplo - Um usuário (payer) compra um celular pelo marketplace. O identificador da loja/vendedor a receber o pagamento é o collector_id.", - "es": "Es el usuario quien recibe el dinero. Por ejemplo - Un usuario (payer) compra un celular a través del marketplace. El identificador de la tienda/vendedor para recibir el pago es el collector_id." - } - }, - "payer": { - "type": "object", - "description": { - "en": "Payer data - ID (identifying number), email address, identification (type and number of id)", - "pt": "Dados do pagador - ID (número de identificação), e-mail, identificação (tipo e número de documento)", - "es": "Datos del pagador - ID (número identificador), dirección de email, identificación (tipo y número de documento)" - }, - "properties": { - "id": { - "type": "string", - "example": 123, - "description": { - "en": "Payer identifier generated by Mercado Pago.", - "pt": "Identificador de pagador gerado pelo Mercado Pago.", - "es": "Identificador del Payer generado por Mercado Pago." - } - }, - "email": { - "type": "string", - "example": "test_user_80507629@testuser.com", - "description": { - "en": "Email associated with the payer. This value will only return a response when status=approved, status=refunded, or status=charged_back.", - "pt": "Email associado ao payer. Este valor só retornará uma resposta quando status=approved, status=refunded ou status=charged_back.", - "es": "Correo electrónico asociado al payer. Este valor sólo devolverá una respuesta cuando el status=approved, status=refunded o status=charged_back." - } - }, - "identification": { - "type": "object", - "description": { - "en": "User's personal identification. As an example, in Brazil, we have the CPF (Individual Taxpayer Registry) and the CNPJ (National Corporate Taxpayer Registry), for companies. Other possible identification codes are CURP (Mexico), CUIL (Argentina). This object will only return a response when status=approved, status=refunded or status=charged_back.", - "pt": "Identificação pessoal do usuário. Como exemplo, a nível Brasil, temos o CPF (Cadastro de Pessoa Física) e o CNPJ (Cadastro Nacional de Pessoas Jurídicas), para empresas. Outros códigos de identificação possíveis são o CURP (México), CUIL (Argentina), Este objeto só retornará uma response quando status=approved, status=refunded or status=charged_back.", - "es": "Identificación personal del usuario. Como ejemplo, en Brasil, existe el CPF (Registro de Contribuyentes Individuales) y el CNPJ (Registro Nacional de Contribuyentes de Personas Jurídicas), para empresas. Otros posibles códigos de identificación son CURP (México), CUIL (Argentina). Este objeto sólo devolverá una respuesta cuando status=approved, status=refunded or status=charged_back." - }, - "properties": { - "type": { - "type": "string", - "example": "CPF", - "description": { - "en": "Refers to the type of identification. It can be one of the following types.", - "pt": "Refere-se ao tipo de identificação. Pode ser dos seguintes tipos.", - "es": "Se refiere al tipo de identificación. Puede ser de los siguientes tipos." - }, - "enum": [ - { - "title": "CPF", - "description": { - "en": "Individual Taxpayer Registration, Brazil.", - "es": "Individual Taxpayer Registration, Brazil.", - "pt": "Individual Taxpayer Registration, Brazil." - } - }, - { - "title": "CNPJ", - "description": { - "en": "National Register of Legal Entities, Brazil.", - "es": "National Register of Legal Entities, Brazil.", - "pt": "National Register of Legal Entities, Brazil." - } - }, - { - "title": "CUIT", - "description": { - "en": "Unique Tax Identification Code, Argentina.", - "es": "Unique Tax Identification Code, Argentina.", - "pt": "Unique Tax Identification Code, Argentina." - } - }, - { - "title": "CUIL", - "description": { - "en": "Unique Labor Identification Code, Argentina.", - "es": "Unique Labor Identification Code, Argentina.", - "pt": "Unique Labor Identification Code, Argentina." - } - }, - { - "title": "DNI", - "description": { - "en": "National Identity Document, Argentina.", - "es": "National Identity Document, Argentina.", - "pt": "National Identity Document, Argentina." - } - }, - { - "title": "CURP", - "description": { - "en": "Single Population Registration Code, Mexico.", - "es": "Single Population Registration Code, Mexico.", - "pt": "Single Population Registration Code, Mexico." - } - }, - { - "title": "RFC", - "description": { - "en": "Federal Registry of Taxpayers, Mexico.", - "es": "Federal Registry of Taxpayers, Mexico.", - "pt": "Federal Registry of Taxpayers, Mexico." - } - }, - { - "title": "CC", - "description": { - "en": "Citizenship Card, Colombia.", - "es": "Citizenship Card, Colombia.", - "pt": "Citizenship Card, Colombia." - } - }, - { - "title": "RUT", - "description": { - "en": "Single Tax List, Chile.", - "es": "Single Tax List, Chile.", - "pt": "Single Tax List, Chile." - } - }, - { - "title": "CI", - "description": { - "en": "Identity Card, Uruguay.", - "es": "Identity Card, Uruguay.", - "pt": "Identity Card, Uruguay." - } - } - ] - }, - "number": { - "type": "string", - "example": 19119119100, - "description": { - "en": "The number refers to the user’s identifier. If it is a CPF, for example, it will have 11 numbers.", - "pt": "O número se refere ao identificador do usuário em questão. Se for um CPF, por exemplo, terá 11 números.", - "es": "El número hace referencia al identificador del usuario en cuestión. Si es un CPF, por ejemplo, tendrá 11 números." - } - } - } - }, - "type": { - "$ref": "#/components/schemas/payer_type" - } - } - }, - "metadata": { - "type": "object", - "description": { - "en": "This is an optional key-value object where the customer can add additional information that needs to be recorded at checkout. Ex - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "pt": "Este é um objeto opcional do tipo chave-valor no qual o cliente pode adicionar informações adicionais que precisam ser registradas no pagamento. Por exemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "es": "Este es un objeto clave-valor opcional en el que el cliente puede agregar información adicional que debe registrarse al finalizar la compra. Por ejemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}." - } - }, - "additional_info": { - "type": "object", - "description": { - "en": "At Payments level, it's only data, and we only forward that information to other APIs like Risk, to perform scoring and prevent fraud, or to Tax, to determine them for international payments.", - "pt": "No nível de Pagamentos, são apenas dados e apenas encaminhamos essas informações para outras APIS, como Risco, para realizar pontuação e prevenir fraudes, para Impostos para determiná-los para pagamentos internacionais.", - "es": "En el nivel de Pagos, son solo datos y únicamente reenviamos esa información a otras API, como Riesgo, para realizar puntajes y prevenir fraudes, o a Impuestos, para determinarlos para pagos internacionales." - } - }, - "external_reference": { - "type": "string", - "format": "nullable", - "description": { - "en": "It is a payment external reference. It could be, for example, a hashcode from the Central Bank, working as a transaction origin identifier.", - "pt": "É uma referência externa do pagamento. Pode ser, por exemplo, um hashcode do Banco Central, funcionando como identificador de origem da transação.", - "es": "Es una referencia de pago externa. Podría ser, por ejemplo, un hashcode del Banco Central, funcionando como identificador del origen de la transacción." - } - }, - "transaction_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Product cost. Example - The sale of a product for R$100.00 will have a transactionAmount = 100.", - "pt": "Custo do produto. Exemplo - A venda de um produto por R$100,00 terá um transactionAmount = 100.", - "es": "Costo del producto. Ejemplo - La venta de un producto por R$ 100,00 tendrá un transactionAmount = 100." - } - }, - "transaction_amount_refunded": { - "type": "number", - "example": 0, - "description": { - "en": "Transaction amount refunded", - "pt": "Valor reembolsado da transação", - "es": "Monto reembolsado de transacción" - } - }, - "coupon_amount": { - "type": "number", - "example": 0, - "description": { - "en": "It is the value of the discount coupon. E.g. - BRL 14.50. The attribute's type is BigDecimal.", - "pt": "É o valor do cupom de desconto. Ex - R$14,50. O tipo do atributo é BigDecimal.", - "es": "Es el valor del cupón de descuento. Por ejemplo - BRL 14,50. El tipo del atributo es BigDecimal." - } - }, - "differential_pricing_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Attribute that commonly contains an agreement on how much the user will be charged (generally, this field is more relevant for Marketplace payments). Pricing and fees are calculated based on this identifier.", - "pt": "Atributo que comumente contém um acordo de quanto vai ser cobrado do usuário (geralmente, este campo é mais relevante para pagamentos do Marketplace). A precificação e as taxas são calculadas com base nesse identificador.", - "es": "Atributo que comúnmente contiene un acuerdo sobre cuánto se le cobrará al usuario (generalmente, este campo es más relevante para los pagos de Marketplace). Los precios y las tarifas se calculan en función de este identificador." - } - }, - "deduction_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "Pricing Scheme applied by Mercado Pago. It is a field that represents the information of a type of financing (installment). Ex - “ahora12” is a schema that indicates that the payment is divided into 12 installments. In addition, financing may have an additional cost, such cost being included in that same answer and pointed out to whom this applies (payer/collector).", - "pt": "Esquema de Pricing aplicado pelo Mercado Pago. É um campo que representa as informações de um tipo de financiamento (parcelamento). Ex. - “ahora12” é um schema que indica que o pagamento está parcelado em 12 vezes. Em adição, o financiamento pode ter um custo adicional, sendo tal custo incluído nessa mesma resposta e apontado a quem se aplica isso (payer/collector).", - "es": "Esquema de precios aplicado por Mercado Pago. Es un campo que representa la información de un tipo de financiamiento (cuota). Ej - “ahora12” es un esquema que indica que el pago se divide en 12 cuotas. Además, el financiamiento puede tener un costo adicional, siendo incluido dicho costo en esa misma respuesta y señalándose a quién aplica (payer/collector)." - } - }, - "transaction_details": { - "type": "object", - "description": { - "en": "Transaction details", - "pt": "Detalhes da transação", - "es": "Detalles de la transacción" - }, - "properties": { - "net_received_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Net amount received", - "pt": "Valor líquido recebido", - "es": "Monto neto recibido" - } - }, - "total_paid_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Total amount charged to the payer", - "pt": "Valor total cobrado ao pagador", - "es": "Monto total cobrado al payer" - } - }, - "overpaid_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Overpaid amount", - "pt": "Valor pago a mais", - "es": "Monto pagado en exceso" - } - }, - "external_resource_url": { - "type": "string", - "format": "nullable", - "description": { - "en": "External resource url", - "pt": "URL de recurso externo", - "es": "URL de recurso externo" - } - }, - "installment_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Amount of the chosen financing fee.", - "pt": "Valor da taxa de financiamento escolhida.", - "es": "Monto de la cuota de financiación elegida." - } - }, - "financial_institution": { - "type": "string", - "format": "nullable", - "description": { - "en": "Financial institution", - "pt": "Instituição financeira", - "es": "Institución financiera" - } - }, - "payment_method_reference_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Unique identifier of the payment method", - "pt": "Identificador único do meio de pagamento", - "es": "Identificador único del método de pago" - } - }, - "payable_deferral_period": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment deferral period", - "pt": "Período de diferimento de pagamento", - "es": "Período de diferimiento del pago" - } - }, - "acquirer_reference": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer reference", - "pt": "Referência do adquirente", - "es": "Referencia de adquirente" - } - } - } - }, - "captured": { - "type": "boolean", - "description": { - "en": "Indicates if the payment amount was captured or is pending capture.", - "pt": "Indica se o valor do pagamento foi capturado ou está com captura pendente.", - "es": "Indica si el monto del pago fue capturado o se encuentra pendiente de captura." - } - }, - "binary_mode": { - "type": "boolean", - "description": { - "en": "When set to TRUE, payments can only be approved or rejected. Otherwise they can also result in_process.", - "pt": "Quando definido como TRUE, os pagamentos só podem ser aprovados ou rejeitados. Caso contrário, eles também podem resultar in_process.", - "es": "Cuando se configura como TRUE los pagos sólo pueden resultar aprobados o rechazados. Caso contrario también pueden resultar in_process." - } - }, - "call_for_authorize_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Identifier that is provided to the issuing bank so that payments can be authorized.", - "pt": "Identificador que é fornecido ao banco emissor para que os pagamentos possam ser autorizados.", - "es": "Identificador que se proporciona al banco emisor para que se pueda autorizar los pagos." - } - }, - "statement_descriptor": { - "type": "string", - "format": "nullable", - "description": { - "en": "Description that the payment will appear with in the card statement (eg MERCADOPAGO)", - "pt": "Descrição com a qual o pagamento aparecerá no resumo do cartão (ex. MERCADOPAGO)", - "es": "Descripción con la que aparecerá el pago en el resumen de tarjeta (ej. MERCADOPAGO)" - } - }, - "installments": { - "type": "number", - "example": 1, - "description": { - "en": "Number of installments selected.", - "pt": "Número de parcelas selecionado", - "es": "Cantidad seleccionada de cuotas" - } - }, - "card": { - "type": "object", - "description": { - "en": "Card ID.", - "pt": "Identificador de cartão", - "es": "Identificador de tarjeta" - } - }, - "notification_url": { - "type": "string", - "format": "nullable", - "description": { - "en": "Notifications URL available to receive notifications of events related to Payment.", - "pt": "URL de notificações disponível para receber notificações de eventos relacionados ao Pagamento.", - "es": "URL de Notificaciones disponibilizada para recibir las notificaciones de los eventos relacionados al Pago." - } - }, - "processing_mode": { - "type": "string", - "format": "nullable", - "description": { - "en": "Processing mode. There are two types.", - "pt": "Modo de processamento. Existem dois tipos.", - "es": "Modo de procesamiento. Existen dos tipos." - }, - "enum": [ - { - "title": "Aggregator", - "description": { - "en": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer.", - "es": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer.", - "pt": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer." - } - }, - { - "title": "Gateway", - "description": { - "en": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment.", - "es": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment.", - "pt": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment." - } - } - ] - }, - "merchant_account_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant store code identifier. Applies only to the gateway model (since the delivery of money to the merchant does not go through the Mercado Pago system).", - "pt": "Identificador do código da loja comerciante. Aplica-se somente ao modelo gateway (porque a entrega de dinheiro ao comerciante não passa pelo sistema do Mercado Pago).", - "es": "Identificador del código de la tienda del merchant. Aplica solo para el modelo de gateway (ya que la entrega de dinero al comercio no pasa por el sistema de Mercado Pago)." - } - }, - "acquirer": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer.", - "pt": "Adquirente.", - "es": "Adquirente." - } - }, - "merchant_number": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant number (Applies to gateway model).", - "pt": "Número do estabelecimento (aplica-se ao modelo de gateway).", - "es": "Número de comercio (Aplica para modelo gateway)." - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "Params Error.", - "es": "Params Error.", - "pt": "Params Error." - } - }, - { - "title": "3", - "description": { - "en": "Token must be for test.", - "es": "Token must be for test.", - "pt": "Token must be for test." - } - }, - { - "title": "5", - "description": { - "en": "Must provide your access_token to proceed.", - "es": "Must provide your access_token to proceed.", - "pt": "Must provide your access_token to proceed." - } - }, - { - "title": "1000", - "description": { - "en": "Number of rows exceeded the limits.", - "es": "Number of rows exceeded the limits.", - "pt": "Number of rows exceeded the limits." - } - }, - { - "title": "1001", - "description": { - "en": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.", - "es": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.", - "pt": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ." - } - }, - { - "title": "2001", - "description": { - "en": "Already posted the same request in the last minute.", - "es": "Already posted the same request in the last minute.", - "pt": "Already posted the same request in the last minute." - } - }, - { - "title": "2002", - "description": { - "en": "Customer not found.", - "es": "Customer not found.", - "pt": "Customer not found." - } - }, - { - "title": "2004", - "description": { - "en": "POST to Gateway Transactions API fail.", - "es": "POST to Gateway Transactions API fail.", - "pt": "POST to Gateway Transactions API fail." - } - }, - { - "title": "2006", - "description": { - "en": "Card Token not found.", - "es": "Card Token not found.", - "pt": "Card Token not found." - } - }, - { - "title": "2007", - "description": { - "en": "Connection to Card Token API fail.", - "es": "Connection to Card Token API fail.", - "pt": "Connection to Card Token API fail." - } - }, - { - "title": "2009", - "description": { - "en": "Card token issuer can't be null.", - "es": "Card token issuer can't be null.", - "pt": "Card token issuer can't be null." - } - }, - { - "title": "3000", - "description": { - "en": "You must provide your cardholder_name with your card data.", - "es": "You must provide your cardholder_name with your card data.", - "pt": "You must provide your cardholder_name with your card data." - } - }, - { - "title": "3001", - "description": { - "en": "You must provide your cardissuer_id with your card data.", - "es": "You must provide your cardissuer_id with your card data.", - "pt": "You must provide your cardissuer_id with your card data." - } - }, - { - "title": "3003", - "description": { - "en": "Invalid card_token_id.", - "es": "Invalid card_token_id.", - "pt": "Invalid card_token_id." - } - }, - { - "title": "3004", - "description": { - "en": "Invalid parameter site_id.", - "es": "Invalid parameter site_id.", - "pt": "Invalid parameter site_id." - } - }, - { - "title": "3005", - "description": { - "en": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource.", - "es": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource.", - "pt": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource." - } - }, - { - "title": "3006", - "description": { - "en": "Invalid parameter cardtoken_id.", - "es": "Invalid parameter cardtoken_id.", - "pt": "Invalid parameter cardtoken_id." - } - }, - { - "title": "3007", - "description": { - "en": "The parameter client_id can not be null or empty.", - "es": "The parameter client_id can not be null or empty.", - "pt": "The parameter client_id can not be null or empty." - } - }, - { - "title": "3008", - "description": { - "en": "Not found Cardtoken.", - "es": "Not found Cardtoken.", - "pt": "Not found Cardtoken." - } - }, - { - "title": "3009", - "description": { - "en": "unauthorized client_id.", - "es": "unauthorized client_id.", - "pt": "unauthorized client_id." - } - }, - { - "title": "3010", - "description": { - "en": "Not found card on whitelist.", - "es": "Not found card on whitelist.", - "pt": "Not found card on whitelist." - } - }, - { - "title": "3011", - "description": { - "en": "Not found payment_method.", - "es": "Not found payment_method.", - "pt": "Not found payment_method." - } - }, - { - "title": "3012", - "description": { - "en": "Invalid parameter security_code_length.", - "es": "Invalid parameter security_code_length.", - "pt": "Invalid parameter security_code_length." - } - }, - { - "title": "3013", - "description": { - "en": "The parameter security_code is a required field can not be null or empty.", - "es": "The parameter security_code is a required field can not be null or empty.", - "pt": "The parameter security_code is a required field can not be null or empty." - } - }, - { - "title": "3014", - "description": { - "en": "Invalid parameter payment_method.", - "es": "Invalid parameter payment_method.", - "pt": "Invalid parameter payment_method." - } - }, - { - "title": "3015", - "description": { - "en": "Invalid parameter card_number_length.", - "es": "Invalid parameter card_number_length.", - "pt": "Invalid parameter card_number_length." - } - }, - { - "title": "3016", - "description": { - "en": "Invalid parameter card_number.", - "es": "Invalid parameter card_number.", - "pt": "Invalid parameter card_number." - } - }, - { - "title": "3017", - "description": { - "en": "The parameter card_number_id can not be null or empty.", - "es": "The parameter card_number_id can not be null or empty.", - "pt": "The parameter card_number_id can not be null or empty." - } - }, - { - "title": "3018", - "description": { - "en": "The parameter expiration_month can not be null or empty.", - "es": "The parameter expiration_month can not be null or empty.", - "pt": "The parameter expiration_month can not be null or empty." - } - }, - { - "title": "3019", - "description": { - "en": "The parameter expiration_year can not be null or empty.", - "es": "The parameter expiration_year can not be null or empty.", - "pt": "The parameter expiration_year can not be null or empty." - } - }, - { - "title": "3020", - "description": { - "en": "The parameter cardholder.name can not be null or empty.", - "es": "The parameter cardholder.name can not be null or empty.", - "pt": "The parameter cardholder.name can not be null or empty." - } - }, - { - "title": "3021", - "description": { - "en": "The parameter cardholder.document.number can not be null or empty.", - "es": "The parameter cardholder.document.number can not be null or empty.", - "pt": "The parameter cardholder.document.number can not be null or empty." - } - }, - { - "title": "3022", - "description": { - "en": "The parameter cardholder.document.type can not be null or empty.", - "es": "The parameter cardholder.document.type can not be null or empty.", - "pt": "The parameter cardholder.document.type can not be null or empty." - } - }, - { - "title": "3023", - "description": { - "en": "The parameter cardholder.document.subtype can not be null or empty.", - "es": "The parameter cardholder.document.subtype can not be null or empty.", - "pt": "The parameter cardholder.document.subtype can not be null or empty." - } - }, - { - "title": "3024", - "description": { - "en": "Not valid action - partial refund unsupported for this transaction.", - "es": "Not valid action - partial refund unsupported for this transaction.", - "pt": "Not valid action - partial refund unsupported for this transaction." - } - }, - { - "title": "3025", - "description": { - "en": "Invalid Auth Code.", - "es": "Invalid Auth Code.", - "pt": "Invalid Auth Code." - } - }, - { - "title": "3026", - "description": { - "en": "Invalid card_id for this payment_method_id.", - "es": "Invalid card_id for this payment_method_id.", - "pt": "Invalid card_id for this payment_method_id." - } - }, - { - "title": "3027", - "description": { - "en": "Invalid payment_type_id.", - "es": "Invalid payment_type_id.", - "pt": "Invalid payment_type_id." - } - }, - { - "title": "3028", - "description": { - "en": "Invalid payment_method_id.", - "es": "Invalid payment_method_id.", - "pt": "Invalid payment_method_id." - } - }, - { - "title": "3029", - "description": { - "en": "Invalid card expiration month.", - "es": "Invalid card expiration month.", - "pt": "Invalid card expiration month." - } - }, - { - "title": "3030", - "description": { - "en": "Invalid card expiration year.", - "es": "Invalid card expiration year.", - "pt": "Invalid card expiration year." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "4", - "description": { - "en": "The caller is not authorized to access this resource.", - "es": "The caller is not authorized to access this resource.", - "pt": "The caller is not authorized to access this resource." - } - }, - { - "title": "3002", - "description": { - "en": "The caller is not authorized to perform this action.", - "es": "The caller is not authorized to perform this action.", - "pt": "The caller is not authorized to perform this action." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "2000", - "description": { - "en": "Payment not found.", - "es": "Payment not found.", - "pt": "Payment not found." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Get payment", - "pt": "Obter pagamento", - "es": "Obtener pago" - } - }, - "put": { - "tags": [ - "checkout-pro", - "subscriptions", - "checkout-api" - ], - "description": { - "en": "Renew the details of a payment when you need it. Indicate the payment ID and send the parameters with the information you want to update", - "pt": "Altera os dados de um pagamento quando necessário. Indique a identificação do pagamento e envie os parâmetros com as informações que você deseja atualizar", - "es": "Renueva los datos de un pago cuando lo necesites. Indica el ID del pago y envía los parámetros con la información que quieras actualizar" - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": { - "en": "Unique Payment Identifier, automatically generated by Mercado Pago", - "pt": "Identificador único de pagamento, gerado automaticamente pelo Mercado Pago", - "es": "Identificador único del pago, generado automáticamente por Mercado Pago" - }, - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "capture": { - "type": "boolean", - "description": { - "en": "It is a boolean field found in two-step payments (like debit card). In this type of payment, which is carried out asynchronously, the purchase value is first reserved (capture = false). This amount is captured and not debited from the account instantly. When the money is actually transferred to the collector (who receives the payment) the amount is captured (capture = true).", - "pt": "É um campo booleano existente em pagamentos de duas etapas (como o cartão de débito). Nesse tipo de pagamento, que é realizado de modo assíncrono, primeiro é feito a reserva do valor da compra (capture = false). Esse valor é capturado e não é debitado da conta instantaneamente. Quando o dinheiro é de fato transferido ao collector (quem recebe o pagamento) a captura do montante é feita (capture = true).", - "es": "Es un campo booleano que se encuentra en pagos de dos pasos (como tarjeta de débito). En este tipo de pago, que se realiza de forma asíncrona, primero se reserva el valor de la compra (capture = false). Esta cantidad se captura y no se debita de la cuenta al instante. Cuando el dinero se transfiere realmente al cobrador (que recibe el pago), se captura la cantidad (capture = true)." - }, - "example": true - }, - "date_of_expiration": { - "type": "string", - "format": "date", - "description": { - "en": "Payment’s expiration date. The valid format of the attribute is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex - 2022-11-17T09:37:52.000-04:00.", - "pt": "Data de expiração do pagamento. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Por exemplo - 2022-11-17T09:37:52.000-04:00.", - "es": "Fecha de vencimiento del pago. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Por ejemplo - 2022-11-17T09:37:52.000-04:00." - } - }, - "status": { - "type": "string", - "description": { - "en": "It is the current state of payment. It can be two following types.", - "pt": "É o estado atual do pagamento. Podem ser ser dos seguintes tipos", - "es": "Es el estado actual de pago. Puede ser de dos tipos siguientes." - }, - "example": "cancelled", - "enum": [ - { - "title": "pending", - "description": { - "en": "The user has not concluded the payment process (for example, to generate a payment by boleto, this payment will be concluded at the moment in which the user makes the non-corresponding payment selected);", - "es": "The user has not concluded the payment process (for example, to generate a payment by boleto, this payment will be concluded at the moment in which the user makes the non-corresponding payment selected);", - "pt": "The user has not concluded the payment process (for example, to generate a payment by boleto, this payment will be concluded at the moment in which the user makes the non-corresponding payment selected);" - } - }, - { - "title": "approved", - "description": { - "en": "The payment was approved and credited;", - "es": "The payment was approved and credited;", - "pt": "The payment was approved and credited;" - } - }, - { - "title": "authorized", - "description": { - "en": "The payment was authorized, but still was not captured;", - "es": "The payment was authorized, but still was not captured;", - "pt": "The payment was authorized, but still was not captured;" - } - }, - { - "title": "in_process", - "description": { - "en": "The payment is in analysis;", - "es": "The payment is in analysis;", - "pt": "The payment is in analysis;" - } - }, - { - "title": "in_mediation", - "description": { - "en": "The user started a dispute;", - "es": "The user started a dispute;", - "pt": "The user started a dispute;" - } - }, - { - "title": "rejected", - "description": { - "en": "The payment was rejected. (The user can try the payment again);", - "es": "The payment was rejected. (The user can try the payment again);", - "pt": "The payment was rejected. (The user can try the payment again);" - } - }, - { - "title": "cancelled", - "description": { - "en": "Either the payment was canceled by one of the parties or the payment expired;", - "es": "Either the payment was canceled by one of the parties or the payment expired;", - "pt": "Either the payment was canceled by one of the parties or the payment expired;" - } - }, - { - "title": "refunded", - "description": { - "en": "The payment was returned to the user;", - "es": "The payment was returned to the user;", - "pt": "The payment was returned to the user;" - } - }, - { - "title": "charged_back", - "description": { - "en": "A chargeback was placed on the buyer's credit card.", - "es": "A chargeback was placed on the buyer's credit card.", - "pt": "A chargeback was placed on the buyer's credit card." - } - } - ] - }, - "transaction_amount": { - "type": "number", - "description": { - "en": "Product cost. Example - The sale of a product for R$100.00 will have a transactionAmount = 100.", - "pt": "Custo do produto. Exemplo - A venda de um produto por R$100,00 terá um transactionAmount = 100.", - "es": "Costo del producto. Ejemplo - La venta de un producto por R$ 100,00 tendrá un transactionAmount = 100." - }, - "example": 58.8 - } - } - } - } - } - }, - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Success", - "en": "Success" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "number", - "example": 20359978, - "description": { - "en": "Unique Payment Identifier, automatically generated by Mercado Pago", - "pt": "Identificador único de pagamento, gerado automaticamente pelo Mercado Pago", - "es": "Identificador único del pago, generado automáticamente por Mercado Pago" - } - }, - "date_created": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Payment creation date.", - "pt": "Data de criação do pagamento.", - "es": "Fecha de creación del Pago." - } - }, - "date_approved": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Payment approval date. A payment can be generated in an intermediate state and then approved, so the creation date will not always coincide with the Approval Date.", - "pt": "Data de aprovação do pagamento. Um pagamento pode ser gerado em um estado intermediário e depois aprovado, portanto, a data de criação nem sempre coincidirá com a Data de Aprovação.", - "es": "Fecha de aprobación del Pago. Un pago puede generarse en un estado intermedio y luego ser aprobado, por tanto la fecha de creación no siempre coincidirá con la Fecha de Aprobación." - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Date on which the last payment event was recorded.", - "pt": "Data em que o último evento de pagamento foi registrado.", - "es": "Fecha en la que se registró el ultimo evento sobre el pago." - } - }, - "date_of_expiration": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment’s expiration date. The attribute’s valid format is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "pt": "Data de expiração do pagamento. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "es": "Fecha de vencimiento del pago. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Ej. - 2022-11-17T09:37:52.000-04:00." - } - }, - "money_release_date": { - "type": "string", - "example": "2019-07-24T14:47:58.000Z", - "description": { - "en": "Date on which the payment is settled and the money is made available in the Mercado Pago account of the Collector (the one who receives the payment). The field can take on the values “pending” or “released”, where the first indicates that the payment has not yet been released (money held for a period) and “released” means that the money has already been released to the user's available balance.", - "pt": "Data em que o pagamento é liquidado e o dinheiro é disponibilizado na conta Mercado Pago do Collector (aquele que recebe o pagamento). O campo pode assumir os valores “pending” ou “released”, sendo que o primeiro indica que o pagamento ainda não foi liberado (dinheiro retido por tempo) e “released” significa que o dinheiro já foi liberado para o saldo disponível do usuário.", - "es": "Fecha en que se liquida el pago y se pone a disposición el dinero en la cuenta de Mercado Pago del Collector (el que recibe el pago). El campo puede tomar los valores “pending” o “released”, siendo que el primero indica que el pago todavía no fue liberado (dinero retenido por tiempo) y “released” significa que el dinero ya fue liberado al disponible del usuario." - } - }, - "operation_type": { - "$ref": "#/components/schemas/operation_type" - }, - "issuer_id": { - "type": "string", - "example": 25, - "description": { - "en": "Is the identifier of the card issuer being used in a credit or debit card payment.", - "pt": "É o identificador do emissor do cartão que está sendo utilizado em um pagamento com cartão de crédito ou débito.", - "es": "Es el identificador del emisor de la tarjeta que se utiliza en un pago con tarjeta de crédito o débito." - } - }, - "payment_method_id": { - "type": "string", - "example": "visa", - "description": { - "en": "It indicates the identifier of the payment method selected to make the transaction. Here are some examples. Get all available payment methods by consulting the 'Get payment Methods API'.", - "pt": "Indica o identificador do meio de pagamento selecionado para efetuar o pagamento. A seguir, apresentamos alguns exemplos. Obtenha todos os meios de pagamento disponíveis consultando a API de 'Obter meios de pagamento'.", - "es": "Identificador del medio de pago. Indica el ID del medio de pago seleccionado para realizar el pago. A continuación presentamos algunos ejemplos. Obtén todos los métodos de pago disponibles consultando la API de 'Obtener métodos de pago'." - }, - "enum": [ - { - "title": "pix", - "description": { - "en": "Instant digital payment method used in Brazil;", - "es": "Instant digital payment method used in Brazil;", - "pt": "Instant digital payment method used in Brazil;" - } - }, - { - "title": "account_money", - "description": { - "en": "When the payment is debited directly from a Mercado Pago account;", - "es": "When the payment is debited directly from a Mercado Pago account;", - "pt": "When the payment is debited directly from a Mercado Pago account;" - } - }, - { - "title": "debin_transfer", - "description": { - "en": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization;", - "es": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization;", - "pt": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization;" - } - }, - { - "title": "ted", - "description": { - "en": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;", - "es": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;", - "pt": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period;" - } - }, - { - "title": "cvu", - "description": { - "en": "Payment method used in Argentina;", - "es": "Payment method used in Argentina;", - "pt": "Payment method used in Argentina;" - } - }, - { - "title": "pse", - "description": { - "en": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts.", - "es": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts.", - "pt": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts." - } - } - ] - }, - "payment_type_id": { - "$ref": "#/components/schemas/payment_type_id" - }, - "status": { - "$ref": "#/components/schemas/status" - }, - "status_detail": { - "type": "string", - "example": "accredited", - "description": { - "en": "Detail in which the Collection resulted", - "pt": "Detalhe em que resultou a Coleção", - "es": "Detalle en el que resultó el Cobro" - }, - "enum": [ - { - "title": "Accredited", - "description": { - "en": "credited payment.", - "es": "credited payment.", - "pt": "credited payment." - } - }, - { - "title": "pending_contingency", - "description": { - "en": "the payment is being processed.", - "es": "the payment is being processed.", - "pt": "the payment is being processed." - } - }, - { - "title": "pending_review_manual", - "description": { - "en": "the payment is under review to determine its approval or rejection.", - "es": "the payment is under review to determine its approval or rejection.", - "pt": "the payment is under review to determine its approval or rejection." - } - }, - { - "title": "cc_rejected_bad_filled_date", - "description": { - "en": "incorrect expiration date.", - "es": "incorrect expiration date.", - "pt": "incorrect expiration date." - } - }, - { - "title": "cc_rejected_bad_filled_other", - "description": { - "en": "incorrect card details.", - "es": "incorrect card details.", - "pt": "incorrect card details." - } - }, - { - "title": "cc_rejected_bad_filled_security_code", - "description": { - "en": "incorrect CVV.", - "es": "incorrect CVV.", - "pt": "incorrect CVV." - } - }, - { - "title": "cc_rejected_blacklist", - "description": { - "en": "the card is on a black list for theft/complaints/fraud.", - "es": "the card is on a black list for theft/complaints/fraud.", - "pt": "the card is on a black list for theft/complaints/fraud." - } - }, - { - "title": "cc_rejected_call_for_authorize", - "description": { - "en": "the means of payment requires prior authorization of the amount of the operation.", - "es": "the means of payment requires prior authorization of the amount of the operation.", - "pt": "the means of payment requires prior authorization of the amount of the operation." - } - }, - { - "title": "cc_rejected_card_disabled", - "description": { - "en": "the card is inactive.", - "es": "the card is inactive.", - "pt": "the card is inactive." - } - }, - { - "title": "cc_rejected_duplicated_payment", - "description": { - "en": "transacción duplicada.", - "es": "transacción duplicada.", - "pt": "transacción duplicada." - } - }, - { - "title": "cc_rejected_high_risk", - "description": { - "en": "rechazo por Prevención de Fraude.", - "es": "rechazo por Prevención de Fraude.", - "pt": "rechazo por Prevención de Fraude." - } - }, - { - "title": "cc_rejected_insufficient_amount", - "description": { - "en": "insufficient amount.", - "es": "insufficient amount.", - "pt": "insufficient amount." - } - }, - { - "title": "cc_rejected_invalid_installments", - "description": { - "en": "invalid number of installments.", - "es": "invalid number of installments.", - "pt": "invalid number of installments." - } - }, - { - "title": "cc_rejected_max_attempts", - "description": { - "en": "exceeded maximum number of attempts.", - "es": "exceeded maximum number of attempts.", - "pt": "exceeded maximum number of attempts." - } - }, - { - "title": "cc_rejected_other_reason", - "description": { - "en": "generic error.", - "es": "generic error.", - "pt": "generic error." - } - } - ] - }, - "currency_id": { - "$ref": "#/components/schemas/currency_id" - }, - "description": { - "type": "string", - "example": "Point Mini a maquininha que dá o dinheiro de suas vendas na hora", - "description": { - "en": "Purchased product’s description, the reason for payment. E.g. - \"Xiaomi Redmi Note 11S mobile phone 128gb 6gb Ram Original Global Blue Version\" (description of a product in the marketplace).", - "pt": "Descrição do produto comprado, a razão de pagamento. Ex. - \"Celular Xiaomi Redmi Note 11S 128gb 6gb Ram Versão Global Original azul\" (descrição de um produto no marketplace).", - "es": "Descripción del producto adquirido, el motivo del pago. Ej. - \"Celular Xiaomi Redmi Note 11S 128gb 6gb Ram Original Global Blue Version\" (descripción de un producto en el marketplace)." - } - }, - "live_mode": { - "type": "boolean", - "description": { - "en": "Indicates whether the Payment was made in a production environment or in a Test environment. If TRUE, then the chargeback will be processed in production mode. If FALSE, then the chargeback will be processed in sandbox mode.", - "pt": "Indica se o Pagamento foi feito em ambiente de produção ou em ambiente de Teste. Se TRUE, o estorno será processado em modo de produção. Se FALSE, o estorno será processado no modo sandbox.", - "es": "Indica si el Pago se realizó en ambiente productivo o en un ambiente de Test. Si es TRUE, el contracargo se procesará en modo de producción. Si es FALSE, el contracargo se procesará en modo sandbox." - } - }, - "sponsor_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is deprecated and no longer in use.", - "pt": "Este campo está deprecado e não é mais utilizado.", - "es": "Este campo está deprecado y ya no se usa." - } - }, - "authorization_code": { - "type": "string", - "format": "nullable", - "description": { - "en": "Transaction’s authorization code for payments with “payment_method_type” of type “credit_card” (credit card), “debit_card” (debit card) and “voucher_card” (voucher card for benefits, such as Alelo). In summary, this code is used for card transactions. The code is numerical and has 6 digits.", - "pt": "Código de autorização de transação para pagamentos com “payment_method_type” do tipo “credit_card” (cartão de crédito), “debit_card” (cartão de crédito) e “voucher_card” (cartão de voucher para benefícios, como Alelo). Em síntese, este código é utilizado para transações com cartão. O código é numérico e possui 6 dígitos.", - "es": "Código de autorización de transacción para pagos con “payment_method_type” de tipo “credit_card” (tarjeta de crédito), “debit_card” (tarjeta de débito) y “voucher_card” (tarjeta de bono para beneficios, como Alelo). En resumen, este código se utiliza para transacciones con tarjeta. Es numérico y tiene 6 dígitos." - } - }, - "money_release_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is used to identify whether a payment is PNF (Payment in Flow). Payment in flow is a form of cash release in which the installments received by a seller are released over the months (which corresponds to the number of installments). Possible values ​​for this field are “null” or “payment_in_flow”.", - "pt": "Esse campo é usado para identificar se um pagamento é PNF (pagamento no fluxo). Pagamento no fluxo é uma forma de liberação de dinheiro em que as parcelas recebidas por um vendedor são liberadas com o passar dos meses (que corresponde ao número de parcelas). Os valores possíveis para este campo são “null” ou “payment_in_flow”.", - "es": "Este campo se utiliza para identificar si un pago es PNF (Pay in Flow). El pago en flujo es una forma de liberación de dinero en la que las cuotas recibidas por un vendedor se van liberando a lo largo de los meses (lo que corresponde al número de cuotas). Los valores posibles para este campo son \"null\" o \"payment_in_flow\"." - } - }, - "taxes_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Corresponds to the tax values ​​calculated for the payment.", - "pt": "Corresponde aos valores dos impostos calculados para o pagamento.", - "es": "Corresponde a los valores de impuestos calculados para el pago." - } - }, - "counter_currency": { - "type": "string", - "format": "nullable", - "description": { - "en": "Basically, it is an object that will allow you to convert payments of the CBT (Cross Border Trade) type into dollars, which are international payments made in foreign currency.", - "pt": "Basicamente, é um objeto que permitirá converter em dólares pagamentos do tipo CBT (Cross Border Trade), que são pagamentos internacionais, feitos em moeda estrangeira.", - "es": "Básicamente, es un objeto que te permitirá convertir pagos del tipo CBT (Cross Border Trade) en dólares, que son pagos internacionales realizados en moneda extranjera." - } - }, - "shipping_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Amount of charge for shipping the purchase. It is of type BigDecimal.", - "pt": "Valor da cobrança de envio da compra. É do tipo BigDecimal.", - "es": "Importe del cargo por el envío de la compra. Es de tipo BigDecimal." - } - }, - "pos_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Digital identifier of the point of sale (Point of Sale - POS / machine). They are physical points of sale that use a card machine for sales.", - "pt": "Identificador digital do ponto de vendas (Ponto de Venda - PDV / maquininha). São pontos de vendas físicos que utilizam maquininha de cartão para vendas.", - "es": "Identificador digital del punto de venta (Punto de Venta - PDV / máquina). Son puntos de venta físicos que utilizan una máquina de tarjetas para la venta." - } - }, - "store_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Store identifier to which the point of sale belongs.", - "pt": "Identificador da loja à qual o caixa (PDV) pertence.", - "es": "Identificador de la sucursal a la que pertenece el punto de venta (PDV)." - } - }, - "collector_id": { - "type": "number", - "example": 448876418, - "description": { - "en": "It is the user who receives the money. Ex - A user (payer) buys a cell phone through the marketplace. The identifier of the store/seller to receive the payment is the collector_id.", - "pt": "É o usuário que recebe o dinheiro. Por exemplo - Um usuário (payer) compra um celular pelo marketplace. O identificador da loja/vendedor a receber o pagamento é o collector_id.", - "es": "Es el usuario quien recibe el dinero. Por ejemplo - Un usuario (payer) compra un celular a través del marketplace. El identificador de la tienda/vendedor para recibir el pago es el collector_id." - } - }, - "payer": { - "type": "object", - "description": { - "en": "Payer data - ID (identifying number), email address, identification (type and number of id)", - "pt": "Dados do pagador - ID (número de identificação), e-mail, identificação (tipo e número de documento)", - "es": "Datos del pagador - ID (número identificador), dirección de email, identificación (tipo y número de documento)" - }, - "properties": { - "id": { - "type": "string", - "format": "nullable", - "example": 123, - "description": { - "en": "Payer identifier generated by Mercado Pago.", - "pt": "Identificador de pagador gerado pelo Mercado Pago.", - "es": "Identificador del Payer generado por Mercado Pago." - } - }, - "email": { - "type": "string", - "example": "test_user_80507629@testuser.com", - "description": { - "en": "Email associated with the payer. This value will only return a response when status=approved, status=refunded, or status=charged_back.", - "pt": "Email associado ao payer. Este valor só retornará uma resposta quando status=approved, status=refunded ou status=charged_back.", - "es": "Correo electrónico asociado al payer. Este valor sólo devolverá una respuesta cuando el status=approved, status=refunded o status=charged_back." - } - }, - "identification": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": 19119119100, - "description": { - "en": "The number refers to the identifier of the user in question. If it is a CPF, for example, it will have 11 numbers.", - "pt": "O número se refere ao identificador do usuário em questão. Se for um CPF, por exemplo, terá 11 números.", - "es": "El número hace referencia al identificador del usuario en cuestión. Si es un CPF, por ejemplo, tendrá 11 números." - } - }, - "type": { - "type": "string", - "example": "CPF", - "description": { - "en": "Identification type.", - "pt": "Tipo de identificação", - "es": "Tipo de identificación" - } - } - }, - "description": { - "es": "Personal identification. This value will only return a response when status=approved, status=refunded or status=charged_back", - "pt": "Personal identification. This value will only return a response when status=approved, status=refunded or status=charged_back", - "en": "Personal identification. This value will only return a response when status=approved, status=refunded or status=charged_back" - } - }, - "type": { - "$ref": "#/components/schemas/payer_type" - } - } - }, - "metadata": { - "type": "object", - "description": { - "en": "This is an optional key-value object where the customer can add additional information that needs to be recorded at checkout. Ex - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "pt": "Este é um objeto opcional do tipo chave-valor no qual o cliente pode adicionar informações adicionais que precisam ser registradas no pagamento. Ex. - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "es": "Este es un objeto clave-valor opcional en el que el cliente puede agregar información adicional que debe registrarse al finalizar la compra. Por ejemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}" - } - }, - "additional_info": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "PR0001", - "description": { - "en": "It is the purchased product ad identifier. Ex - “MLB2907679857”.", - "pt": "É o identificador do anúncio do produto comprado. Por exemplo - “MLB2907679857”.", - "es": "Es el identificador del anuncio del producto adquirido. Por ejemplo - “MLB2907679857”." - } - }, - "title": { - "type": "string", - "example": "Point Mini", - "description": { - "en": "Item name.", - "pt": "Nome do item", - "es": "Nombre de ítem" - } - }, - "description": { - "type": "string", - "example": "Producto Point para cobros con tarjetas mediante bluetooth", - "description": { - "en": "Long item description.", - "pt": "Descrição do artigo", - "es": "Descripción de item" - } - }, - "picture_url": { - "type": "string", - "example": "https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium2x.png", - "description": { - "en": "Image URL.", - "pt": "URL da imagem", - "es": "URL de imagen" - } - }, - "category_id": { - "type": "string", - "example": "electronics", - "description": { - "en": "Category of the item.", - "pt": "Categoria do item", - "es": "Categoría del ítem" - } - }, - "quantity": { - "type": "number", - "example": 1, - "description": { - "en": "Item quantity.", - "pt": "Quantidade do produto", - "es": "Cantidad de producto" - } - }, - "unit_price": { - "type": "number", - "example": 58.8, - "description": { - "es": "Unit price.", - "pt": "Unit price.", - "en": "Unit price." - } - } - } - }, - "description": { - "en": "List of items to be paid.", - "pt": "Lista de itens a pagar", - "es": "Lista de ítems a pagar" - } - }, - "payer": { - "type": "object", - "description": { - "en": "The payer is the one who makes the payment. This field is an object that has the payer's information.", - "pt": "O payer é aquele que faz o pagamento. Este campo é um objeto que possui as informações do pagador.", - "es": "El payer es quien realiza el pago. Este campo es un objeto que tiene la información del pagador." - }, - "properties": { - "registration_date": { - "type": "string", - "example": "2019-01-01T15:01:01.000Z", - "description": { - "en": "Date of registration of the buyer on your site.", - "pt": "Data de cadastro do comprador em seu site", - "es": "Fecha de registración del comprador en tu sitio" - } - } - } - }, - "shipments": { - "type": "object", - "properties": { - "receiver_address": { - "type": "object", - "properties": { - "street_name": { - "type": "string", - "example": "Av das Nacoes Unidas", - "description": { - "en": "Street name.", - "pt": "Rua", - "es": "Calle" - } - }, - "street_number": { - "type": "number", - "example": 3003, - "description": { - "en": "Number.", - "pt": "Número", - "es": "Número" - } - }, - "zip_code": { - "type": "string", - "example": 6233200, - "description": { - "en": "Zip code.", - "pt": "Código postal", - "es": "Código postal" - } - }, - "city_name": { - "type": "string", - "example": "Buzios", - "description": { - "en": "City Name.", - "pt": "Cidade", - "es": "Ciudad" - } - }, - "state_name": { - "type": "string", - "example": "Rio de Janeiro", - "description": { - "en": "State.", - "pt": "Província", - "es": "Provincia" - } - } - }, - "description": { - "en": "Buyer's address.", - "pt": "Endereço do comprador", - "es": "Dirección del comprador" - } - } - }, - "description": { - "en": "Shipping information.", - "pt": "Informações de envio", - "es": "Información de envío" - } - } - }, - "description": { - "en": "Additional information.", - "pt": "Informações adicionais", - "es": "Información adicional" - } - }, - "external_reference": { - "type": "string", - "example": "MP0001", - "description": { - "en": "It is a payment’s external reference. It could be, for example, a hashcode from the Central Bank, working as a transaction origin identifier.", - "pt": "É uma referência externa do pagamento. Pode ser, por exemplo, um hashcode do Banco Central, funcionando como identificador de origem da transação.", - "es": "Es una referencia de pago externa. Podría ser, por ejemplo, un código hash del Banco Central, funcionando como identificador del origen de la transacción." - } - }, - "transaction_amount": { - "type": "number", - "example": 58.8, - "description": { - "en": "Product cost. Example - The sale of a product for R$100.00 will have a transactionAmount = 100.", - "pt": "Custo do produto. Exemplo - A venda de um produto por R$100,00 terá um transactionAmount = 100.", - "es": "Costo del producto. Ejemplo - La venta de un producto por R$ 100,00 tendrá un transactionAmount = 100." - } - }, - "transaction_amount_refunded": { - "type": "number", - "example": 0, - "description": { - "en": "Transaction amount refunded", - "pt": "Valor reembolsado da transação", - "es": "Monto reembolsado de transacción" - } - }, - "coupon_amount": { - "type": "number", - "example": 0, - "description": { - "en": "It is the value of the discount coupon. E.g. - BRL 14.50. The attribute's type is BigDecimal.", - "pt": "É o valor do cupom de desconto. Ex. - R$14,50. O tipo do atributo é BigDecimal.", - "es": "Es el valor del cupón de descuento. Por ejemplo - BRL 14,50. El tipo del atributo es BigDecimal." - } - }, - "differential_pricing_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Attribute that commonly contains an agreement on how much the user will be charged (generally, this field is more relevant for Marketplace payments). Pricing and fees are calculated based on this identifier.", - "pt": "Atributo que comumente contém um acordo de quanto vai ser cobrado do usuário (geralmente, este campo é mais relevante para pagamentos do Marketplace). A precificação e as taxas são calculadas com base nesse identificador.", - "es": "Atributo que comúnmente contiene un acuerdo sobre cuánto se le cobrará al usuario (generalmente, este campo es más relevante para los pagos de Marketplace). Los precios y las tarifas se calculan en función de este identificador." - } - }, - "deduction_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "Pricing Scheme applied by Mercado Pago. It is a field that represents the information of a type of financing (installment). Ex - “ahora12” is a schema that indicates that the payment is divided into 12 installments. In addition, financing may have an additional cost, such cost being included in that same answer and pointed out to whom this applies (payer/collector).", - "pt": "Esquema de Pricing aplicado pelo Mercado Pago. É um campo que representa as informações de um tipo de financiamento (parcelamento). Ex. - “ahora12” é um schema que indica que o pagamento está parcelado em 12 vezes. Em adição, o financiamento pode ter um custo adicional, sendo tal custo incluído nessa mesma resposta e apontado a quem se aplica isso (payer/collector).", - "es": "Esquema de precios aplicado por Mercado Pago. Es un campo que representa la información de un tipo de financiamiento (cuota). Ej - “ahora12” es un esquema que indica que el pago se divide en 12 cuotas. Además, el financiamiento puede tener un costo adicional, siendo incluido dicho costo en esa misma respuesta y señalándose a quién aplica (payer/collector)." - } - }, - "transaction_details": { - "type": "object", - "properties": { - "payment_method_reference_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Unique identifier of the payment method", - "pt": "Identificador único do meio de pagamento", - "es": "Identificador único del método de pago" - } - }, - "net_received_amount": { - "type": "number", - "example": 56.16, - "description": { - "en": "Net amount received", - "pt": "Valor líquido recebido", - "es": "Monto neto recibido" - } - }, - "total_paid_amount": { - "type": "number", - "example": 58.8, - "description": { - "en": "Total amount charged to the payer", - "pt": "Valor total cobrado ao pagador", - "es": "Monto total cobrado al payer" - } - }, - "overpaid_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Overpaid amount", - "pt": "Valor pago a mais", - "es": "Monto pagado en exceso" - } - }, - "external_resource_url": { - "type": "string", - "format": "nullable", - "description": { - "en": "External resource url", - "pt": "URL de recurso externo", - "es": "URL de recurso externo" - } - }, - "installment_amount": { - "type": "number", - "example": 58.8, - "description": { - "en": "Amount of the chosen financing fee.", - "pt": "Valor da taxa de financiamento escolhida.", - "es": "Monto de la cuota de financiación elegida." - } - }, - "financial_institution": { - "type": "string", - "format": "nullable", - "description": { - "en": "Financial institution", - "pt": "Instituição financeira", - "es": "Institución financiera" - } - }, - "payable_deferral_period": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment deferral period", - "pt": "Período de diferimento de pagamento", - "es": "Período de diferimiento del pago" - } - }, - "acquirer_reference": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer reference", - "pt": "Referência do adquirente", - "es": "Referencia de adquirente" - } - } - }, - "description": { - "en": "Transaction details", - "pt": "Detalhes da transação", - "es": "Detalles de la transacción" - } - }, - "fee_details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/fee_details_type" - }, - "amount": { - "type": "number", - "example": 2.64, - "description": { - "en": "Fee amount.", - "pt": "Valor da comissão", - "es": "Monto de la comisión" - } - }, - "fee_payer": { - "$ref": "#/components/schemas/fee_payer" - } - } - }, - "description": { - "en": "Fee detail.", - "pt": "Detalhe de comissão", - "es": "Detalle de comisión" - } - }, - "captured": { - "type": "boolean", - "description": { - "en": "Indicates if the payment amount was captured or is pending capture.", - "pt": "Indica se o valor do pagamento foi capturado ou está com captura pendente.", - "es": "Indica si el monto del pago fue capturado o se encuentra pendiente de captura." - } - }, - "binary_mode": { - "type": "boolean", - "description": { - "en": "When set to TRUE, payments can only be approved or rejected. Otherwise they can also result in_process.", - "pt": "Quando definido como TRUE, os pagamentos só podem ser aprovados ou rejeitados. Caso contrário, eles também podem resultar in_process.", - "es": "Cuando se configura como TRUE los pagos sólo pueden resultar aprobados o rechazados. Caso contrario también pueden resultar in_process." - } - }, - "call_for_authorize_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Identifier that is provided to the issuing bank so that payments can be authorized.", - "pt": "Identificador que é fornecido ao banco emissor para que os pagamentos possam ser autorizados.", - "es": "Identificador que se proporciona al banco emisor para que se pueda autorizar los pagos." - } - }, - "statement_descriptor": { - "type": "string", - "example": "MercadoPago", - "description": { - "en": "Description that the payment will appear with in the card statement (eg MERCADOPAGO)", - "pt": "Descrição com a qual o pagamento aparecerá no resumo do cartão (ex. MERCADOPAGO)", - "es": "Descripción con la que aparecerá el pago en el resumen de tarjeta (ej. MERCADOPAGO)" - } - }, - "installments": { - "type": "number", - "example": 1, - "description": { - "en": "Number of installments selected.", - "pt": "Número de parcelas selecionado", - "es": "Cantidad seleccionada de cuotas" - } - }, - "card": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Card ID.", - "pt": "Identificador de cartão", - "es": "Identificador de tarjeta" - } - }, - "first_six_digits": { - "type": "string", - "example": 423564, - "description": { - "en": "Card Bin", - "pt": "Bin do cartão", - "es": "Bin de la tarjeta" - } - }, - "last_four_digits": { - "type": "string", - "example": 5682, - "description": { - "en": "last 4 digits of the card", - "pt": "últimos 4 dígitos do cartão", - "es": "últimos 4 digitos de la tarjeta" - } - }, - "expiration_month": { - "type": "number", - "example": 6, - "description": { - "en": "Card's expiration month.", - "pt": "Mês de validade do cartão", - "es": "Mes de expiración de la tarjeta" - } - }, - "expiration_year": { - "type": "number", - "example": 2023, - "description": { - "en": "Card's expiration year.", - "pt": "Ano de validade do cartão", - "es": "Año de expiración de la tarjeta" - } - }, - "date_created": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Card registration date.", - "pt": "Data de registro do cartão.", - "es": "Fecha de registro de la tarjeta." - } - }, - "date_last_updated": { - "type": "string", - "example": "2019-07-10T14:47:58.000Z", - "description": { - "en": "Date on which the last payment event was recorded.", - "pt": "Data em que o último evento de pagamento foi registrado.", - "es": "Fecha en la que se registró el ultimo evento sobre el pago." - } - }, - "cardholder": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "APRO", - "description": { - "es": "name", - "pt": "name", - "en": "name" - } - }, - "identification": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": 19119119100, - "description": { - "en": "The number refers to the identifier of the user in question. If it is a CPF, for example, it will have 11 numbers.", - "pt": "O número se refere ao identificador do usuário em questão. Se for um CPF, por exemplo, terá 11 números.", - "es": "El número hace referencia al identificador del usuario en cuestión. Si es un CPF, por ejemplo, tendrá 11 números." - } - }, - "type": { - "type": "string", - "example": "CPF", - "description": { - "en": "Identification type.", - "pt": "Tipo de identificação", - "es": "Tipo de identificación" - } - } - }, - "description": { - "en": "Personal identification.", - "pt": "Identificação pessoal", - "es": "Identificación personal" - } - } - }, - "description": { - "en": "Cardholder details.", - "pt": "Detalhes do titular do cartão.", - "es": "Detalles del titular de la tarjeta." - } - } - }, - "description": { - "en": "Card details.", - "pt": "Informações do cartão.", - "es": "Detalles de la tarjeta." - } - }, - "notification_url": { - "type": "string", - "example": "https://www.suaurl.com/notificacoes/", - "description": { - "en": "Notifications URL available to receive notifications of events related to Payment. The maximum number of characters allowed for submission in this parameter is 248 characters.", - "pt": "URL de notificações disponível para receber notificações de eventos relacionados ao Pagamento. A quantidade máxima de caracteres permitidos para envio neste parâmetro é de 248 caracteres.", - "es": "URL de Notificaciones disponibilizada para recibir las notificaciones de los eventos relacionados al Pago. La cantidad máxima de caracteres permitidos para enviar en este parámetro es de 248 caracteres." - } - }, - "processing_mode": { - "type": "string", - "example": "aggregator", - "description": { - "en": "Processing mode. There are two types.", - "pt": "Modo de processamento. Existem dois tipos.", - "es": "Modo de procesamiento. Existen dos tipos." - }, - "enum": [ - { - "title": "Aggregator", - "description": { - "en": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer.", - "es": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer.", - "pt": "The merchant will use the Mercado Pago merchant codes and will take advantage of the financial advantages that we offer." - } - }, - { - "title": "Gateway", - "description": { - "en": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment.", - "es": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment.", - "pt": "For the merchant it is necessary to have their own merchant codes for online sales and to have an agreement with each of the desired means of payment." - } - } - ] - }, - "merchant_account_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant store code identifier. Applies only to the gateway model (since the delivery of money to the merchant does not go through the Mercado Pago system).", - "pt": "Identificador do código da loja comerciante. Aplica-se somente ao modelo gateway (porque a entrega de dinheiro ao comerciante não passa pelo sistema do Mercado Pago).", - "es": "Identificador del código de la tienda del merchant. Aplica solo para el modelo de gateway (ya que la entrega de dinero al comercio no pasa por el sistema de Mercado Pago)" - } - }, - "acquirer": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer.", - "pt": "Adquirente.", - "es": "Adquirente." - } - }, - "merchant_number": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant number (Applies to gateway model).", - "pt": "Número da loja (aplica-se ao modelo de gateway).", - "es": "Número de comercio (Aplica para modelo gateway)." - } - }, - "point_of_interaction": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "PIX", - "description": { - "en": "Payment type identifier", - "pt": "Identificador do tipo de pagamento", - "es": "Identificador del tipo de pago" - } - }, - "sub_type": { - "type": "string", - "description": { - "en": "Secondary identifier of the payment type", - "pt": "Identificador secundário do tipo de pagamento", - "es": "Identificador secundario del tipo de pago" - } - }, - "application_data": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "NAME_SDK", - "description": { - "en": "Application name", - "pt": "Nome da aplicação", - "es": "Nombre de la aplicación" - } - }, - "version": { - "type": "string", - "example": "VERSION_NUMBER", - "description": { - "en": "Current version", - "pt": "Versão atual da aplicação", - "es": "Versión actual de la aplicación" - } - } - }, - "description": { - "en": "Information about the application that processes the payment", - "pt": "Informação da aplicação que processa o pagamento", - "es": "Información de la aplicación que procesa el pago" - } - }, - "transaction_data": { - "type": "object", - "properties": { - "qr_code_base64": { - "type": "string", - "example": "iVBORw0KGgoAAAANSUhEUgAABRQAAAUUCAYAAACu5p7oAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAIABJREFUeJzs2luO3LiWQNFmI+Y/Zd6vRt36KGNXi7ZOBtcagHD4kNLeiLX33v8DAAAAABD879sDAAAAAAA/h6AIAAAAAGSCIgAAAACQCYoAAAAAQCYoAgAAAACZoAgAAAAAZIIiAAAAAJAJigAAAABAJigCAAAAAJmgCAAAAABkgiIAAAAAkAmKAAAAAEAmKAIAAAAAmaAIAAAAAGSCIgAAAACQCYoAAAAAQCYoAgAAAACZoAgAAAAAZIIiAAAAAJAJigAAAABAJigCA...", - "description": { - "en": "Base64 representation of the image of the QR code to be scanned to finalize the payment", - "pt": "Representação em Base64 da imagem do código QR a ser digitalizado para finalização do pagamento", - "es": "Representación en base64 de la imagen del código QR a escanear para finalizar el pago" - } - }, - "qr_code": { - "type": "string", - "example": "00020126600014br.gov.bcb.pix0117test@testuser.com0217dados adicionais520400005303986540510.005802BR5913Maria Silva6008Brasilia62070503***6304E2CA", - "description": { - "en": "Alphanumeric code to copy and paste, used to finalize the payment", - "pt": "Código alfanumérico para copiar e colar, para finalizar o pagamento", - "es": "Código alfanumérico para copiar y pegar, para finalizar el pago" - } - }, - "ticket_url": { - "type": "string", - "example": "https://www.mercadopago.com.br/payments/123456789/ticket?caller_id=123456&hash=123e4567-e89b-12d3-a456-426655440000", - "description": { - "es": "A link to the rendered pix, with QR codes and instructions to pay", - "pt": "A link to the rendered pix, with QR codes and instructions to pay", - "en": "A link to the rendered pix, with QR codes and instructions to pay" - } - } - }, - "description": { - "en": "Information on the pending payment that was generated", - "pt": "Informação do pagamento pendente que foi gerado", - "es": "Información del pago pendiente que fue generado" - } - } - }, - "description": { - "en": "Information from the application that processes the payment and receives regulatory data", - "pt": "Informação da aplicação que processa o pagamento e recebe dados regulatórios", - "es": "Información de la aplicación que procesa el pago y recibe datos regulatorios" - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "8", - "description": { - "en": "The name of the parameters is wrong", - "es": "The name of the parameters is wrong", - "pt": "The name of the parameters is wrong" - } - }, - { - "title": "1004", - "description": { - "en": "Invalid parameters for payment_method API", - "es": "Invalid parameters for payment_method API", - "pt": "Invalid parameters for payment_method API" - } - }, - { - "title": "2018", - "description": { - "en": "The action requested is not valid for the current payment state.", - "es": "The action requested is not valid for the current payment state.", - "pt": "The action requested is not valid for the current payment state." - } - }, - { - "title": "2078", - "description": { - "en": "Capture attribute must be boolean.", - "es": "Capture attribute must be boolean.", - "pt": "Capture attribute must be boolean." - } - }, - { - "title": "2079", - "description": { - "en": "Invalid value for capture attribute.", - "es": "Invalid value for capture attribute.", - "pt": "Invalid value for capture attribute." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "4", - "description": { - "en": "The caller is not authorized to access this resource.", - "es": "The caller is not authorized to access this resource.", - "pt": "The caller is not authorized to access this resource." - } - }, - { - "title": "3002", - "description": { - "en": "The caller is not authorized to perform this action.", - "es": "The caller is not authorized to perform this action.", - "pt": "The caller is not authorized to perform this action." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "2000", - "description": { - "en": "Payment not found.", - "es": "Payment not found.", - "pt": "Payment not found." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Update payment", - "pt": "Atualizar pagamento", - "es": "Actualizar pago" - } - } - }, - "/v1/payments/search": { - "get": { - "tags": [ - "checkout-pro", - "qr-code", - "subscriptions", - "checkout-api", - "mp-point", - "checkout-bricks" - ], - "description": { - "en": "Search and return payments made in the last twelve months from the search date", - "pt": "Pesquisa e retorna pagamentos efetuados nos últimos doze meses a partir da data de pesquisa", - "es": "Busca y retorna los pagos hechos en los último doce meses desde la fecha de pago" - }, - "parameters": [ - { - "name": "sort", - "in": "query", - "description": { - "en": "Parameter used for ordering a list of payments. Sorting can be done using the following attributes - \"date_approved\", \"date_created\", \"date_last_updated\", \"id\", \"money_release_date\".", - "pt": "Parâmetro utilizado para a ordenação de uma lista de pagamentos. A ordenação pode ser feita a partir dos seguintes atributos - \"date_approved\", \"date_created\", \"date_last_updated\", \"id\", \"money_release_date\".", - "es": "Parámetro utilizado para ordenar una lista de pagos. La clasificación se puede hacer usando los siguientes atributos - \"date_approved\", \"date_created\", \"date_last_updated\", \"id\", \"money_release_date\"." - }, - "required": true, - "schema": { - "type": "string", - "example": "date_created" - } - }, - { - "name": "criteria", - "in": "query", - "description": { - "en": "It sorts the payments in ascending order (using “asc”) or in descending order (“desc”).", - "pt": "Ordena o pagamento de maneira ascendente (utilizando “asc”) ou descendente (“desc”).", - "es": "Ordena el pago en orden ascendente (usando \"asc\") o en orden descendente (\"desc\")." - }, - "required": true, - "schema": { - "type": "string", - "example": "desc" - } - }, - { - "name": "external_reference", - "in": "query", - "description": { - "en": "It is a payment’s external reference. It could be, for example, a hashcode from the Central Bank, working as a transaction origin identifier.", - "pt": "É uma referência externa do pagamento. Pode ser, por exemplo, um hashcode do Banco Central, funcionando como identificador de origem da transação.", - "es": "Es una referencia de pago externa. Podría ser, por ejemplo, un código hash del Banco Central, funcionando como identificador del origen de la transacción." - }, - "required": true, - "schema": { - "type": "string", - "example": "ID_REF" - } - }, - { - "name": "range", - "in": "query", - "description": { - "en": "Parameter used to define the payments search interval. The range can refer to the following attributes - \"date_created\", \"date_last_updated\", \"date_approved\", \"money_release_date\". If not informed, use default \"date_created\".", - "pt": "Parâmetro utilizado para definir o intervalo de busca pelos pagamentos. O intervalo pode ser referente aos seguintes atributos - \"date_created\", \"date_last_updated\", \"date_approved\", \"money_release_date\". Se não for informado utiliza por padrão \"date_created\".", - "es": "Parámetro utilizado para definir el intervalo de búsqueda de pagos. El rango puede hacer referencia a los siguientes atributos - \"date_created\", \"date_last_updated\", \"date_approved\", \"money_release_date\". Si no se informa, usa por defecto \"date_created\"" - }, - "required": true, - "schema": { - "type": "string", - "example": "date_created" - } - }, - { - "name": "begin_date", - "in": "query", - "description": { - "en": "Defines the start of the payments search interval. Its format can be a relative date - \"NOW-XDAYS\", \"NOW-XMONTHS\" - or an absolute date - ISO8601. If not informed, it defaults to \"NOW-3MONTHS\".", - "pt": "Define o início do intervalo de busca dos pagamentos. Seu formato pode ser uma data relativa - \"NOW-XDAYS\", \"NOW-XMONTHS\" - ou uma data absoluta - ISO8601. Se não for informado utiliza por padrão \"NOW-3MONTHS\".", - "es": "Define el inicio del intervalo de búsqueda de pagos. Su formato puede ser una fecha relativa - \"NOW-XDAYS\", \"NOW-XMONTHS\" - o una fecha absoluta - ISO8601. Si no se informa, el valor predeterminado es \"NOW-3MONTHS\"." - }, - "required": true, - "schema": { - "type": "string", - "example": "NOW-30DAYS" - } - }, - { - "name": "end_date", - "in": "query", - "description": { - "en": "Defines the end of the payments search interval. Its format can be a relative date - \"NOW-XDAYS\", \"NOW-XMONTHS\" - or an absolute date - ISO8601. If not informed, it defaults to \"NOW\".", - "pt": "Define o fim do intervalo de busca dos pagamentos. Seu formato pode ser uma data relativa - \"NOW-XDAYS\", \"NOW-XMONTHS\" - ou uma data absoluta - ISO8601. Se não for informado utiliza por padrão \"NOW\".", - "es": "Define el final del intervalo de búsqueda de pagos. Su formato puede ser una fecha relativa - \"NOW-XDAYS\", \"NOW-XMONTHS\" - o una fecha absoluta - ISO8601. Si no se informa, el valor predeterminado es \"NOW\"." - }, - "required": true, - "schema": { - "type": "string", - "example": "NOW" - } - }, - { - "name": "store_id", - "in": "query", - "description": { - "en": "Parameter used to filter the payment search by the identifier of the store to which the POS (Point of Sale) belongs.", - "pt": "Parâmetro utilizado para filtrar a busca de pagamentos pelo identificador da loja à qual pertence o PDV (Ponto de Venda).", - "es": "Parámetro utilizado para filtrar la búsqueda de pagos por el identificador de la sucursal a la que pertenece el PDV (Punto de Venta)." - }, - "required": false, - "schema": { - "type": "string", - "example": 47792478 - } - }, - { - "name": "pos_id", - "in": "query", - "description": { - "en": "Parameter used to filter payment searches by the Point of Sale (POS) identifier, physical sales points that use a card machine for sales and/or QR codes.", - "pt": "Parâmetro utilizado para filtrar a busca de pagamentos pelo identificador do ponto de venda (PDV), pontos de venda físicos que utilizam uma máquina de cartão para vendas e/ou códigos QR.", - "es": "Parámetro utilizado para filtrar la búsqueda de pagos por el identificador del PDV, puntos de venta físicos que utilizan una máquina de tarjetas para la venta y/o códigos QR." - }, - "required": false, - "schema": { - "type": "string", - "example": 58930090 - } - } - ], - "responses": { - "200": { - "description": { - "es": "Success", - "pt": "Success", - "en": "Success" - }, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "paging": { - "type": "object", - "properties": { - "total": { - "type": "number", - "example": 17493, - "description": { - "en": "The total number of items in the collection.", - "pt": "Número total de itens na cobrança.", - "es": "El número total de elementos del cobro." - } - }, - "limit": { - "type": "number", - "example": 30, - "description": { - "en": "The maximum number of entries to return.", - "pt": "O número máximo de entradas a serem retornadas.", - "es": "El número máximo de entradas a ser retornadas." - } - }, - "offset": { - "type": "number", - "example": 0, - "description": { - "en": "Numeric field used to paginate the response.", - "pt": "Campo numérico usado para paginar a resposta.", - "es": "Campo numérico utilizado para paginar la respuesta." - } - } - }, - "description": { - "en": "Information for pagination of search results.", - "pt": "Informações para paginação dos resultados da pesquisa.", - "es": "Información para paginación de resultados de búsqueda." - } - }, - "results": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": 1, - "description": { - "en": "Unique Payment Identifier, automatically generated by Mercado Pago", - "pt": "Identificador único de pagamento, gerado automaticamente pelo Mercado Pago", - "es": "Identificador único del pago, generado automáticamente por Mercado Pago" - } - }, - "date_created": { - "type": "string", - "example": "2017-08-31T11:26:38.000Z", - "description": { - "en": "Payment creation date.", - "pt": "Data de criação do pagamento.", - "es": "Fecha de creación del Pago." - } - }, - "date_approved": { - "type": "string", - "example": "2017-08-31T11:26:38.000Z", - "description": { - "en": "Payment approval date. A payment can be generated in an intermediate state and then approved, so the creation date will not always coincide with the Approval Date.", - "pt": "Data de aprovação do pagamento. Um pagamento pode ser gerado em um estado intermediário e depois aprovado, portanto, a data de criação nem sempre coincidirá com a Data de Aprovação.", - "es": "Fecha de aprobación del Pago. Un pago puede generarse en un estado intermedio y luego ser aprobado, por tanto la fecha de creación no siempre coincidirá con la Fecha de Aprobación." - } - }, - "date_last_updated": { - "type": "string", - "example": "2017-08-31T11:26:38.000Z", - "description": { - "en": "Date on which the last payment event was recorded.", - "pt": "Data em que o último evento de pagamento foi registrado.", - "es": "Fecha en la que se registró el ultimo evento sobre el pago." - } - }, - "date_of_expiration": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment’s expiration date. The attribute’s valid format is as follows - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "pt": "Data de expiração do pagamento. O formato válido do atributo é o seguinte - \"yyyy-MM-dd'T'HH:mm:ssz\". Ex. - 2022-11-17T09:37:52.000-04:00.", - "es": "Fecha de vencimiento del pago. El formato válido del atributo es el siguiente - \"yyyy-MM-dd'T'HH:mm:ssz\". Ej. - 2022-11-17T09:37:52.000-04:00." - } - }, - "money_release_date": { - "type": "string", - "example": "2017-09-14T11:26:38.000Z", - "description": { - "en": "Date on which the payment is settled and the money is made available in the Mercado Pago account of the Collector (the one who receives the payment). The field can take on the values “pending” or “released”, where the first indicates that the payment has not yet been released (money held for a period) and “released” means that the money has already been released to the user's available balance.", - "pt": "Data em que o pagamento é liquidado e o dinheiro é disponibilizado na conta Mercado Pago do Collector (aquele que recebe o pagamento). O campo pode assumir os valores “pending” ou “released”, sendo que o primeiro indica que o pagamento ainda não foi liberado (dinheiro retido por tempo) e “released” significa que o dinheiro já foi liberado para o saldo disponível do usuário.", - "es": "Fecha en que se liquida el pago y se pone a disposición el dinero en la cuenta de Mercado Pago del Collector (el que recibe el pago). El campo puede tomar los valores “pending” o “released”, siendo que el primero indica que el pago todavía no fue liberado (dinero retenido por tiempo) y “released” significa que el dinero ya fue liberado al disponible del usuario." - } - }, - "operation_type": { - "$ref": "#/components/schemas/operation_type" - }, - "issuer_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Is the identifier of the card issuer being used in a credit or debit card payment.", - "pt": "É o identificador do emissor do cartão que está sendo utilizado em um pagamento com cartão de crédito ou débito.", - "es": "Es el identificador del emisor de la tarjeta que se utiliza en un pago con tarjeta de crédito o débito." - } - }, - "payment_method_id": { - "type": "string", - "example": "account_money", - "description": { - "en": "It indicates the identifier of the payment method selected to make the transaction. Here are some examples. Get all available payment methods by consulting the 'Get payment Methods API'.", - "pt": "Indica o identificador do meio de pagamento selecionado para efetuar o pagamento. A seguir, apresentamos alguns exemplos. Obtenha todos os meios de pagamento disponíveis consultando a API de 'Obter meios de pagamento'.", - "es": "Identificador del medio de pago. Indica el ID del medio de pago seleccionado para realizar el pago. A continuación presentamos algunos ejemplos. Obtén todos los métodos de pago disponibles consultando la API de 'Obtener métodos de pago'." - }, - "enum": [ - { - "title": "pix", - "description": { - "en": "Instant digital payment method used in Brazil.", - "es": "Instant digital payment method used in Brazil.", - "pt": "Instant digital payment method used in Brazil." - } - }, - { - "title": "account_money", - "description": { - "en": "When the payment is debited directly from a Mercado Pago account.", - "es": "When the payment is debited directly from a Mercado Pago account.", - "pt": "When the payment is debited directly from a Mercado Pago account." - } - }, - { - "title": "debin_transfer", - "description": { - "en": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization.", - "es": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization.", - "pt": "Digital payment method used in Argentina that immediately debits an amount from an account, requesting prior authorization." - } - }, - { - "title": "ted", - "description": { - "en": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period.", - "es": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period.", - "pt": "It is the Electronic Transfer Available payment, used in Brazil, that has fees to be used. The payment is made the same day of the transaction, but for this it is necessary to make the transfer within the stipulated period." - } - }, - { - "title": "cvu", - "description": { - "en": "Payment method used in Argentina;", - "es": "Payment method used in Argentina;", - "pt": "Payment method used in Argentina;" - } - }, - { - "title": "pse", - "description": { - "en": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts.", - "es": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts.", - "pt": "Digital payment method used in Colombia which users authorize the debit of funds from their bank through virtual banking. your savings, checking or electronic deposit accounts." - } - } - ] - }, - "payment_type_id": { - "$ref": "#/components/schemas/payment_type_id" - }, - "status": { - "$ref": "#/components/schemas/status" - }, - "status_detail": { - "type": "string", - "example": "accredited", - "description": { - "en": "Detail in which the Collection resulted", - "pt": "Detalhe em que resultou a Coleção", - "es": "Detalle en el que resultó el Cobro" - }, - "enum": [ - { - "title": "Accredited", - "description": { - "en": "credited payment.", - "es": "credited payment.", - "pt": "credited payment." - } - }, - { - "title": "pending_contingency", - "description": { - "en": "the payment is being processed.", - "es": "the payment is being processed.", - "pt": "the payment is being processed." - } - }, - { - "title": "pending_review_manual", - "description": { - "en": "the payment is under review to determine its approval or rejection.", - "es": "the payment is under review to determine its approval or rejection.", - "pt": "the payment is under review to determine its approval or rejection." - } - }, - { - "title": "cc_rejected_bad_filled_date", - "description": { - "en": "incorrect expiration date.", - "es": "incorrect expiration date.", - "pt": "incorrect expiration date." - } - }, - { - "title": "cc_rejected_bad_filled_other", - "description": { - "en": "incorrect card details.", - "es": "incorrect card details.", - "pt": "incorrect card details." - } - }, - { - "title": "cc_rejected_bad_filled_security_code", - "description": { - "en": "incorrect CVV.", - "es": "incorrect CVV.", - "pt": "incorrect CVV." - } - }, - { - "title": "cc_rejected_blacklist", - "description": { - "en": "the card is in the denial list, being present in problems related to theft/complaints/fraud.", - "es": "the card is in the denial list, being present in problems related to theft/complaints/fraud.", - "pt": "the card is in the denial list, being present in problems related to theft/complaints/fraud." - } - }, - { - "title": "cc_rejected_call_for_authorize", - "description": { - "en": "the payment method requires prior authorization of the transaction value.", - "es": "the payment method requires prior authorization of the transaction value.", - "pt": "the payment method requires prior authorization of the transaction value." - } - }, - { - "title": "cc_rejected_card_disabled", - "description": { - "en": "the card is inactive.", - "es": "the card is inactive.", - "pt": "the card is inactive." - } - }, - { - "title": "cc_rejected_duplicated_payment", - "description": { - "en": "duplicated transaction.", - "es": "duplicated transaction.", - "pt": "duplicated transaction." - } - }, - { - "title": "cc_rejected_high_risk", - "description": { - "en": "rejected by Fraud Prevention.", - "es": "rejected by Fraud Prevention.", - "pt": "rejected by Fraud Prevention." - } - }, - { - "title": "cc_rejected_insufficient_amount", - "description": { - "en": "insufficient amount.", - "es": "insufficient amount.", - "pt": "insufficient amount." - } - }, - { - "title": "cc_rejected_invalid_installments", - "description": { - "en": "invalid number of installments.", - "es": "invalid number of installments.", - "pt": "invalid number of installments." - } - }, - { - "title": "cc_rejected_max_attempts", - "description": { - "en": "maximum number of attempts exceeded.", - "es": "maximum number of attempts exceeded.", - "pt": "maximum number of attempts exceeded." - } - }, - { - "title": "cc_rejected_other_reason", - "description": { - "en": "generic error.", - "es": "generic error.", - "pt": "generic error." - } - } - ] - }, - "currency_id": { - "$ref": "#/components/schemas/currency_id" - }, - "description": { - "type": "string", - "example": "Pago Pizza", - "description": { - "en": "Purchased product’s description, the reason for payment. E.g. - \"Xiaomi Redmi Note 11S mobile phone 128gb 6gb Ram Original Global Blue Version\" (description of a product in the marketplace).", - "pt": "Descrição do produto comprado, a razão de pagamento. Ex. - \"Celular Xiaomi Redmi Note 11S 128gb 6gb Ram Versão Global Original azul\" (descrição de um produto no marketplace).", - "es": "Descripción del producto adquirido, el motivo del pago. Ej. - \"Celular Xiaomi Redmi Note 11S 128gb 6gb Ram Original Global Blue Version\" (descripción de un producto en el marketplace)." - } - }, - "live_mode": { - "type": "boolean", - "description": { - "en": "Indicates whether the Payment was made in a production environment or in a Test environment. If TRUE, then the chargeback will be processed in production mode. If FALSE, then the chargeback will be processed in sandbox mode.", - "pt": "Indica se o Pagamento foi feito em ambiente de produção ou em ambiente de Teste. Se TRUE, o estorno será processado em modo de produção. Se FALSE, o estorno será processado no modo sandbox.", - "es": "Indica si el Pago se realizó en ambiente productivo o en un ambiente de Test. Si es TRUE, el contracargo se procesará en modo de producción. Si es FALSE, el contracargo se procesará en modo sandbox." - } - }, - "sponsor_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is deprecated and no longer used.", - "pt": "Este campo está deprecado e não é mais utilizado.", - "es": "Este campo está deprecado y ya no se usa." - } - }, - "authorization_code": { - "type": "string", - "format": "nullable", - "description": { - "en": "Transaction authorization code for payments with “payment_method_type” of type “credit_card” (credit card), “debit_card” (credit card) and “voucher_card” (voucher card for benefits, such as Alelo). In summary, this code is used for card transactions. The code is numerical and has 6 digits.", - "pt": "Código de autorização de transação para pagamentos com “payment_method_type” do tipo “credit_card” (cartão de crédito), “debit_card” (cartão de crédito) e “voucher_card” (cartão de voucher para benefícios, como Alelo). Em síntese, este código é utilizado para transações com cartão. O código é numérico e possui 6 dígitos.", - "es": "Código de autorización de transacción para pagos con “payment_method_type” de tipo “credit_card” (tarjeta de crédito), “debit_card” (tarjeta de débito) y “voucher_card” (tarjeta de bono para beneficios, como Alelo). En resumen, este código se utiliza para transacciones con tarjeta. El código es numérico y tiene 6 dígitos." - } - }, - "money_release_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "This field is used to identify whether a payment is PNF (Payment in Flow). Payment in flow is a form of cash release in which the installments received by a seller are released over the months (which corresponds to the number of installments). Possible values ​​for this field are “null” or “payment_in_flow”.", - "pt": "Esse campo é usado para identificar se um pagamento é PNF (pagamento no fluxo). Pagamento no fluxo é uma forma de liberação de dinheiro em que as parcelas recebidas por um vendedor são liberadas com o passar dos meses (que corresponde ao número de parcelas). Os valores possíveis para este campo são “null” ou “payment_in_flow”.", - "es": "Este campo se utiliza para identificar si un pago es PNF (Pay in Flow). El pago en flujo es una forma de liberación de dinero en la que las cuotas recibidas por un vendedor se van liberando a lo largo de los meses (lo que corresponde al número de cuotas). Los valores posibles para este campo son \"null\" o \"payment_in_flow\"." - } - }, - "counter_currency": { - "type": "string", - "format": "nullable", - "description": { - "en": "Basically, it is an object that will allow you to convert payments of the CBT type (Cross Border Trade) into dollars, which are international payments made in foreign currency.", - "pt": "Basicamente, é um objeto que permitirá converter em dólares pagamentos do tipo CBT (Cross Border Trade), que são pagamentos internacionais, feitos em moeda estrangeira.", - "es": "Básicamente, es un objeto que te permitirá convertir pagos del tipo CBT (Cross Border Trade) en dólares, que son pagos internacionales realizados en moneda extranjera." - } - }, - "collector_id": { - "type": "string", - "example": 2, - "description": { - "en": "It is the user who receives the money. Ex - A user (payer) buys a cell phone through the marketplace. The identifier of the store/seller to receive the payment is the collector_id.", - "pt": "É o usuário que recebe o dinheiro. Por exemplo - Um usuário (payer) compra um celular pelo marketplace. O identificador da loja/vendedor a receber o pagamento é o collector_id.", - "es": "Es el usuario quien recibe el dinero. Por ejemplo - Un usuario (payer) compra un celular a través del marketplace. El identificador de la tienda/vendedor para recibir el pago es el collector_id." - } - }, - "payer": { - "type": "object", - "description": { - "en": "Payer data - ID (identifying number), email address, identification (type and number of id)", - "pt": "Dados do pagador - ID (número de identificação), e-mail, identificação (tipo e número de documento)", - "es": "Datos del pagador - ID (número identificador), dirección de email, identificación (tipo y número de documento)" - }, - "properties": { - "id": { - "type": "string", - "example": 123, - "description": { - "en": "Payer identifier generated by Mercado Pago.", - "pt": "Identificador de pagador gerado pelo Mercado Pago.", - "es": "Identificador del Payer generado por Mercado Pago." - } - }, - "email": { - "type": "string", - "example": "test_user_80507629@testuser.com", - "description": { - "en": "Email associated with the payer. This value will only return a response when status=approved, status=refunded, or status=charged_back.", - "pt": "Email associado ao payer. Este valor só retornará uma resposta quando status=approved, status=refunded ou status=charged_back.", - "es": "Correo electrónico asociado al payer. Este valor sólo devolverá una respuesta cuando status=approved, status=refunded o status=charged_back." - } - }, - "identification": { - "type": "object", - "description": { - "en": "User's personal identification. As an example, in Brazil, we have the CPF (Individual Taxpayer Registry) and the CNPJ (National Corporate Taxpayer Registry), for companies. Other possible identification codes are CURP (Mexico), CUIL (Argentina). This object will only return a response when status=approved, status=refunded or status=charged_back.", - "pt": "Identificação pessoal do usuário. Como exemplo, a nível Brasil, temos o CPF (Cadastro de Pessoa Física) e o CNPJ (Cadastro Nacional de Pessoas Jurídicas), para empresas. Outros códigos de identificação possíveis são o CURP (México), CUIL (Argentina), Este objeto só retornará uma response quando status=approved, status=refunded or status=charged_back.", - "es": "Identificación personal del usuario. Como ejemplo, en Brasil, existe el CPF (Registro de Contribuyentes Individuales) y el CNPJ (Registro Nacional de Contribuyentes de Personas Jurídicas), para empresas. Otros posibles códigos de identificación son CURP (México), CUIL (Argentina). Este objeto sólo devolverá una respuesta cuando status=approved, status=refunded or status=charged_back." - }, - "properties": { - "type": { - "type": "string", - "example": "CPF", - "description": { - "en": "Refers to the type of identification. It can be one of the following types.", - "pt": "Refere-se ao tipo de identificação. Pode ser dos seguintes tipos.", - "es": "Se refiere al tipo de identificación. Puede ser de los siguientes tipos." - }, - "enum": [ - { - "title": "CPF", - "description": { - "en": "Individual Taxpayer Registration, Brazil.", - "es": "Individual Taxpayer Registration, Brazil.", - "pt": "Individual Taxpayer Registration, Brazil." - } - }, - { - "title": "CNPJ", - "description": { - "en": "National Register of Legal Entities, Brazil.", - "es": "National Register of Legal Entities, Brazil.", - "pt": "National Register of Legal Entities, Brazil." - } - }, - { - "title": "CUIT", - "description": { - "en": "Unique Tax Identification Code, Argentina.", - "es": "Unique Tax Identification Code, Argentina.", - "pt": "Unique Tax Identification Code, Argentina." - } - }, - { - "title": "CUIL", - "description": { - "en": "Unique Labor Identification Code, Argentina.", - "es": "Unique Labor Identification Code, Argentina.", - "pt": "Unique Labor Identification Code, Argentina." - } - }, - { - "title": "DNI", - "description": { - "en": "National Identity Document, Argentina.", - "es": "National Identity Document, Argentina.", - "pt": "National Identity Document, Argentina." - } - }, - { - "title": "CURP", - "description": { - "en": "Single Population Registration Code, Mexico.", - "es": "Single Population Registration Code, Mexico.", - "pt": "Single Population Registration Code, Mexico." - } - }, - { - "title": "RFC", - "description": { - "en": "Federal Registry of Taxpayers, Mexico.", - "es": "Federal Registry of Taxpayers, Mexico.", - "pt": "Federal Registry of Taxpayers, Mexico." - } - }, - { - "title": "CC", - "description": { - "en": "Citizenship Card, Colombia.", - "es": "Citizenship Card, Colombia.", - "pt": "Citizenship Card, Colombia." - } - }, - { - "title": "RUT", - "description": { - "en": "Single Tax List, Chile.", - "es": "Single Tax List, Chile.", - "pt": "Single Tax List, Chile." - } - }, - { - "title": "CI", - "description": { - "en": "Identity Card, Uruguay.", - "es": "Identity Card, Uruguay.", - "pt": "Identity Card, Uruguay." - } - } - ] - }, - "number": { - "type": "string", - "example": 19119119100, - "description": { - "en": "The number refers to the user’s identifier. If it is a CPF, for example, it will have 11 numbers.", - "pt": "O número se refere ao identificador do usuário em questão. Se for um CPF, por exemplo, terá 11 números.", - "es": "El número hace referencia al identificador del usuario en cuestión. Si es un CPF, por ejemplo, tendrá 11 números." - } - } - } - }, - "type": { - "$ref": "#/components/schemas/payer_type" - } - } - }, - "metadata": { - "type": "object", - "description": { - "en": "This is an optional key-value object where the customer can add additional information that needs to be recorded at checkout. Ex. - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "pt": "Este é um objeto opcional do tipo chave-valor no qual o cliente pode adicionar informações adicionais que precisam ser registradas no pagamento. Por exemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}.", - "es": "Este es un objeto clave-valor opcional en el que el cliente puede agregar información adicional que debe registrarse al finalizar la compra. Por ejemplo - {\"payments_group_size\":1,\"payments_group_timestamp\":\"2022-11-18T15:01:44Z\",\"payments_group_uuid\":\"96cfd2a4-0b06-4dea-b25f-c5accb02ba10\"}" - } - }, - "additional_info": { - "type": "object", - "description": { - "en": "At Payments level, it's only data, and we only forward that information to other APIs like Risk, to perform scoring and prevent fraud, or to Tax, to determine them for international payments.", - "pt": "No nível de Pagamentos, são apenas dados e apenas encaminhamos essas informações para outras APIS, como Risco, para realizar pontuação e prevenir fraudes, para Impostos para determiná-los para pagamentos internacionais.", - "es": "En el nivel de Pagos, son solo datos y únicamente reenviamos esa información a otras API, como Riesgo, para realizar puntajes y prevenir fraudes, o a Impuestos, para determinarlos para pagos internacionales." - } - }, - "external_reference": { - "type": "string", - "format": "nullable", - "description": { - "en": "It is a payment’s external reference. It could be, for example, a hashcode from the Central Bank, working as a transaction origin identifier.", - "pt": "É uma referência externa do pagamento. Pode ser, por exemplo, um hashcode do Banco Central, funcionando como identificador de origem da transação.", - "es": "Es una referencia de pago externa. Podría ser, por ejemplo, un código hash del Banco Central, funcionando como identificador del origen de la transacción." - } - }, - "transaction_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Product cost. Example - The sale of a product for R$100.00 will have a transactionAmount = 100.", - "pt": "Custo do produto. Exemplo - A venda de um produto por R$100,00 terá um transactionAmount = 100.", - "es": "Costo del producto. Ejemplo - La venta de un producto por R$ 100,00 tendrá un transactionAmount = 100." - } - }, - "transaction_amount_refunded": { - "type": "number", - "example": 0, - "description": { - "en": "Transaction amount refunded", - "pt": "Valor reembolsado da transação", - "es": "Monto reembolsado de transacción" - } - }, - "coupon_amount": { - "type": "number", - "example": 0, - "description": { - "en": "It is the value of the discount coupon. E.g. - BRL 14.50. The attribute's type is BigDecimal.", - "pt": "É o valor do cupom de desconto. Ex - R$14,50. O tipo do atributo é BigDecimal.", - "es": "Es el valor del cupón de descuento. Por ejemplo - BRL 14,50. El tipo del atributo es BigDecimal." - } - }, - "differential_pricing_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Attribute that commonly contains an agreement on how much the user will be charged (generally, this field is more relevant for Marketplace payments). Pricing and fees are calculated based on this identifier.", - "pt": "Atributo que comumente contém um acordo de quanto vai ser cobrado do usuário (geralmente, este campo é mais relevante para pagamentos do Marketplace). A precificação e as taxas são calculadas com base nesse identificador.", - "es": "Atributo que comúnmente contiene un acuerdo sobre cuánto se le cobrará al usuario (generalmente, este campo es más relevante para los pagos de Marketplace). Los precios y las tarifas se calculan en función de este identificador." - } - }, - "deduction_schema": { - "type": "string", - "format": "nullable", - "description": { - "en": "Pricing Scheme applied by Mercado Pago. It is a field that represents the information of a type of financing (installment). Ex - “ahora12” is a schema that indicates that the payment is divided into 12 installments. In addition, financing may have an additional cost, such cost being included in that same answer and pointed out to whom this applies (payer/collector).", - "pt": "Esquema de Pricing aplicado pelo Mercado Pago. É um campo que representa as informações de um tipo de financiamento (parcelamento). Por exemplo - “ahora12” é um schema que indica que o pagamento está parcelado em 12 vezes. Em adição, o financiamento pode ter um custo adicional, sendo tal custo incluído nessa mesma resposta e apontado a quem se aplica isso (payer/collector).", - "es": "Esquema de precios aplicado por Mercado Pago. Es un campo que representa la información de un tipo de financiamiento (cuota). Por ejemplo - “ahora12” es un esquema que indica que el pago se divide en 12 cuotas. Además, el financiamiento puede tener un costo adicional, siendo incluido dicho costo en esa misma respuesta y señalándose a quién aplica (payer/collector)." - } - }, - "transaction_details": { - "type": "object", - "properties": { - "net_received_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Net amount received", - "pt": "Valor líquido recebido", - "es": "Monto neto recibido" - } - }, - "total_paid_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Total amount charged to the payer", - "pt": "Valor total cobrado ao pagador", - "es": "Monto total cobrado al payer" - } - }, - "overpaid_amount": { - "type": "number", - "example": 0, - "description": { - "en": "Overpaid amount", - "pt": "Valor pago a mais", - "es": "Monto pagado en exceso" - } - }, - "external_resource_url": { - "type": "string", - "format": "nullable", - "description": { - "en": "External resource url", - "pt": "URL de recurso externo", - "es": "URL de recurso externo" - } - }, - "installment_amount": { - "type": "number", - "example": 250, - "description": { - "en": "Amount of the chosen financing fee.", - "pt": "Valor da taxa de financiamento escolhida.", - "es": "Monto de la cuota de financiación elegida." - } - }, - "financial_institution": { - "type": "string", - "format": "nullable", - "description": { - "en": "Financial institution", - "pt": "Instituição financeira", - "es": "Institución financiera" - } - }, - "payment_method_reference_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Unique identifier of the payment method", - "pt": "Identificador único do meio de pagamento", - "es": "Identificador único del método de pago" - } - }, - "payable_deferral_period": { - "type": "string", - "format": "nullable", - "description": { - "en": "Payment deferral period", - "pt": "Período de diferimento de pagamento", - "es": "Período de diferimiento del pago" - } - }, - "acquirer_reference": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer reference", - "pt": "Referência do adquirente", - "es": "Referencia de adquirente" - } - } - }, - "description": { - "en": "Transaction details", - "pt": "Detalhes da transação", - "es": "Detalles de la transacción" - } - }, - "captured": { - "type": "boolean", - "description": { - "en": "Indicates if the payment amount was captured or is pending capture.", - "pt": "Indica se o valor do pagamento foi capturado ou está com captura pendente.", - "es": "Indica si el monto del pago fue capturado o se encuentra pendiente de captura." - } - }, - "binary_mode": { - "type": "boolean", - "description": { - "en": "When set to TRUE, payments can only be approved or rejected. Otherwise they can also result in_process.", - "pt": "Quando definido como TRUE, os pagamentos só podem ser aprovados ou rejeitados. Caso contrário, eles também podem resultar in_process.", - "es": "Cuando se configura como TRUE los pagos sólo pueden resultar aprobados o rechazados. Caso contrario también pueden resultar in_process." - } - }, - "call_for_authorize_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Identifier that is provided to the issuing bank so that payments can be authorized.", - "pt": "Identificador que é fornecido ao banco emissor para que os pagamentos possam ser autorizados.", - "es": "Identificador que se proporciona al banco emisor para que se pueda autorizar los pagos." - } - }, - "statement_descriptor": { - "type": "string", - "format": "nullable", - "description": { - "en": "Description that the payment will appear with in the card statement (eg MERCADOPAGO)", - "pt": "Descrição com a qual o pagamento aparecerá no resumo do cartão (ex. MERCADOPAGO)", - "es": "Descripción con la que aparecerá el pago en el resumen de tarjeta (ej. MERCADOPAGO)" - } - }, - "installments": { - "type": "number", - "example": 1, - "description": { - "en": "Number of installments selected.", - "pt": "Número de parcelas selecionado", - "es": "Cantidad seleccionada de cuotas" - } - }, - "card": { - "type": "object", - "description": { - "en": "Card ID.", - "pt": "Identificador de cartão", - "es": "Identificador de tarjeta" - } - }, - "notification_url": { - "type": "string", - "format": "nullable", - "description": { - "en": "Notifications URL available to receive notifications of events related to Payment. The maximum number of characters allowed for submission in this parameter is 248 characters.", - "pt": "URL de notificações disponível para receber notificações de eventos relacionados ao Pagamento. A quantidade máxima de caracteres permitidos para envio neste parâmetro é de 248 caracteres.", - "es": "URL de Notificaciones disponibilizada para recibir las notificaciones de los eventos relacionados al Pago. La cantidad máxima de caracteres permitidos para enviar en este parámetro es de 248 caracteres." - } - }, - "processing_mode": { - "type": "string", - "format": "nullable", - "description": { - "en": "Processing mode. There are two types.", - "pt": "Modo de processamento do pagamento. Existem dois tipos.", - "es": "Método de procesamiento de pagos. Hay dos tipos." - }, - "enum": [ - { - "title": "Aggregator", - "description": { - "en": "The merchant will use the Mercado Pago merchant codes and take advantage of the financial advantages we offer.", - "es": "The merchant will use the Mercado Pago merchant codes and take advantage of the financial advantages we offer.", - "pt": "The merchant will use the Mercado Pago merchant codes and take advantage of the financial advantages we offer." - } - }, - { - "title": "Gateway", - "description": { - "en": "For the merchant, it is necessary to have his own merchant code for online sales and to have an agreement with each of the desired payment methods.", - "es": "For the merchant, it is necessary to have his own merchant code for online sales and to have an agreement with each of the desired payment methods.", - "pt": "For the merchant, it is necessary to have his own merchant code for online sales and to have an agreement with each of the desired payment methods." - } - } - ] - }, - "merchant_account_id": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant store code identifier. Applies only to the gateway model (since the delivery of money to the merchant does not go through the Mercado Pago system).", - "pt": "Identificador do código da loja comerciante. Aplica-se somente ao modelo gateway (porque a entrega de dinheiro ao comerciante não passa pelo sistema do Mercado Pago).", - "es": "Identificador del código de la tienda del merchant. Aplica solo para el modelo de gateway (ya que la entrega de dinero al comercio no pasa por el sistema de Mercado Pago)." - } - }, - "acquirer": { - "type": "string", - "format": "nullable", - "description": { - "en": "Acquirer.", - "pt": "Adquirente.", - "es": "Adquirente." - } - }, - "merchant_number": { - "type": "string", - "format": "nullable", - "description": { - "en": "Merchant number (Applies to gateway model).", - "pt": "Número do estabelecimento (aplica-se ao modelo de gateway).", - "es": "Número de comercio (Aplica para modelo gateway)." - } - } - } - }, - "description": { - "en": "Search results", - "pt": "Resultados da pesquisa", - "es": "Resultados de la búsqueda" - } - } - } - } - } - } - } - }, - "400": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "1", - "description": { - "en": "Params Error.", - "es": "Params Error.", - "pt": "Params Error." - } - }, - { - "title": "3", - "description": { - "en": "Token must be for test.", - "es": "Token must be for test.", - "pt": "Token must be for test." - } - }, - { - "title": "5", - "description": { - "en": "Must provide your access_token to proceed.", - "es": "Must provide your access_token to proceed.", - "pt": "Must provide your access_token to proceed." - } - }, - { - "title": "1000", - "description": { - "en": "Number of rows exceeded the limits.", - "es": "Number of rows exceeded the limits.", - "pt": "Number of rows exceeded the limits." - } - }, - { - "title": "1001", - "description": { - "en": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.", - "es": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.", - "pt": "Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ." - } - }, - { - "title": "1003", - "description": { - "en": "Invalid sort value.", - "es": "Invalid sort value.", - "pt": "Invalid sort value." - } - }, - { - "title": "1004", - "description": { - "en": "Invalid criteria value.", - "es": "Invalid criteria value.", - "pt": "Invalid criteria value." - } - }, - { - "title": "2001", - "description": { - "en": "Already posted the same request in the last minute.", - "es": "Already posted the same request in the last minute.", - "pt": "Already posted the same request in the last minute." - } - }, - { - "title": "2002", - "description": { - "en": "Customer not found.", - "es": "Customer not found.", - "pt": "Customer not found." - } - }, - { - "title": "2004", - "description": { - "en": "POST to Gateway Transactions API fail.", - "es": "POST to Gateway Transactions API fail.", - "pt": "POST to Gateway Transactions API fail." - } - }, - { - "title": "2006", - "description": { - "en": "Card Token not found.", - "es": "Card Token not found.", - "pt": "Card Token not found." - } - }, - { - "title": "2007", - "description": { - "en": "Connection to Card Token API fail.", - "es": "Connection to Card Token API fail.", - "pt": "Connection to Card Token API fail." - } - }, - { - "title": "2009", - "description": { - "en": "Card token issuer can't be null.", - "es": "Card token issuer can't be null.", - "pt": "Card token issuer can't be null." - } - }, - { - "title": "3000", - "description": { - "en": "You must provide your cardholder_name with your card data.", - "es": "You must provide your cardholder_name with your card data.", - "pt": "You must provide your cardholder_name with your card data." - } - }, - { - "title": "3001", - "description": { - "en": "You must provide your cardissuer_id with your card data.", - "es": "You must provide your cardissuer_id with your card data.", - "pt": "You must provide your cardissuer_id with your card data." - } - }, - { - "title": "3003", - "description": { - "en": "Invalid card_token_id.", - "es": "Invalid card_token_id.", - "pt": "Invalid card_token_id." - } - }, - { - "title": "3004", - "description": { - "en": "Invalid parameter site_id.", - "es": "Invalid parameter site_id.", - "pt": "Invalid parameter site_id." - } - }, - { - "title": "3005", - "description": { - "en": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource.", - "es": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource.", - "pt": "Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource." - } - }, - { - "title": "3006", - "description": { - "en": "Invalid parameter cardtoken_id.", - "es": "Invalid parameter cardtoken_id.", - "pt": "Invalid parameter cardtoken_id." - } - }, - { - "title": "3007", - "description": { - "en": "The parameter client_id can not be null or empty.", - "es": "The parameter client_id can not be null or empty.", - "pt": "The parameter client_id can not be null or empty." - } - }, - { - "title": "3008", - "description": { - "en": "Not found Cardtoken.", - "es": "Not found Cardtoken.", - "pt": "Not found Cardtoken." - } - }, - { - "title": "3009", - "description": { - "en": "unauthorized client_id.", - "es": "unauthorized client_id.", - "pt": "unauthorized client_id." - } - }, - { - "title": "3010", - "description": { - "en": "Not found card on whitelist.", - "es": "Not found card on whitelist.", - "pt": "Not found card on whitelist." - } - }, - { - "title": "3011", - "description": { - "en": "Not found payment_method.", - "es": "Not found payment_method.", - "pt": "Not found payment_method." - } - }, - { - "title": "3012", - "description": { - "en": "Invalid parameter security_code_length.", - "es": "Invalid parameter security_code_length.", - "pt": "Invalid parameter security_code_length." - } - }, - { - "title": "3013", - "description": { - "en": "The parameter security_code is a required field can not be null or empty.", - "es": "The parameter security_code is a required field can not be null or empty.", - "pt": "The parameter security_code is a required field can not be null or empty." - } - }, - { - "title": "3014", - "description": { - "en": "Invalid parameter payment_method.", - "es": "Invalid parameter payment_method.", - "pt": "Invalid parameter payment_method." - } - }, - { - "title": "3015", - "description": { - "en": "Invalid parameter card_number_length.", - "es": "Invalid parameter card_number_length.", - "pt": "Invalid parameter card_number_length." - } - }, - { - "title": "3016", - "description": { - "en": "Invalid parameter card_number.", - "es": "Invalid parameter card_number.", - "pt": "Invalid parameter card_number." - } - }, - { - "title": "3017", - "description": { - "en": "The parameter card_number_id can not be null or empty.", - "es": "The parameter card_number_id can not be null or empty.", - "pt": "The parameter card_number_id can not be null or empty." - } - }, - { - "title": "3018", - "description": { - "en": "The parameter expiration_month can not be null or empty.", - "es": "The parameter expiration_month can not be null or empty.", - "pt": "The parameter expiration_month can not be null or empty." - } - }, - { - "title": "3019", - "description": { - "en": "The parameter expiration_year can not be null or empty.", - "es": "The parameter expiration_year can not be null or empty.", - "pt": "The parameter expiration_year can not be null or empty." - } - }, - { - "title": "3020", - "description": { - "en": "The parameter cardholder.name can not be null or empty.", - "es": "The parameter cardholder.name can not be null or empty.", - "pt": "The parameter cardholder.name can not be null or empty." - } - }, - { - "title": "3021", - "description": { - "en": "The parameter cardholder.document.number can not be null or empty.", - "es": "The parameter cardholder.document.number can not be null or empty.", - "pt": "The parameter cardholder.document.number can not be null or empty." - } - }, - { - "title": "3022", - "description": { - "en": "The parameter cardholder.document.type can not be null or empty.", - "es": "The parameter cardholder.document.type can not be null or empty.", - "pt": "The parameter cardholder.document.type can not be null or empty." - } - }, - { - "title": "3023", - "description": { - "en": "The parameter cardholder.document.subtype can not be null or empty.", - "es": "The parameter cardholder.document.subtype can not be null or empty.", - "pt": "The parameter cardholder.document.subtype can not be null or empty." - } - }, - { - "title": "3024", - "description": { - "en": "Not valid action - partial refund unsupported for this transaction.", - "es": "Not valid action - partial refund unsupported for this transaction.", - "pt": "Not valid action - partial refund unsupported for this transaction." - } - }, - { - "title": "3025", - "description": { - "en": "Invalid Auth Code.", - "es": "Invalid Auth Code.", - "pt": "Invalid Auth Code." - } - }, - { - "title": "3026", - "description": { - "en": "Invalid card_id for this payment_method_id.", - "es": "Invalid card_id for this payment_method_id.", - "pt": "Invalid card_id for this payment_method_id." - } - }, - { - "title": "3027", - "description": { - "en": "Invalid payment_type_id.", - "es": "Invalid payment_type_id.", - "pt": "Invalid payment_type_id." - } - }, - { - "title": "3028", - "description": { - "en": "Invalid payment_method_id.", - "es": "Invalid payment_method_id.", - "pt": "Invalid payment_method_id." - } - }, - { - "title": "3029", - "description": { - "en": "Invalid card expiration month.", - "es": "Invalid card expiration month.", - "pt": "Invalid card expiration month." - } - }, - { - "title": "3030", - "description": { - "en": "Invalid card expiration year.", - "es": "Invalid card expiration year.", - "pt": "Invalid card expiration year." - } - }, - { - "title": "9062", - "description": { - "en": "Invalid range interval - Must be less than 365 days.", - "es": "Invalid range interval - Must be less than 365 days.", - "pt": "Invalid range interval - Must be less than 365 days." - } - } - ] - } - } - } - } - } - }, - "403": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "4", - "description": { - "en": "The caller is not authorized to access this resource.", - "es": "The caller is not authorized to access this resource.", - "pt": "The caller is not authorized to access this resource." - } - }, - { - "title": "3002", - "description": { - "en": "The caller is not authorized to perform this action.", - "es": "The caller is not authorized to perform this action.", - "pt": "The caller is not authorized to perform this action." - } - } - ] - } - } - } - } - } - }, - "404": { - "description": { - "en": "Error", - "pt": "Erro", - "es": "Error" - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "errorKey": { - "type": "string", - "enum": [ - { - "title": "2000", - "description": { - "en": "Payment not found.", - "es": "Payment not found.", - "pt": "Payment not found." - } - } - ] - } - } - } - } - } - } - }, - "title": { - "en": "Search payments", - "pt": "Buscar em pagamentos", - "es": "Buscar en pagos" - } - } - } - }, - "components": { - "schemas": { - "operation_type": { - "type": "string", - "description": { - "en": "It is the type of payment. The available types are as follows.", - "pt": "É o tipo de pagamento. Os tipos disponíveis são os seguintes.", - "es": "Es el tipo de pago. Los tipos disponibles son los siguientes." - }, - "enum": [ - { - "title": "investment", - "description": { - "en": "When money is put into an investment, such as CDB, in the Mercado Pago application;", - "es": "When money is put into an investment, such as CDB, in the Mercado Pago application;", - "pt": "When money is put into an investment, such as CDB, in the Mercado Pago application;" - } - }, - { - "title": "regular_payment", - "description": { - "en": "Typification by default of a purchase being paid using Mercado Pago.", - "es": "Typification by default of a purchase being paid using Mercado Pago.", - "pt": "Typification by default of a purchase being paid using Mercado Pago." - } - }, - { - "title": "money_transfer", - "description": { - "en": "Funds transfer between two users.", - "es": "Funds transfer between two users.", - "pt": "Funds transfer between two users." - } - }, - { - "title": "recurring_payment", - "description": { - "en": "Automatic recurring payment due to an active user subscription.", - "es": "Automatic recurring payment due to an active user subscription.", - "pt": "Automatic recurring payment due to an active user subscription." - } - }, - { - "title": "account_fund", - "description": { - "en": "Money income in the user's account.", - "es": "Money income in the user's account.", - "pt": "Money income in the user's account." - } - }, - { - "title": "payment_addition", - "description": { - "en": "Addition of money to an existing payment, made through a Mercado Pago account.", - "es": "Addition of money to an existing payment, made through a Mercado Pago account.", - "pt": "Addition of money to an existing payment, made through a Mercado Pago account." - } - }, - { - "title": "cellphone_recharge", - "description": { - "en": "Recharge of a user's cellphone account.", - "es": "Recharge of a user's cellphone account.", - "pt": "Recharge of a user's cellphone account." - } - }, - { - "title": "pos_payment", - "description": { - "en": "Payment done through a Point of Sale.", - "es": "Payment done through a Point of Sale.", - "pt": "Payment done through a Point of Sale." - } - }, - { - "title": "money_exchange", - "description": { - "en": "Payment to exchange currency for a user.", - "es": "Payment to exchange currency for a user.", - "pt": "Payment to exchange currency for a user." - } - } - ] - }, - "entity_type": { - "type": "string", - "description": { - "en": "Entity type of the payer (only for bank transfers).", - "pt": "Tipo de entidade do pagador (apenas para transferências bancárias)", - "es": "Tipo de entidad del pagador (sólo para transferencias bancarias)" - }, - "example": "individual", - "enum": [ - { - "title": "individual", - "description": { - "en": "Payer is individual.", - "es": "Payer is individual.", - "pt": "Payer is individual." - } - }, - { - "title": "association", - "description": { - "en": "Payer is an association.", - "es": "Payer is an association.", - "pt": "Payer is an association." - } - } - ] - }, - "payer_type": { - "type": "string", - "description": { - "en": "Identification type of the associated payer (mandatory if the Payer is a Customer).", - "pt": "Tipo de identificação do pagador associado (se necessário o pagador é um cliente)", - "es": "Tipo de identificación del pagador asociado (requerido si el pagador es un cliente)" - }, - "example": "customer", - "enum": [ - { - "title": "customer", - "description": { - "en": "Payer is a Customer and belongs to the collector.", - "es": "Payer is a Customer and belongs to the collector.", - "pt": "Payer is a Customer and belongs to the collector." - } - }, - { - "title": "guest", - "description": { - "en": "The payer doesn't have an account.", - "es": "The payer doesn't have an account.", - "pt": "The payer doesn't have an account." - } - } - ] - }, - "currency_id": { - "type": "string", - "description": { - "en": "Identifier of the currency used in the payment. We currently have the following options.", - "pt": "Identificador da moeda utilizada no pagamento. Atualmente, possuímos as opções a seguir.", - "es": "Identificador de la moneda utilizada en el pago. Actualmente tenemos las siguientes opciones." - }, - "example": "BRL", - "enum": [ - { - "title": "ARS", - "description": { - "en": "Argentine peso.", - "es": "Argentine peso.", - "pt": "Argentine peso." - } - }, - { - "title": "BRL", - "description": { - "en": "Brazilian real.", - "es": "Brazilian real.", - "pt": "Brazilian real." - } - }, - { - "title": "CLP", - "description": { - "en": "Chilean peso.", - "es": "Chilean peso.", - "pt": "Chilean peso." - } - }, - { - "title": "MXN", - "description": { - "en": "Mexican peso.", - "es": "Mexican peso.", - "pt": "Mexican peso." - } - }, - { - "title": "COP", - "description": { - "en": "Colombian peso.", - "es": "Colombian peso.", - "pt": "Colombian peso." - } - }, - { - "title": "PEN", - "description": { - "en": "Peruvian sol.", - "es": "Peruvian sol.", - "pt": "Peruvian sol." - } - }, - { - "title": "UYU", - "description": { - "en": "Uruguayan peso.", - "es": "Uruguayan peso.", - "pt": "Uruguayan peso." - } - }, - { - "title": "VES", - "description": { - "en": "Venezuelan Bolivar.", - "es": "Venezuelan Bolivar.", - "pt": "Venezuelan Bolivar." - } - }, - { - "title": "MCN", - "description": { - "en": "Mercado Coin (internal cryptocurrency of Mercado Livre and Mercado Pago).", - "es": "Mercado Coin (internal cryptocurrency of Mercado Livre and Mercado Pago).", - "pt": "Mercado Coin (internal cryptocurrency of Mercado Livre and Mercado Pago)." - } - }, - { - "title": "BTC", - "description": { - "en": "Bitcoin.", - "es": "Bitcoin.", - "pt": "Bitcoin." - } - }, - { - "title": "USD", - "description": { - "en": "US dollar.", - "es": "US dollar.", - "pt": "US dollar." - } - }, - { - "title": "USDP", - "description": { - "en": "Pax Dollar (stable cryptocurrency pegged to the US dollar).", - "es": "Pax Dollar (stable cryptocurrency pegged to the US dollar).", - "pt": "Pax Dollar (stable cryptocurrency pegged to the US dollar)." - } - }, - { - "title": "DCE", - "description": { - "en": "Dollar Currency Equivalent.", - "es": "Dollar Currency Equivalent.", - "pt": "Dollar Currency Equivalent." - } - }, - { - "title": "ETH", - "description": { - "en": "Ethereum.", - "es": "Ethereum.", - "pt": "Ethereum." - } - }, - { - "title": "FDI", - "description": { - "en": "Investment Funds.", - "es": "Investment Funds.", - "pt": "Investment Funds." - } - }, - { - "title": "CDB", - "description": { - "en": "Bank deposit certificate", - "es": "Bank deposit certificate", - "pt": "Bank deposit certificate" - } - } - ] - }, - "fee_details_type": { - "type": "string", - "description": { - "en": "Fee detail.", - "pt": "Detalhe de comissão", - "es": "Detalle de comisión" - }, - "example": "coupon_fee", - "enum": [ - { - "title": "mercadopago_fee", - "description": { - "en": "Cost for using Mercado Pago.", - "es": "Cost for using Mercado Pago.", - "pt": "Cost for using Mercado Pago." - } - }, - { - "title": "coupon_fee", - "description": { - "en": "Discount given by a coupon.", - "es": "Discount given by a coupon.", - "pt": "Discount given by a coupon." - } - }, - { - "title": "financing_fee", - "description": { - "en": "Cost of financing.", - "es": "Cost of financing.", - "pt": "Cost of financing." - } - }, - { - "title": "shipping_fee", - "description": { - "en": "Shipping cost.", - "es": "Shipping cost.", - "pt": "Shipping cost." - } - }, - { - "title": "application_fee", - "description": { - "en": "Marketplace comision for the service.", - "es": "Marketplace comision for the service.", - "pt": "Marketplace comision for the service." - } - }, - { - "title": "discount_fee", - "description": { - "en": "Discount given by the seller through cost absorption.", - "es": "Discount given by the seller through cost absorption.", - "pt": "Discount given by the seller through cost absorption." - } - } - ] - }, - "fee_payer": { - "type": "string", - "description": { - "en": "Who absorbs the cost.", - "pt": "Quem absorve o custo da comissão", - "es": "Indica quién absorve el costo de la comisión" - }, - "example": "payer", - "enum": [ - { - "title": "collector", - "description": { - "en": "The seller absorbs the cost.", - "es": "The seller absorbs the cost.", - "pt": "The seller absorbs the cost." - } - }, - { - "title": "payer", - "description": { - "en": "The buyer absorbs the cost.", - "es": "The buyer absorbs the cost.", - "pt": "The buyer absorbs the cost." - } - } - ] - }, - "status": { - "type": "string", - "example": "approved", - "description": { - "en": "It is the payment’s current state. It can be of the following types.", - "pt": "É o estado atual do pagamento. Podem ser ser dos seguintes tipos.", - "es": "Es el estado actual del pago. Puede ser de los siguientes tipos." - }, - "enum": [ - { - "title": "pending", - "description": { - "en": "The user has not concluded the payment process (for example, by generating a payment by boleto, it will be concluded at the moment in which the user makes the payment in the selected place).", - "es": "The user has not concluded the payment process (for example, by generating a payment by boleto, it will be concluded at the moment in which the user makes the payment in the selected place).", - "pt": "The user has not concluded the payment process (for example, by generating a payment by boleto, it will be concluded at the moment in which the user makes the payment in the selected place)." - } - }, - { - "title": "approved", - "description": { - "en": "The payment has been approved and credited.", - "es": "The payment has been approved and credited.", - "pt": "The payment has been approved and credited." - } - }, - { - "title": "authorized", - "description": { - "en": "The payment has been authorized but not captured yet.", - "es": "The payment has been authorized but not captured yet.", - "pt": "The payment has been authorized but not captured yet." - } - }, - { - "title": "in_process", - "description": { - "en": "The payment is in analysis.", - "es": "The payment is in analysis.", - "pt": "The payment is in analysis." - } - }, - { - "title": "in_mediation", - "description": { - "en": "The user started a dispute.", - "es": "The user started a dispute.", - "pt": "The user started a dispute." - } - }, - { - "title": "rejected", - "description": { - "en": "The payment was rejected (the user can try to pay again).", - "es": "The payment was rejected (the user can try to pay again).", - "pt": "The payment was rejected (the user can try to pay again)." - } - }, - { - "title": "cancelled", - "description": { - "en": "Either the payment was canceled by one of the parties or expired.", - "es": "Either the payment was canceled by one of the parties or expired.", - "pt": "Either the payment was canceled by one of the parties or expired." - } - }, - { - "title": "refunded", - "description": { - "en": "The payment was returned to the user.", - "es": "The payment was returned to the user.", - "pt": "The payment was returned to the user." - } - }, - { - "title": "charged_back", - "description": { - "en": "A chargeback was placed on the buyer's credit card.", - "es": "A chargeback was placed on the buyer's credit card.", - "pt": "A chargeback was placed on the buyer's credit card." - } - } - ] - }, - "payment_type_id": { - "type": "string", - "description": { - "en": "It is the type of payment method (card, bank transfer, boleto bancário, ATM, etc.). They can be of the following types.", - "pt": "É o tipo da forma de pagamento (cartão, transferência bancária, boleto, caixa eletrônico, etc). Podem ser dos seguintes tipos.", - "es": "Es el tipo de método de pago (tarjeta, transferencia bancaria, ticket, ATM, etc.). Puede ser de los siguientes tipos." - }, - "example": "credit_card", - "enum": [ - { - "title": "account_money", - "description": { - "en": "Money in the Mercado Pago account.", - "es": "Money in the Mercado Pago account.", - "pt": "Money in the Mercado Pago account." - } - }, - { - "title": "ticket", - "description": { - "en": "Boletos, Caixa Electronica Payment, PayCash, Efecty, Oxxo, etc.", - "es": "Boletos, Caixa Electronica Payment, PayCash, Efecty, Oxxo, etc.", - "pt": "Boletos, Caixa Electronica Payment, PayCash, Efecty, Oxxo, etc." - } - }, - { - "title": "bank_transfer", - "description": { - "en": "Pix and PSE (Pagos Seguros en Línea).", - "es": "Pix and PSE (Pagos Seguros en Línea).", - "pt": "Pix and PSE (Pagos Seguros en Línea)." - } - }, - { - "title": "atm", - "description": { - "en": "ATM payment (widely used in Mexico through BBVA Bancomer).", - "es": "ATM payment (widely used in Mexico through BBVA Bancomer).", - "pt": "ATM payment (widely used in Mexico through BBVA Bancomer)." - } - }, - { - "title": "credit_card", - "description": { - "en": "Payment by credit card.", - "es": "Payment by credit card.", - "pt": "Payment by credit card." - } - }, - { - "title": "debit_card", - "description": { - "en": "Payment by debit card.", - "es": "Payment by debit card.", - "pt": "Payment by debit card." - } - }, - { - "title": "prepaid_card", - "description": { - "en": "Payment by prepaid card.", - "es": "Payment by prepaid card.", - "pt": "Payment by prepaid card." - } - }, - { - "title": "digital_currency", - "description": { - "en": "Purchases with Installments without card.", - "es": "Purchases with Pagos sin Tarjeta.", - "pt": "Purchases with Linha de Crédito." - } - }, - { - "title": "digital_wallet", - "description": { - "en": "Paypal.", - "es": "Paypal.", - "pt": "Paypal." - } - }, - { - "title": "voucher_card", - "description": { - "en": "Alelo benefits, Sodexo.", - "es": "Alelo benefits, Sodexo.", - "pt": "Alelo benefits, Sodexo." - } - }, - { - "title": "crypto_transfer", - "description": { - "en": "Payment with cryptocurrencies such as Ethereum and Bitcoin.", - "es": "Payment with cryptocurrencies such as Ethereum and Bitcoin.", - "pt": "Payment with cryptocurrencies such as Ethereum and Bitcoin." - } - } - ] - }, - "refund_source_type": { - "type": "string", - "description": { - "en": "Type of user who issued the refund.", - "pt": "Tipo de usuário que fez o reembolso", - "es": "Tipo de usuario que hizo el reembolso" - }, - "example": "collector", - "enum": [ - { - "title": "collector", - "description": { - "en": "The collector issued the refund.", - "es": "The collector issued the refund.", - "pt": "The collector issued the refund." - } - }, - { - "title": "operator", - "description": { - "en": "The refund was made by an account's operator.", - "es": "The refund was made by an account's operator.", - "pt": "The refund was made by an account's operator." - } - }, - { - "title": "admin", - "description": { - "en": "The refund was made by a Mercado Pago administrator.", - "es": "The refund was made by a Mercado Pago administrator.", - "pt": "The refund was made by a Mercado Pago administrator." - } - }, - { - "title": "bpp", - "description": { - "en": "The refund was made by the Mercado Pago's Buyer Protection Program", - "es": "The refund was made by the Mercado Pago's Buyer Protection Program", - "pt": "The refund was made by the Mercado Pago's Buyer Protection Program" - } - } - ] - }, - "barcode_type": { - "type": "String", - "description": { - "en": "Encoding type.", - "pt": "Tipo de encoding", - "es": "Tipo de encoding" - }, - "enum": [ - { - "title": "UCC/EAN 128", - "description": { - "en": "Encodes data using the Code 128 symbology.", - "es": "Encodes data using the Code 128 symbology.", - "pt": "Encodes data using the Code 128 symbology." - } - }, - { - "title": "Code128C", - "description": { - "en": "High-density alphanumeric code.", - "es": "High-density alphanumeric code.", - "pt": "High-density alphanumeric code." - } - }, - { - "title": "Code39", - "description": { - "en": "Media density code.", - "es": "Media density code.", - "pt": "Media density code." - } - } - ] - } - } - } -} \ No newline at end of file