diff --git a/guides/checkout-api-orders/chargebacks-management.en.md b/guides/checkout-api-orders/chargebacks-management.en.md new file mode 100644 index 0000000000..edcbdc443f --- /dev/null +++ b/guides/checkout-api-orders/chargebacks-management.en.md @@ -0,0 +1,99 @@ +# Manage chargebacks + +Upon receiving a chargeback initiation notification, use the provided data to assist in managing the process. This data will be essential for preparing and submitting the necessary documentation for the dispute. + +In this stage, analyze the detailed information included in the notification to understand the specific aspects of the chargeback. Below, we present a diagram that illustrates how the document submission and receipt flow works: + +
+  sequenceDiagram
+      participant MerchantServer as Merchant Server
+      participant MercadoPagoAPI as Mercado Pago API
+      MerchantServer->>MercadoPagoAPI: Chargeback notification
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+      MerchantServer->>MercadoPagoAPI: GET Chargeback
+      MercadoPagoAPI-->>MerchantServer: Chargeback response
+      MerchantServer->>MercadoPagoAPI: Upload documentation
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+      MerchantServer->>MercadoPagoAPI: Chargeback update
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+
+ +## Consult chargeback + +Start the process by consulting the chargeback information using the `id` provided in the notification body. + +From the obtained details, it will be possible to evaluate if there is a need to submit documentation to continue the chargeback. + +To consult more information about the chargeback, send a GET request to the endpoint :TagComponent{tag="API" text="/v1/orders/{id}" href="/developers/en/reference/orders/online-payments/get-order/get"}, replacing the `id` field with the `id` of the chargeback brought in the notification body: + +```curl +curl --location --globoff 'https://api.mercadopago.com/v1/chargebacks/{id}' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer {{access_token}}' +``` + +Below is an example of a response to the request: + +```json +{ + "id": "234000062890459000", + "payments": [ + 86439942806 + ], + "currency": "ARS", + "amount": 1000.50, + "reason": "general", + "coverage_applied": null, + "coverage_elegible": true, + "documentation_required": false, + "documentation_status": "not_supplied", + "documentation": [], + "date_documentation_deadline": null, + "date_created": null, + "date_last_updated": "2024-10-17T12:48:24.000-04:00", + "live_mode": true +} +``` + +## Submit documentation for chargeback + +In the response to the query made to obtain more information about the chargeback, it will be indicated if you need to submit the necessary documentation to dispute it. You will only need to do so if the `documentation_required` field is true and the `date_documentation_deadline` field indicates a future date. + +At this stage, you can submit the documentation proving that the sale is valid through the following POST request: + +>WARNING +> +> The files must be sent in `.jpg`, `.png`, or `.pdf` format and have a maximum size of up to 10MB. + +``` +curl -X POST \ +-F 'files[]=@/path/to/file/file1.png' \ +-F 'files[]=@/path/to/file/file2.pdf' \ +-H 'Authorization: Bearer {{access_token}}' +https://api.mercadopago.com/v1/chargebacks/{id}/documentation +``` + +If the files are successfully submitted, the API will return an `HTTP 200` code and the `documentation_status` of the chargeback will be changed to `review_pending`. + +After receiving the documentation, Mercado Pago acts as a mediator in the chargeback resolution process. The analysis is initiated with the card brand, which then sends the received documentation to the card-issuing bank. Once the bank's analysis is completed, the chargeback resolution is determined and the involved parties are notified. + +Wait for the Webhook notification regarding the resolution and check the chargeback again using the endpoint :TagComponent{tag="API" text="Get order by ID" href="/developers/en/reference/orders/online-payments/get-order/get"}. After the resolution, the `coverage_applied` field will indicate the result and will assume one of the possible values: + +| Value | Description | +|-------|---------------------------------------------------------------------------| +| `true` | Indicates that the decision was in favor of the seller and the money will be refunded. | +| `false` | Indicates that the decision was against the seller and the money will be deducted. | + +> RED_MESSAGE +> +> The chargeback resolution can take up to 6 months, depending on the card brand. + +## Transaction status + +When a chargeback is initiated, the status of the associated payment is directly impacted. Initially, the `status` is changed to `charged_back` and the `status_detail` to `in_process`. After the conclusion of the chargeback analysis, whether by the decision of the issuing bank, the determination of eligibility for coverage by Mercado Pago, or the absence of provided documentation, the `status_detail` of the payment will be updated to `settled` or `reimbursed`. + +| Status | Status detail | Description | +|------------------|---------------|--------------------------------------------------------------------------------------------------| +| `charged_back` | `in_process` | Chargeback received. The payment dispute is in progress, awaiting a final decision. | +| `charged_back` | `settled` | Decision against the seller. Money withdrawn from the seller's account. | +| `charged_back` | `reimbursed` | Decision in favor of the seller. Money refunded to the seller's account. | \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks-management.es.md b/guides/checkout-api-orders/chargebacks-management.es.md new file mode 100644 index 0000000000..41e0407866 --- /dev/null +++ b/guides/checkout-api-orders/chargebacks-management.es.md @@ -0,0 +1,99 @@ +# Gestionar contracargos + +Al recibir una notificación de inicio de contracargo, utiliza los datos proporcionados para ayudar en la gestión del proceso. Estos datos serán fundamentales para preparar y enviar la documentación necesaria para la disputa. + +En esta etapa, analiza la información detallada incluida en la notificación para comprender los aspectos específicos del contracargo. A continuación, presentamos un diagrama que ilustra cómo funciona el flujo de envío y recepción de la documentación: + +
+  sequenceDiagram
+      participant MerchantServer as Merchant Server
+      participant MercadoPagoAPI as Mercado Pago API
+      MerchantServer->>MercadoPagoAPI: Chargeback notification
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+      MerchantServer->>MercadoPagoAPI: GET Chargeback
+      MercadoPagoAPI-->>MerchantServer: Chargeback response
+      MerchantServer->>MercadoPagoAPI: Upload documentation
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+      MerchantServer->>MercadoPagoAPI: Chargeback update
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+
+ +## Consultar contracargo + +Inicia el proceso consultando la información del contracargo utilizando el `id` proporcionado en el cuerpo de la notificación. + +A partir de los detalles obtenidos, será posible evaluar si hay necesidad de enviar la documentación para dar continuidad al contracargo. + +Para consultar más información sobre el contracargo, envía un GET al endpoint :TagComponent{tag="API" text="/v1/orders/{id}" href="/developers/es/reference/orders/online-payments/get-order/get"}, sustituyendo el campo `id` por el `id` del contracargo proporcionado en el `body` de la notificación: + +```curl +curl --location --globoff 'https://api.mercadopago.com/v1/chargebacks/{id}' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer {{access_token}}' +``` + +A continuación, compartimos un ejemplo de respuesta a la solicitud: + +```json +{ + "id": "234000062890459000", + "payments": [ + 86439942806 + ], + "currency": "ARS", + "amount": 1000.50, + "reason": "general", + "coverage_applied": null, + "coverage_elegible": true, + "documentation_required": false, + "documentation_status": "not_supplied", + "documentation": [], + "date_documentation_deadline": null, + "date_created": null, + "date_last_updated": "2024-10-17T12:48:24.000-04:00", + "live_mode": true +} +``` + +## Enviar documentación para contracargo + +En la respuesta a la consulta realizada para obtener más información sobre el contracargo, se indicará si debe enviar la documentación necesaria para contestarlo. Solo necesitará hacerlo si el campo `documentation_required` es true y el campo `date_documentation_deadline` indica una fecha futura. + +En esta etapa, podrá enviar la documentación que demuestre que la venta es válida a través del siguiente POST: + +> RED_MESSAGE +> +> Los archivos deben enviarse en formato `.jpg`, `.png` o `.pdf` y tener un tamaño máximo de hasta 10MB. + +``` +curl -X POST \ +-F 'files[]=@/path/to/file/file1.png' \ +-F 'files[]=@/path/to/file/file2.pdf' \ +-H 'Authorization: Bearer {{access_token}}' +https://api.mercadopago.com/v1/chargebacks/{id}/documentation +``` + +Si los archivos se envían con éxito, la API devolverá un código `HTTP 200` y el `documentation_status` del contracargo se cambiará a `review_pending`. + +Después de recibir la documentación, Mercado Pago actúa como mediador en el proceso de resolución del contracargo. El análisis se inicia junto a la marca de la tarjeta, que luego envía la documentación recibida al banco emisor de la tarjeta. Una vez que el análisis del banco se completa, se determina la resolución del contracargo y se notifica a las partes involucradas. + +Espera la notificación Webhook referente a la resolución y verifica nuevamente el contracargo utilizando el endpoint :TagComponent{tag="API" text="Obtener order por ID" href="/developers/es/reference/orders/online-payments/get-order/get"}. Después de la resolución, el campo `coverage_applied` indicará el resultado y asumirá uno de los valores posibles: + +| Valor | Descripción | +|-------|----------------------------------------------------------------------------| +| `true` | Indica que la decisión fue a favor del vendedor y el dinero será devuelto. | +| `false` | Indica que la decisión fue en contra del vendedor y el dinero será descontado. | + +> WARNING +> +> La resolución del contracargo puede tardar hasta 6 meses, dependiendo de la marca de la tarjeta. + +## Estado de la transacción + +Cuando se inicia un contracargo, el estado del pago asociado se ve directamente afectado. Inicialmente, el `status` se cambia a `charged_back` y el `status_detail` a `in_process`. Después de la conclusión del análisis del contracargo, ya sea por la decisión del banco emisor, la determinación de la elegibilidad para cobertura por parte de Mercado Pago o la ausencia de documentación proporcionada, el `status_detail` del pago se actualizará a `settled` o `reimbursed`. + +| Status | Status detail | Descripción | +|------------------|----------------|--------------------------------------------------------------------------------------------------| +| `charged_back` | `in_process` | Contracargo recibido. La disputa del pago está en progreso, esperando una decisión final. | +| `charged_back` | `settled` | Decisión en contra del vendedor. Dinero retirado de la cuenta del vendedor. | +| `charged_back` | `reimbursed` | Decisión favorable al vendedor. Dinero reembolsado a la cuenta del vendedor. | \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks-management.pt.md b/guides/checkout-api-orders/chargebacks-management.pt.md new file mode 100644 index 0000000000..c3f17efa99 --- /dev/null +++ b/guides/checkout-api-orders/chargebacks-management.pt.md @@ -0,0 +1,99 @@ +# Gerenciar contestações + +Ao receber uma notificação de início de contestação, utilize os dados fornecidos para auxiliar no gerenciamento do processo. Esses dados serão fundamentais para preparar e enviar a documentação necessária à disputa. + +Nesta etapa, analise as informações detalhadas incluídas na notificação para compreender os aspectos específicos da contestação. Abaixo, apresentamos um diagrama que ilustra como funciona o fluxo de envio e recebimento da documentação: + +
+  sequenceDiagram
+      participant MerchantServer as Merchant Server
+      participant MercadoPagoAPI as Mercado Pago API
+      MerchantServer->>MercadoPagoAPI: Chargeback notification
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+      MerchantServer->>MercadoPagoAPI: GET Chargeback
+      MercadoPagoAPI-->>MerchantServer: Chargeback response
+      MerchantServer->>MercadoPagoAPI: Upload documentation
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+      MerchantServer->>MercadoPagoAPI: Chargeback update
+      MercadoPagoAPI-->>MerchantServer: HTTP 200
+
+ +## Consultar contestação + +Inicie o processo consultando as informações da contestação utilizando o `id` fornecido no corpo da notificação. + +A partir dos detalhes obtidos, será possível avaliar se há necessidade de envio da documentação para dar continuidade ao processo de contestação. + +Para consultar mais informações sobre a contestação, envie um GET ao endpoint :TagComponent{tag="API" text="/v1/orders/{id}" href="/developers/pt/reference/orders/online-payments/get-order/get"}, substituindo o campo `id` pelo `id` da contestação trazido no `body` da notificação: + +```curl +curl --location --globoff 'https://api.mercadopago.com/v1/chargebacks/{id}' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer {{access_token}}' +``` + +Confira abaixo um exemplo de resposta à requisição: + +```json +{ + "id": "234000062890459000", + "payments": [ + 86439942806 + ], + "currency": "ARS", + "amount": 1000.50, + "reason": "general", + "coverage_applied": null, + "coverage_elegible": true, + "documentation_required": false, + "documentation_status": "not_supplied", + "documentation": [], + "date_documentation_deadline": null, + "date_created": null, + "date_last_updated": "2024-10-17T12:48:24.000-04:00", + "live_mode": true +} +``` + +## Enviar documentação para contestação + +Na resposta à consulta realizada para obter mais informações sobre a contestação, será indicado se você deve enviar a documentação necessária para contestá-lo. Você só precisará fazê-lo se o campo `documentation_required` for true e o campo `date_documentation_deadline` indicar uma data futura. + +Nesta etapa, você poderá enviar a documentação que comprove que a venda é válida através do seguinte POST: + +> RED_MESSAGE +> +> Os arquivos devem ser enviados em formato `.jpg`, `.png` ou `pdf` e ter um tamanho máximo de até 10MB. + +``` +curl -X POST \ +-F 'files[]=@/path/to/file/file1.png' \ +-F 'files[]=@/path/to/file/file2.pdf' \ +-H 'Authorization: Bearer {{access_token}}' +https://api.mercadopago.com/v1/chargebacks/{id}/documentation +``` + +Se os arquivos forem enviados com sucesso, a API retornará um código `HTTP 200` e o `documentation_status` da contestação será alterado para `review_pending`. + +Após receber a documentação, o Mercado Pago atua como mediador no processo de resolução da contestação. A análise é iniciada junto à bandeira do cartão, que então envia a documentação recebida ao banco emissor do cartão. Uma vez que a análise do banco é concluída, a resolução da contestação é determinada e as partes envolvidas são notificadas. + +Aguarde a notificação Webhook referente à resolução e cheque novamente a contestação usando o endpoint :TagComponent{tag="API" text="Obter order por ID" href="/developers/pt/reference/orders/online-payments/get-order/get"}. Após a resolução, o campo `coverage_applied` indicará o resultado e assumirá um dos possíveis valores: + +| Valor | Descrição | +|-------|---------------------------------------------------------------------------| +| `true` | Indica que a decisão foi a favor do vendedor e o dinheiro será devolvido. | +| `false` | Indica que a decisão foi contra o vendedor e o dinheiro será descontado. | + +> WARNING +> +> A resolução da contestação pode levar até 6 meses, dependendo da bandeira do cartão. + +## Status da transação + +Quando uma contestação é iniciada, o status da transação associada é diretamente impactado. Inicialmente, o `status` é alterado para `charged_back` e o `status_detail` para `in_process`. Após a conclusão da análise da contestação, seja pela decisão do banco emissor, pela determinação da elegibilidade para cobertura pelo Mercado Pago ou pela ausência de documentação fornecida, o `status_detail` do pagamento será atualizado para `settled` ou `reimbursed`. + +| Status | Status detail | Descrição | +|------------------|-------------------|-------------------------------------------------------------------------------| +| `charged_back` | `in_process` | Contestação recebida. A disputa do pagamento está em andamento, aguardando uma decisão final. | +| `charged_back` | `settled` | Decisão contra o vendedor. Dinheiro retirado da conta do vendedor. | +| `charged_back` | `reimbursed` | Decisão favorável ao vendedor. Dinheiro reembolsado para a conta do vendedor. | \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks-notifications.en.md b/guides/checkout-api-orders/chargebacks-notifications.en.md new file mode 100644 index 0000000000..9699f5b005 --- /dev/null +++ b/guides/checkout-api-orders/chargebacks-notifications.en.md @@ -0,0 +1,84 @@ +# Configure chargeback notifications + +[Webhooks](/developers/en/docs/your-integrations/notifications/webhooks) notifications (also known as web callbacks) are a simple method that allows an application or system to provide real-time information whenever an event occurs. It is a passive way of receiving data between two systems through an `HTTP POST` request. + +Once configured, these notifications will be sent whenever a chargeback is created or its status is modified. From the received information, it will be possible to manage the chargeback. + +Below, we present a step-by-step guide to perform the configuration. + +1. Access [Your integrations](/developers/panel/app) and select the application for which you want to activate chargeback notifications. + +![cofigure notifications](/images/api-orders/not1-app-es.png) + +2. In the left menu, select **Webhooks > Configure Notifications**. + +![cofigure notifications](/images/api-orders/not2-configure-es.png) + +3. In "Production URL", configure the productive `HTTPS URL` that will be used to receive notifications. + +4. In recommended events, select the **Chargebacks** event to receive notifications, which will be sent in `JSON` format via an `HTTPS POST` to the specified URL. + +![cofigure notifications](/images/api-orders/not3-url-en.png) + +5. Finally, click **Save Settings**. This will generate a unique secret key for the application, which will allow you to validate the authenticity of the received notifications, ensuring that they have been sent by Mercado Pago. For more details, refer to the [Webhook Notifications Documentation](/developers/en/docs/your-integrations/notifications/webhooks). + +## Notification example + +The notifications sent by Mercado Pago for the `chargebacks` topic will be similar to the following example: + +```json +{ + "action": "order.charged_back", + "api_version": "v1", + "application_id": "874202490252970", + "data": { + "external_reference": "ext_ref_1234", + "id": "ORD01JRTXT3GC8CJGW394QWYQ9VP3", + "status": "charged_back", + "status_detail": "settled", + "total_amount": "200.00", + "total_paid_amount": "200.00", + "transactions": { + "payments": [ + { + "id": "PAY01JRTXT3GC8CJGW394QZZ349N6", + "amount": "200.00", + "paid_amount": "200.00", + "payment_method": { + "id": "master", + "installments": 1, + "type": "credit_card" + }, + "status": "charged_back", + "status_detail": "settled", + "reference": { + "id": "ref-0" + } + } + ], + "chargebacks": [ + { + "id": "CBK12JRTXT3GC8CJGW394QZZ349M7", + "transaction_id": "PAY01JT4211RXR4678HH8304SDKW4", + "case_id": "123456789", + "status": "settled", + "amount": "200.00", + "references": [ + { + "id": "01JSZZW4Q2JZJZC1R1W08KRVEP" + } + ] + } + ], + }, + "type": "online", + "version": 1 + }, + "date_created": "2025-04-14T19:53:23.114998555Z", + "live_mode": false, + "type": "order", + "user_id": "2021490138" +} +``` + +These notifications provide complete information about the process initiated by the customer, being essential to [manage the chargeback](/developers/en/docs/checkout-api-v2/payment-management/chargebacks/management). \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks-notifications.es.md b/guides/checkout-api-orders/chargebacks-notifications.es.md new file mode 100644 index 0000000000..7a8dfbaa56 --- /dev/null +++ b/guides/checkout-api-orders/chargebacks-notifications.es.md @@ -0,0 +1,83 @@ +# Configurar notificaciones de contracargos + +Las notificaciones [Webhooks](/developers/es/docs/your-integrations/notifications/webhooks) (también conocidas como devoluciones de llamada web) son un método simple que permite a una aplicación o sistema proporcionar información en tiempo real siempre que ocurre un evento. Es una forma pasiva de recibir datos entre dos sistemas mediante una solicitud `HTTP POST`. + +Una vez configuradas, estas notificaciones serán enviadas siempre que se cree un contracargo o se modifique su estado. A partir de la información recibida, será posible gestionar el contracargo. +A continuación, presentamos un paso a paso para realizar la configuración. + +1. Accede a [Tus integraciones](/developers/panel/app) y selecciona la aplicación para la cual deseas activar las notificaciones de contracargos. + +![cofigure notifications](/images/api-orders/not1-app-es.png) + +2. En el menú a la izquierda, selecciona **Webhooks > Configurar notificaciones**. + +![cofigure notifications](/images/api-orders/not2-configure-es.png) + +3. En "URL de producción", configura la `URL HTTPS` productiva que se utilizará para recibir las notificaciones. + +4. En los eventos recomendados, selecciona el evento **Contracargos** para recibir notificaciones, que serán enviadas en formato `JSON` mediante un `HTTPS POST` a la URL especificada anteriormente. + +![cofigure notifications](/images/api-orders/not3-url-es.png) + +5. Por último, haz clic en **Guardar configuraciones**. Esto generará una clave secreta exclusiva para la aplicación, que permitirá validar la autenticidad de las notificaciones recibidas, garantizando que hayan sido enviadas por Mercado Pago. Para más detalles, consulta la [documentación de notificaciones de Webhooks](/developers/es/docs/your-integrations/notifications/webhooks). + +## Ejemplo de notificación + +Las notificaciones enviadas por Mercado Pago para el tema de `chargebacks` serán similares al siguiente ejemplo: + +```json +{ + "action": "order.charged_back", + "api_version": "v1", + "application_id": "874202490252970", + "data": { + "external_reference": "ext_ref_1234", + "id": "ORD01JRTXT3GC8CJGW394QWYQ9VP3", + "status": "charged_back", + "status_detail": "settled", + "total_amount": "200.00", + "total_paid_amount": "200.00", + "transactions": { + "payments": [ + { + "id": "PAY01JRTXT3GC8CJGW394QZZ349N6", + "amount": "200.00", + "paid_amount": "200.00", + "payment_method": { + "id": "master", + "installments": 1, + "type": "credit_card" + }, + "status": "charged_back", + "status_detail": "settled", + "reference": { + "id": "ref-0" + } + } + ], + "chargebacks": [ + { + "id": "CBK12JRTXT3GC8CJGW394QZZ349M7", + "transaction_id": "PAY01JT4211RXR4678HH8304SDKW4", + "case_id": "123456789", + "status": "settled", + "amount": "200.00", + "references": [ + { + "id": "01JSZZW4Q2JZJZC1R1W08KRVEP" + } + ] + } + ], + }, + "type": "online", + "version": 1 + }, + "date_created": "2025-04-14T19:53:23.114998555Z", + "live_mode": false, + "type": "order", + "user_id": "2021490138" +} +``` + +Estas notificaciones proporcionan información completa sobre el proceso iniciado por el cliente, siendo fundamentales para [gestionar el contracargo](/developers/es/docs/checkout-api-v2/payment-management/chargebacks/management). \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks-notifications.pt.md b/guides/checkout-api-orders/chargebacks-notifications.pt.md new file mode 100644 index 0000000000..e75ef080ec --- /dev/null +++ b/guides/checkout-api-orders/chargebacks-notifications.pt.md @@ -0,0 +1,83 @@ +# Configurar notificações de contestações + +As notificações [Webhooks](/developers/pt/docs/your-integrations/notifications/webhooks) (também conhecido como retorno de chamada web) são um método simples que permite a uma aplicação ou sistema fornecer informações em tempo real sempre que um evento ocorre. É uma forma passiva de receber dados entre dois sistemas por meio de uma solicitação `HTTP POST`. + +Uma vez configuradas, essas notificações serão enviadas sempre que uma contestação for criada ou seu status for modificado. A partir das informações recebidas, será possível gerenciar a contestação. +A seguir, apresentamos um passo a passo para realizar a configuração. + +1. Acesse [Suas integrações](/developers/panel/app) e selecione a aplicação integrada com ----[mla, mlm, mco, mlc, mlu, mpe]----Checkout API------------ ----[mlb]----Checkout Transparente------------ para a qual deseja ativar as notificações. + +![cofigure notifications](/images/api-orders/not1-app-pt.png) + +2. No menu à esquerda, selecione **Webhooks > Configurar notificações**. + +![cofigure notifications](/images/api-orders/not2-configure-pt.png) + +3. Em "URL de produção", configure a `URL HTTPS` produtiva que será utilizada para receber as notificações. + +4. Nos eventos recomendados, selecione o evento **Contestações** para receber notificações, que serão enviadas no formato `JSON` por meio de um `HTTPS POST` para a URL especificada anteriormente. + +![cofigure notifications](/images/api-orders/not3-url-pt.png) + +5. Por último, clique em **Salvar configurações**. Isso gerará uma chave secreta exclusiva para a aplicação, que permitirá validar a autenticidade das notificações recebidas, garantindo que elas tenham sido enviadas pelo Mercado Pago. Para mais detalhes, consulte a [documentação de notificações de Webhooks](/developers/pt/docs/your-integrations/notifications/webhooks). + +## Exemplo de notificação + +As notificações enviadas pelo Mercado Pago para o tópico de `chargebacks` serão semelhantes ao exemplo a seguir: + +```json +{ + "action": "order.charged_back", + "api_version": "v1", + "application_id": "874202490252970", + "data": { + "external_reference": "ext_ref_1234", + "id": "ORD01JRTXT3GC8CJGW394QWYQ9VP3", + "status": "charged_back", + "status_detail": "settled", + "total_amount": "200.00", + "total_paid_amount": "200.00", + "transactions": { + "payments": [ + { + "id": "PAY01JRTXT3GC8CJGW394QZZ349N6", + "amount": "200.00", + "paid_amount": "200.00", + "payment_method": { + "id": "master", + "installments": 1, + "type": "credit_card" + }, + "status": "charged_back", + "status_detail": "settled", + "reference": { + "id": "ref-0" + } + } + ], + "chargebacks": [ + { + "id": "CBK12JRTXT3GC8CJGW394QZZ349M7", + "transaction_id": "PAY01JT4211RXR4678HH8304SDKW4", + "case_id": "123456789", + "status": "settled", + "amount": "200.00", + "references": [ + { + "id": "01JSZZW4Q2JZJZC1R1W08KRVEP" + } + ] + } + ], + }, + "type": "online", + "version": 1 + }, + "date_created": "2025-04-14T19:53:23.114998555Z", + "live_mode": false, + "type": "order", + "user_id": "2021490138" +} +``` + +Essas notificações fornecem informações completas sobre o processo iniciado pelo cliente, sendo fundamentais para [gerenciar a contestação](/developers/pt/docs/checkout-api-v2/payment-management/chargebacks/management). \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks.en.md b/guides/checkout-api-orders/chargebacks.en.md new file mode 100644 index 0000000000..0381f755be --- /dev/null +++ b/guides/checkout-api-orders/chargebacks.en.md @@ -0,0 +1,24 @@ +# Chargebacks + +A chargeback occurs when a customer contests a charge made to their credit or debit card, requesting a refund from the bank. If the chargeback request is deemed valid after due evaluation, the charge is canceled, the funds are withdrawn from the seller, and returned to the customer. + +At Mercado Pago, chargeback management is carried out in two main steps, ensuring both the analysis and resolution of disputes between the store and the customer. These steps are: + +1. **Chargeback notifications**: +Configure chargeback notifications to receive alerts whenever a customer initiates a dispute. For more details, refer to the documentation [Configure chargeback notifications](/developers/en/docs/checkout-api-v2/payment-management/chargebacks/notifications). + +2. **Chargeback processing**: +After notification, if requested, it will be necessary to gather information and submit documentation through the Mercado Pago API. For more information, refer to the [Chargeback management documentation](/developers/en/docs/checkout-pro/additional-content/chargebacks/management). + +> RED_MESSAGE +> +> During the chargeback resolution period, the disputed amount remains on hold in the seller's account until the process is completed. + +Below, we present some of the most common reasons for chargebacks and how to prevent them: + +| Reason | Description | How to prevent | +|-|-|-| +| Legitimate Fraud | Legitimate fraud constitutes a large part of chargebacks. In these cases, the customer may open a dispute with the card provider to cancel transactions on their accounts due to fraudulent activities. | Ensure to provide complete information when creating a payment so that the fraud prevention system can block high-risk transactions. For more information, refer to the [Industry data documentation](/developers/en/docs/checkout-api-v2/additional-settings/improve-payment-approval/industry-data). We also recommend configuring and activating Webhooks notifications for the fraud alert topic to receive warnings of irregular behaviors. For more information, visit the [Webhooks documentation](/developers/en/docs/checkout-api-v2/notifications). If you receive a fraud alert, we recommend [canceling the purchase](/developers/en/docs/checkout-api-v2/payment-management/refunds-cancellations) and refunding the money to the buyer to avoid the chargeback. | +| Customer does not recognize the charge | The customer does not recognize the transaction because they do not remember making a specific purchase or because the store name is unclear on the statement. | Send detailed purchase confirmation emails that include the payment receipt and use a clear and recognizable name to be displayed on the customer's statement.

To configure the name of the business that will be displayed on the buyer's invoice, send a **POST** to the endpoint :TagComponent{tag="API" text="/v1/orders" href="/developers/en/reference/orders/online-payments/create/post"} with the `statement_descriptor` parameter filled in with the name and execute the request. | +| Delivery issues | The customer may choose to request a chargeback in case of undelivered or late-delivered items before seeking more information from the store. | Provide tracking information and proactive communication about the order status. | +| Billing errors | Errors such as duplicate charges or subscriptions not canceled correctly. | Maintain an accurate billing system and offer accessible and efficient customer support. | \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks.es.md b/guides/checkout-api-orders/chargebacks.es.md new file mode 100644 index 0000000000..956e49c189 --- /dev/null +++ b/guides/checkout-api-orders/chargebacks.es.md @@ -0,0 +1,24 @@ +# Contracargos + +Un contracargo (o _chargeback_) ocurre cuando un cliente impugna un cargo realizado en su tarjeta de crédito o débito, solicitando al banco la devolución del importe pagado. Si la solicitud de contracargo se considera válida después de la debida evaluación, el cargo se anula, los fondos se retiran del vendedor y se devuelven al cliente. + +En Mercado Pago, la gestión de contracargos se realiza en dos pasos principales, que garantizan tanto el análisis como la resolución de las disputas entre la tienda y el cliente. Son los siguientes: + +1. **Notificación de contracargos**: +Configura las notificaciones de contracargos para recibir alertas siempre que un cliente inicie una disputa. Para más detalles, consulta la documentación [Configurar notificaciones de contracargos](/developers/es/docs/checkout-api-v2/payment-management/chargebacks/notifications). + +2. **Procesamiento de contracargos**: +Después de la notificación, si se solicita, será necesario reunir la información y enviar la documentación a través de la API de Mercado Pago. Para más información, consulta la documentación [Gestionar contracargos](/developers/es/docs/checkout-pro/additional-content/chargebacks/management). + +> RED_MESSAGE +> +> Durante el período de resolución del contracargo, el importe en disputa permanece retenido en la cuenta del vendedor hasta que se complete el proceso. + +A continuación, presentamos algunos de los motivos más comunes de ocurrencias de contracargos y cómo prevenirlos: + +| Motivo | Descripción | Cómo prevenir | +|-|-|-| +| Fraude legítimo | Los fraudes legítimos constituyen gran parte de los contracargos. En estos casos, el cliente puede abrir una disputa con el proveedor de la tarjeta con el objetivo de anular transacciones en sus cuentas debido a actividades fraudulentas. | Asegúrate de enviar la información completa al crear un pago para que el sistema de prevención de fraudes pueda bloquear transacciones de alto riesgo. Para más información, consulta la [documentación sobre Datos de industria](/developers/es/docs/checkout-api-v2/additional-settings/improve-payment-approval/industry-data). También recomendamos que configures y actives las notificaciones Webhooks para el tema de alerta de fraude y reciba avisos de comportamientos irregulares. Para más información, accede a la [documentación de Webhooks](/developers/es/docs/checkout-api-v2/notifications). Si recibes una alerta de fraude, recomendamos [cancelar la compra](/developers/es/docs/checkout-api-v2/payment-management/refunds-cancellations) y devolver el dinero al comprador para evitar el contracargo. | +| No reconocimiento del cargo por el cliente | El cliente no reconoce la transacción porque no recuerda haber realizado una determinada compra o porque el nombre de la tienda no está claro en el extracto. | Envía correos electrónicos detallados de confirmación de compra que incluyan el comprobante de pago y utiliza un nombre claro y reconocible que se muestre en el extracto del cliente.

Para configurar el nombre del establecimiento que se mostrará en la factura del comprador, envíe un **POST** al endpoint :TagComponent{tag="API" text="/v1/orders" href="/developers/es/reference/orders/online-payments/create/post"} con el parámetro `statement_descriptor` relleno con el nombre y ejecute la solicitud. | +| Problemas de entrega | El cliente puede optar por solicitar contracargos en caso de artículos no entregados o entregados con retraso, antes de buscar más información con la tienda. | Ofrece información de seguimiento y comunicación proactiva sobre el estado del pedido. | +| Errores de cobro | Errores como cargos duplicados o suscripciones no canceladas correctamente. | Mantén un sistema de cobro preciso y ofrece un soporte accesible y eficiente al cliente. | \ No newline at end of file diff --git a/guides/checkout-api-orders/chargebacks.pt.md b/guides/checkout-api-orders/chargebacks.pt.md new file mode 100644 index 0000000000..0018f297f3 --- /dev/null +++ b/guides/checkout-api-orders/chargebacks.pt.md @@ -0,0 +1,22 @@ +# Contestações + +Uma contestação (ou _chargeback_) ocorre quando um cliente contesta uma cobrança feita em seu cartão de crédito ou débito, solicitando ao banco a devolução do valor pago. Se a solicitação de contestação for considerada válida após a devida avaliação, a cobrança é anulada, os fundos são retirados do vendedor e devolvidos ao cliente. + +No Mercado Pago, a gestão de contestações é feita em dois passos principais, que garantem tanto a análise quanto a resolução das disputas entre a loja e o cliente. São eles: + +1. **Notificações de contestações**: configure as notificações de contestações para receber alertas sempre que um cliente iniciar uma disputa. Para mais detalhes, consulte a documentação [Configurar notificações de contestações](/developers/pt/docs/checkout-api-v2/payment-management/chargebacks/notifications). + +2. **Processamento das contestações**: após a notificação, caso solicitado, será necessário reunir as informações e enviar a documentação através da API do Mercado Pago. Para mais informações, consulte a [documentação Gerenciar contestações](/developers/pt/docs/checkout-api-v2/payment-management/chargebacks/management). + +> RED_MESSAGE +> +> Durante o período de resolução da contestação, o valor em disputa permanece retido na conta do vendedor até que o processo seja concluído. + +A seguir, apresentamos alguns dos motivos mais comuns de ocorrências de contestações e como preveni-los: + +| Motivo | Descrição | Como prevenir | +|-|-|-| +| Fraude legítima | As fraudes legítimas constituem grande parte das contestações. Nestes casos, o cliente pode abrir uma disputa junto ao provedor do cartão com o objetivo de anular transações em suas contas devido a atividades fraudulentas. | Certifique-se de enviar as informações completas ao criar um pagamento para que o sistema de prevenção a fraudes possa bloquear transações de alto risco. Para mais informações, consulte a [documentação sobre Dados de indústria](/developers/pt/docs/checkout-api-v2/additional-settings/improve-payment-approval/industry-data). Também recomendamos que configure e ative as notificações Webhooks para o tópico de alerta de fraude e receba avisos de comportamentos irregulares. Para mais informações, acesse a [documentação de Webhooks](/developers/pt/docs/checkout-api-v2/notifications). Caso receba um alerta de fraude, recomendamos que [cancele a compra](/developers/pt/docs/checkout-api-v2/payment-management/refunds-cancellations) e devolva o dinheiro ao comprador para evitar a contestação. | +| Não reconhecimento da cobrança pelo cliente | O cliente não reconhece a transação porque não se recorda de ter realizado determinada compra ou porque o nome da loja não está claro no extrato. | Envie e-mails detalhados de confirmação de compra que incluam o comprovante de pagamento e utilize um nome claro e reconhecível a ser exibido no extrato do cliente.

Para configurar o nome do estabelecimento que será exibido na fatura do comprador, envie um **POST** ao endpoint :TagComponent{tag="API" text="/v1/orders" href="/developers/pt/reference/orders/online-payments/create/post"} com o parâmetro `statement_descriptor` preenchido com o nome e execute a requisição. | +| Problemas de entrega | O cliente pode optar por solicitar contestações em caso de artigos não entregues ou entregues com atraso, antes de buscar mais informações com a loja. | Oferecer informações de rastreamento e comunicação proativa sobre o status do pedido. | +| Erros de cobrança | Erros como cobranças duplicadas ou assinaturas não canceladas corretamente. | Mantenha um sistema de cobrança preciso e ofereça um suporte ao cliente acessível e eficiente. | \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-industry-data.en.md b/guides/checkout-api-orders/improve-payment-approval-industry-data.en.md new file mode 100644 index 0000000000..9bb985b522 --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-industry-data.en.md @@ -0,0 +1,1542 @@ +# Industry data + +According to your store's line of business or sector, you can include additional information when creating the payment that helps increase approval chances. + +See below some specific data for these industries that can be added to your integration. + +:::AccordionComponent{title="Apparel"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `type` | String | Item type. | +| `description` | String | Item description. | +| `picture_url` | String | Item image URL. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Ticket to Curitiba", + "description": "Ticket to Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Electronics"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | +| `warranty` | Boolean | Product has warranty. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Ticket to Curitiba", + "description": "Ticket to Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Tickets and entertainment"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | +| `event_date` | Date | Event date. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Ticket to Curitiba", + "description": "Ticket to Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false, + "event_date": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Home and decoration"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | +| `warranty` | Boolean | Product has warranty. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Ticket to Curitiba", + "description": "Ticket to Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Apps and online platforms"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Ticket to Curitiba", + "description": "Ticket to Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Government and public services"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|----------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | +| `warranty` | Boolean | Product has warranty. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Retail"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `picture_url` | String | Item image URL. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "2", + "title": "Passagem Para Guarulhos", + "description": "Passagem Para Guarulhos", + "picture_url": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Tourism"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +- Passengers (`additional_info.travel.passengers`) + +| Field | Type | Description | +|------------------------|---------|----------------------------| +| `first_name`` | String | Passenger's first name. Inside the `passenger` object. | +| `last_name` | String | Passenger's last name. Inside the `passenger` object. | +| `identification` | Object | Passenger's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number ` | String | Identification number. Inside the `identification` object. | + +- Routes (`additional_info.travel.routes`) + +| Field | Type | Description | +|----------------------|---------|----------------------------| +| `departure`| String | Route departure location (e.g. airport code). | +| `destination`| String | Route destination location (e.g. airport code). | +| `departure_date_time` | Date | Route departure date and time. | +| `arrival_date_time` | Date | Route arrival date and time. | +| `company`| String | Company responsible for executing the route. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Hospitality"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | +| `event_date` | Date | Event date. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +- Passengers (`additional_info.travel.passengers`) + +| Field | Type | Description | +|------------------------|---------|----------------------------| +| `first_name`` | String | Passenger's first name. Inside the `passenger` object. | +| `last_name` | String | Passenger's last name. Inside the `passenger` object. | +| `identification` | Object | Passenger's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number ` | String | Identification number. Inside the `identification` object. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Utilities"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Direct sales"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| external_code| String | Item identification code. | +| title | String | Item name/title. | +| type | String | Item type. | +| description | String | Item description. | +| category_id | String | Item category. | +| quantity | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Automotive and nautical"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `payer`| Object | Payer data. | +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Urban transport"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `description` | String | Item description. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `payer`| Object | Payer data. | +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Betting"} +Add any extra information you consider necessary about: + +- Items (array `items`) + +| Field | Type | Description | +|--------------|---------|----------------------------------------| +| `external_code`| String | Item identification code. | +| `title` | String | Item name/title. | +| `category_id` | String | Item category. | +| `quantity` | Integer | Item quantity. | +| `unit_price` | String | Item unit price. | +| `warranty` | Boolean | Product has warranty. | + +- Payer (object `payer`) + +| Field | Type | Description | +|--------------------|---------|-------------------------------| +| `payer`| Object | Payer data. | +| `first_name`` | String | Payer's first name. | +| `last_name` | String | Payer's last name. | +| `identification` | Object | Payer's identification data (e.g. type and number). | +| `type` | String | Identification type. Inside the `identification` object. | +| `number` | String | Identification number. Inside the `identification` object. | +| `phone` | Object | Payer's phone. | +| `area_code`| String | Payer's area code. Inside the `phone` object. | +| `number` | String | Payer's phone number. Inside the `phone` object. | +| `address` | Object | Payer's address data. | +| `zip_code` | String | Payer's postal code. Inside the `address` object. | +| `street_name` | String | Street name of payer's address. Inside the `address` object. | +| `street_number` | String | Street number of payer's address. Inside the `address` object. | +| `city ` | String | City of payer's address. Inside the `address` object. | +| `state` | String | State of payer's address. Inside the `address` object. | +| `neighborhood` | String | Neighborhood of payer's address. Inside the `address` object. | +| `complement` | String | Address complement (e.g. floor, block, back). Inside the `address` object. | + +- Payer (object `additional_info`) + +| Field | Type | Description | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Authentication type. Can be "Gmail", "Facebook", "Native Web" or "Other". | +| `payer.registration_date` | Date | Payer's registration date on the site. Must be sent in ISO 8601 format. | +| `payer.is_prime_user` | Boolean | Indicates if user is premium. If yes, use `true`, if not, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indicates if it's the customer's first purchase. If yes, use `true`, if not, use `false`. | +| `payer.last_purchase` | Date | Date of last purchase on the site. Must be sent in ISO 8601 format. | + +See below an example of how to send the data presented in the tables above: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-industry-data.es.md b/guides/checkout-api-orders/improve-payment-approval-industry-data.es.md new file mode 100644 index 0000000000..c931ec466d --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-industry-data.es.md @@ -0,0 +1,1577 @@ +# Datos de industria + +De acuerdo con el ramo de actividades o sector de tu tienda, puedes incluir información adicional al momento de crear el pago que ayuda a aumentar las posibilidades de aprobación. + +A continuación, encontrarás algunos datos específicos para estas industrias que puedes agregar a tu integración. + +:::AccordionComponent{title="Indumentaria"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `type` | String | Tipo de ítem. | +| `description` | String | Descripción del ítem. | +| `picture_url` | String | URL de la imagen del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Electro"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | +| `warranty` | Boolean | Producto tiene garantía. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "", + "warranty": false + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Tickets y entretenimiento"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | +| `event_date` | Date | Fecha del evento. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Casa y decoración"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | +| `warranty` | Boolean | Producto tiene garantía. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Aplicativos y plataformas online"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Varejo"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|--------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `picture_url` | String | URL de la imagen del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "2", + "title": "Pasaje a Guarulhos", + "description": "Pasaje a Guarulhos", + "picture_url": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Servicios gubernamentales y públicos"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|----------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades. | +| `unit_price` | String | Precio unitario del ítem. | +| `event_date` | Date | Fecha del evento. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false, + "event_date": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Turismo"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +- Pasajeros (`additional_info.travel.passengers`) + +| Campo | Tipo | Descripción | +|------------------------|---------|----------------------------| +| `first_name` | String | Nombre del pasajero. Está dentro del objeto `passenger`. | +| `last_name` | String | Apellido del pasajero. Está dentro del objeto `passenger`. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number ` | String | Número de identificación. Está dentro del objeto `identification`. | + +- Rutas (`additional_info.travel.routes`) + +| Campo | Tipo | Descripción | +|----------------------|---------|----------------------------| +| `departure`| String | Lugar de partida de la ruta (ej: código del aeropuerto). | +| `destination`| String | Lugar de destino de la ruta (ej: código del aeropuerto). | +| `departure_date_time` | Date | Fecha y hora de salida de la ruta. | +| `arrival_date_time` | Date | Fecha y hora de llegada de la ruta. | +| `company`| String | Compañía responsable por la ejecución de la ruta. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false, + "event_date": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00", + "travel.passengers": [ + { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "11111111111" + } + } + ], + "travel.routes": [ + { + "departure": "GRU", + "destination": "CWB", + "departure_date_time": "2024/12/30T22:00", + "arrival_date_time": "2024/12/30T23:00", + "company": "gol" + }, + { + "departure": "GRU", + "destination": "CWB", + "departure_date_time": "2025/01/02T22:00", + "arrival_date_time": "2025/01/02T23:00", + "company": "azul" + } + ] + } +} +``` + +::: +:::AccordionComponent{title="Hospitalidad"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | +| `event_date` | Date | Fecha del evento. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +- Pasajeros (`additional_info.travel.passengers`) + +| Campo | Tipo | Descripción | +|------------------------|---------|----------------------------| +| `first_name` | String | Nombre del pasajero. Está dentro del objeto `passenger`. | +| `last_name` | String | Apellido del pasajero. Está dentro del objeto `passenger`. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number ` | String | Número de identificación. Está dentro del objeto `identification`. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "event_date": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00", + "travel.passengers": [ + { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "11111111111" + } + } + ] + } +} +``` + +::: +:::AccordionComponent{title="Utilidades"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Venta directa"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| external_code| String | Código de identificación del ítem. | +| title | String | Nombre/título del ítem. | +| type | String | Tipo de ítem. | +| description | String | Descripción del ítem. | +| category_id | String | Categoría del ítem. | +| quantity | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Automóviles y náutica"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `payer`| Object | Datos del comprador. | +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Transporte urbano"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `payer`| Object | Datos del comprador. | +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Pasaje a Curitiba", + "description": "Pasaje a Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Apuestas"} +Agrega cualquier información extra que consideres necesaria sobre: + +- Ítems (_array_ `items`) + +| Campo | Tipo | Descripción | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificación del ítem. | +| `title` | String | Nombre/título del ítem. | +| `description` | String | Descripción del ítem. | +| `category_id` | String | Categoría del ítem. | +| `quantity` | Integer | Cantidad de unidades del ítem. | +| `unit_price` | String | Precio unitario del ítem. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descripción | +|--------------------|---------|-------------------------------| +| `payer`| Object | Datos del comprador. | +| `first_name` | String | Nombre del comprador. | +| `last_name` | String | Apellido del comprador. | +| `identification` | Object | Datos de identificación del comprador (ej: tipo y número). | +| `type` | String | Tipo de identificación. Está dentro del objeto `identification`. | +| `number` | String | Número de identificación. Está dentro del objeto `identification`. | +| `phone` | Object | Teléfono del comprador. | +| `area_code`| String | Código de área del comprador. Está dentro del objeto `phone`. | +| `number` | String | Número de teléfono del comprador. Está dentro del objeto `phone`. | +| `address` | Object | Datos de la dirección del comprador. | +| `zip_code` | String | Código postal del comprador. Está dentro del objeto `address`. | +| `street_name` | String | Nombre de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `street_number` | String | Número de la calle de la dirección del comprador. Está dentro del objeto `address`. | +| `city ` | String | Ciudad de la dirección del comprador. Está dentro del objeto `address`. | +| `state` | String | Estado de la dirección del comprador. Está dentro del objeto `address`. | +| `neighborhood` | String | Barrio de la dirección del comprador. Está dentro del objeto `address`. | +| `complement` | String | Complemento de la dirección del comprador (ej: piso, bloque, fondo). Está dentro del objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descripción | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticación. Puede ser "Gmail", "Facebook", "Web Nativa" u "Otro". | +| `payer.registration_date` | Date | Fecha de registro del comprador en el sitio. Debe enviarse dentro del formato ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica si el usuario es premium. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica si es la primera compra del cliente. Si lo es, usa `true` y si no lo es, usa `false`. | +| `payer.last_purchase` | Date | Fecha de la última compra en el sitio. Debe enviarse dentro del formato ISO 8601. | + +A continuación, encontrarás un ejemplo de cómo enviar los datos presentados en las tablas anteriores: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "TIENDA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "DNI", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Apuesta deportiva", + "description": "Apuesta deportiva - Partido de fútbol", + "category_id": "betting", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-industry-data.pt.md b/guides/checkout-api-orders/improve-payment-approval-industry-data.pt.md new file mode 100644 index 0000000000..62447854ac --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-industry-data.pt.md @@ -0,0 +1,1563 @@ +# Dados de indústria + +De acordo com o ramo de atividades ou setor de sua loja, é possível incluir informações adicionais no momento da criação do pagamento que ajudam a aumentar as chances de aprovação. + +Veja abaixo alguns dados específicos para estas indústrias e que podem ser adicionados à sua integração. + +:::AccordionComponent{title="Vestuário"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `type` | String | Tipo de item. | +| `description` | String | Descrição do item. | +| `picture_url` | String | URL da imagem do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro". | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Eletro"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | +| `warranty` | Boolean | Produto tem garantia. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "type": "", + "unit_price": "", + "warranty": false + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Tickets e entretenimento"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | +| `event_date` | Date | Data do evento. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Casa e decoração"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | +| `warranty` | Boolean | Produto tem garantia. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Aplicativos e plataformas online"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Varejo"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|--------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `picture_url` | String | URL da imagem do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| ``first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "2", + "title": "Passagem Para Guarulhos", + "description": "Passagem Para Guarulhos", + "picture_url": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Serviços governamentais e públicos"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|----------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades. | +| `unit_price` | String | Preço unitário do item. | +| `event_date` | Date | Data do evento. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false, + "event_date": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Turismo"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +- Passageiros (`additional_info.travel.passengers`) + +| Campo | Tipo | Descrição | +|------------------------|---------|----------------------------| +| `first_name` | String | Nome do passageiro. Está dentro do objeto `passenger`. | +| `last_name` | String | Sobrenome do passageiro. Está dentro do objeto `passenger`. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number ` | String | Número de identificação. Está dentro do objeto `identification`. | + +- Rotas (`additional_info.travel.routes`) + +| Campo | Tipo | Descrição | +|----------------------|---------|----------------------------| +| `departure`| String | Local de partida da rota (ex: código do aeroporto). | +| `destination`| String | Local de destino da rota (ex: código do aeroporto). | +| `departure_date_time` | Date | Data e hora de saída da rota. | +| `arrival_date_time` | Date | Data e hora de chegada da rota. | +| `company`| String | Companhia responsável pela execução da rota. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "warranty": false, + "event_date": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00", + "travel.passengers": [ + { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "11111111111" + } + } + ], + "travel.routes": [ + { + "departure": "GRU", + "destination": "CWB", + "departure_date_time": "2024/12/30T22:00", + "arrival_date_time": "2024/12/30T23:00", + "company": "gol" + }, + { + "departure": "GRU", + "destination": "CWB", + "departure_date_time": "2025/01/02T22:00", + "arrival_date_time": "2025/01/02T23:00", + "company": "azul" + } + ] + } +} +``` + +::: +:::AccordionComponent{title="Hospitalidade"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário. | +| `event_date` | Date | Data do evento. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +- Passageiros (`additional_info.travel.passengers`) + +| Campo | Tipo | Descrição | +|------------------------|---------|----------------------------| +| `first_name` | String | Nome do passageiro. Está dentro do objeto `passenger`. | +| `last_name` | String | Sobrenome do passageiro. Está dentro do objeto `passenger`. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number ` | String | Número de identificação. Está dentro do objeto `identification`. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "", + "event_date": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00", + "travel.passengers": [ + { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "11111111111" + } + } + ] + } +} +``` + +::: +:::AccordionComponent{title="Utilitários"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00", + } +} +``` + +::: +:::AccordionComponent{title="Venda direta"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| external_code| String | Código de identificação do item. | +| title | String | Nome/título do item. | +| type | String | Tipo de item. | +| description | String | Descrição do item. | +| category_id | String | Categoria do item. | +| quantity | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Automóveis e náutica"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `payer`| Object | Dados do comprador. | +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "picture_url": "", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Transporte urbano"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +| `description` | String | Descrição do item. | +| `category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `payer`| Object | Dados do comprador. | +| `first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "description": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` + +::: +:::AccordionComponent{title="Apostas"} +Adicione qualquer informação extra que considerar necessária sobre: + +- Itens (_array_ `items`) + +| Campo | Tipo | Descrição | +|--------------|---------|----------------------------------------| +| `external_code`| String | Código de identificação do item. | +| `title` | String | Nome/título do item. | +|` category_id` | String | Categoria do item. | +| `quantity` | Integer | Quantidade de unidades do item. | +| `unit_price` | String | Preço unitário do item. | +| `warranty` | Boolean | Produto tem garantia. | + +- Comprador (_object_ `payer`) + +| Campo | Tipo | Descrição | +|--------------------|---------|-------------------------------| +| `payer`| Object | Dados do comprador. | +| ``first_name` | String | Nome do comprador. | +| `last_name` | String | Sobrenome do comprador. | +| `identification` | Object | Dados de identificação do comprador (ex: tipo e número). | +| `type` | String | Tipo de identificação. Está dentro do objeto `identification`. | +| `number` | String | Número de identificação. Está dentro do objeto `identification`. | +| `phone` | Object | Telefone do comprador. | +| `area_code`| String | Código de área do comprador. Está dentro do objeto `phone`. | +| `number` | String | Número de telefone do comprador. Está dentro do objeto `phone`. | +| `address` | Object | Dados do endereço do comprador. | +| `zip_code` | String | Código postal do comprador. Está dentro do objeto `address`. | +| `street_name` | String | Nome da rua do endereço do comprador. Está dentro do objeto `address`. | +| `street_number` | String | Número da rua do endereço do comprador. Está dentro do objeto `address`. | +| `city ` | String | Cidade do endereço do comprador. Está dentro do objeto `address`. | +| `state` | String | Estado do endereço do comprador. Está dentro do objeto `address`. | +| `neighborhood` | String | Bairro do endereço do comprador. Está dentro do objeto `address`. | +| `complement` | String | Complemento do endereço do comprador (ex: andar, bloco, fundos). Está dentro do objeto `address`. | + +- Comprador (_object_ `additional_info`) + +| Campo | Tipo | Descrição | +|--------------|---------|-----------------------------------------| +| `payer.authentication_type` | String | Tipo de autenticação. Pode ser "Gmail", "Facebook", "Web Nativa" ou "Outro" | +| `payer.registration_date` | Date | Data de registro do comprador no site. Precisa ser enviada dentro do formato do ISO 8601. | +| `payer.is_prime_user` | Boolean | Indica se o usuário é premium. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.is_first_purchase_online` | Boolean | Indica se é a primeira compra do cliente. Caso seja, use `true` e, caso não seja, use `false`. | +| `payer.last_purchase` | Date | Data da última compra no site. Precisa ser enviada dentro do formato do ISO 8601. | + +Veja abaixo um exemplo de como enviar os dados apresentados nas tabelas acima: + +```curl +{ + "type": "online", + "total_amount": "1000.00", + "external_reference": "ext_ref_1234", + "transactions": { + "payments": [ + { + "amount": "1000.00", + "payment_method": { + "id": "master", + "type": "credit_card", + "token": "677859ef5f18ea7e3a87c41d02c3fbe3", + "installments": 1, + "statement_descriptor": "LOJA X" + } + } + ] + }, + "payer": { + "first_name": "John", + "last_name": "Doe", + "identification": { + "type": "CPF", + "number": "316432423423" + }, + "phone": { + "area_code": "11", + "number": "43434343" + }, + "address": { + "zip_code": "11034430", + "street_name": "AV PAULISTA", + "street_number": "100", + "city": "SAO PAULO", + "state": "SP", + "neighborhood": "BELA VISTA", + "complement": "101" + } + }, + "items": [ + { + "external_code": "1", + "title": "Passagem Para Curitiba", + "category_id": "travel", + "quantity": 1, + "unit_price": "" + }, + "additional_info": { + "payer.registration_date": "2014-06-28T16:53:03.176-04:00", + "payer.authentication_type": "MOBILE", + "payer.is_prime_user": "true", + "payer.is_first_purchase_online": "true", + "payer.last_purchase": "2014-06-28T16:53:03.176-04:00" + } +} +``` \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.en.md b/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.en.md new file mode 100644 index 0000000000..5e0d8b2a6a --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.en.md @@ -0,0 +1,83 @@ +# Why is a payment rejected? + +----[mlb]---- +> RED_MESSAGE +> +> This documentation is intended for integrators. If you are a buyer and your payment was declined when using Mercado Pago, please check [this article](https://www.mercadopago.com.br/ajuda/25671) in our Help Center for guidance on how to proceed. + +------------ +----[mla]---- +> RED_MESSAGE +> +> This documentation is intended for integrators. If you are a buyer and your payment was declined when using Mercado Pago, please check [this article](https://www.mercadopago.com.ar/ayuda/25671) in our Help Center for guidance on how to proceed. + +------------ +----[mlm]---- +> RED_MESSAGE +> +> This documentation is intended for integrators. If you are a buyer and your payment was declined when using Mercado Pago, please check [this article](https://www.mercadopago.com.mx/ayuda/26516) in our Help Center for guidance on how to proceed. + +------------ + +Payment declines are a reality in the world of online sales and can happen for various reasons. **A payment may be declined due to**: + +* An error with the payment method; +* Incorrect information entered by the customer; +* Card with insufficient funds; +* Violation of necessary security requirements; +* Suspicious movements indicating fraud risk; +* Communication issues between acquirers and sub-acquirers. + +You can find **information and check the status of a payment** via API through the endpoint :TagComponent{tag="API" text="Get order by ID" href="/developers/en/reference/orders/online-payments/get-order/get"}. The `transactions.payments.status` field indicates whether the payment was approved or not, while the `transactions.payments.status_detail` field provides more details, including reasons for decline. + +```curl +... +"transactions": { + "payments": [ + { + "id": "PAY01J67CQQH5904WDBVZEM4JMEP3", + "amount": "24.90", + "reference_id": "01JEVQM899NWSQC4FYWWW7KTF9", + "status": "failed", + "status_detail": "insufficient_amount", +... +``` + +> SUCCESS_MESSAGE +> +> You can also find more information about payments in your [Mercado Pago](https://www.mercadopago[FAKER][URL][DOMAIN]/activities) account activity. + +:::AccordionComponent{title="Declines due to input errors"} +These decline reasons occur due to **errors during checkout**. This can happen for various reasons, such as misunderstanding of the payment screen, buyer experience issues, lack of field validation, or errors that the buyer may make when entering their data, especially card information. + +In these cases, the `transactions.payments.status_detail` field will return: + +* `bad_filled_card_data` + +::: +:::AccordionComponent{title="Declines by the issuing bank"} +When making a **credit or debit card payment**, for example, the issuing bank may decline the charge for different reasons, such as expired expiration date, insufficient balance or credit limit, disabled card, or card blocked for online purchases. + +In these cases, the `transactions.payments.status_detail` field may return: + +* `required_call_for_authorize` +* `card_disabled` +* `cc_rejected_duplicated_payment` +* `insufficient_amount` +* `invalid_installments` +* `max_attempts_exceeded` + +::: +:::AccordionComponent{title="Declines due to fraud prevention"} +We monitor transactions in real-time looking to **recognize suspicious patterns and resources** that indicate a fraud attempt. This is done by both Mercado Pago's algorithms and banks, all to minimize chargebacks as much as possible. + +When our fraud prevention system detects a suspicious payment, the `transactions.payments.status_detail` field may return: + +* `high_risk` +* `rejected_by_issuer` + +> WARNING +> +> In some cases, the `high_risk` response may occur when two consecutive payments are made with the same items or with very similar parameters (such as identical `payer` and `items` values in both payments made). This can trigger the anti-fraud engine, which may interpret the attempt as duplicate and reject it as a precaution. As a consequence, subsequent payments may be temporarily blocked. It is recommended to implement controls to prevent immediate new attempts with the same payment data. + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.es.md b/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.es.md new file mode 100644 index 0000000000..a787c9acc7 --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.es.md @@ -0,0 +1,83 @@ +# ¿Por qué se rechaza un pago? + +----[mlb]---- +> RED_MESSAGE +> +> Esta documentación está destinada a integradores. Si eres un comprador y tu pago fue rechazado al usar Mercado Pago, consulta [este artículo](https://www.mercadopago.com.br/ajuda/25671) en nuestro Centro de Ayuda para obtener orientación sobre cómo proceder. + +------------ +----[mla]---- +> RED_MESSAGE +> +> Esta documentación está destinada a integradores. Si eres un comprador y tu pago fue rechazado al usar Mercado Pago, consulta [este artículo](https://www.mercadopago.com.ar/ayuda/25671) en nuestro Centro de Ayuda para obtener orientación sobre cómo proceder. + +------------ +----[mlm]---- +> RED_MESSAGE +> +> Esta documentación está destinada a integradores. Si eres un comprador y tu pago fue rechazado al usar Mercado Pago, consulta [este artículo](https://www.mercadopago.com.mx/ayuda/26516) en nuestro Centro de Ayuda para obtener orientación sobre cómo proceder. + +------------ + +El rechazo de pagos es una realidad en el mundo de las ventas en línea y puede ocurrir por diversas razones. **Un pago puede ser rechazado por**: + +* Un error con el medio de pago; +* Información incorrecta ingresada por el cliente; +* Tarjeta sin saldo suficiente; +* Violación de requisitos de seguridad necesarios; +* Movimientos sospechosos que indican riesgo de fraude; +* Problemas en la comunicación entre adquirentes y subadquirentes. + +Puedes encontrar la **información y verificar el estado de un pago** vía API, a través del endpoint :TagComponent{tag="API" text="Obtener order por ID" href="/developers/es/reference/orders/online-payments/get-order/get"}. El campo `transactions.payments.status` indica si el pago fue o no aprobado, mientras que el campo `transactions.payments.status_detail` proporciona más detalles, incluyendo los motivos de rechazo. + +```curl +... +"transactions": { + "payments": [ + { + "id": "PAY01J67CQQH5904WDBVZEM4JMEP3", + "amount": "24.90", + "reference_id": "01JEVQM899NWSQC4FYWWW7KTF9", + "status": "failed", + "status_detail": "insufficient_amount", +... +``` + +> SUCCESS_MESSAGE +> +> También puedes encontrar más información sobre pagos en la actividad de tu cuenta de [Mercado Pago](https://www.mercadopago[FAKER][URL][DOMAIN]/activities). + +:::AccordionComponent{title="Rechazos debido a errores de ingreso"} +Estos motivos de rechazo ocurren debido a **errores durante el checkout**. Esto puede suceder por diversos motivos, como falta de comprensión de la pantalla de pago, problemas en la experiencia del comprador, falta de validación en los campos, o también errores que el comprador puede cometer al ingresar sus datos, principalmente los datos de la tarjeta. + +En estos casos, el campo `transactions.payments.status_detail` se devolverá como: + +* `bad_filled_card_data` + +::: +:::AccordionComponent{title="Rechazos por el banco emisor"} +Al realizar un **pago con tarjeta de crédito o débito**, por ejemplo, el banco emisor puede rechazar el cargo por diferentes motivos, como fecha de vencimiento expirada, saldo o límite insuficiente, tarjeta deshabilitada o bloqueada para compras en línea. + +En estos casos, el campo `transactions.payments.status_detail` podrá devolver: + +* `required_call_for_authorize` +* `card_disabled` +* `cc_rejected_duplicated_payment` +* `insufficient_amount` +* `invalid_installments` +* `max_attempts_exceeded` + +::: +:::AccordionComponent{title="Rechazos por prevención de fraudes"} +Realizamos el seguimiento en tiempo real de las transacciones buscando **reconocer recursos y patrones sospechosos** que indiquen un intento de fraude. Esto lo hacen tanto los algoritmos de Mercado Pago como los bancos, todo para evitar al máximo los contracargos (*chargebacks*). + +Cuando nuestro sistema de prevención de fraude detecta un pago sospechoso, el campo `transactions.payments.status_detail` podrá devolver: + +* `high_risk` +* `rejected_by_issuer` + +> WARNING +> +> En algunos casos, la respuesta `high_risk` puede ocurrir cuando se realizan dos pagos consecutivos con los mismos ítems o con parámetros muy similares (como valores en `payer` e `items` idénticos en ambos pagos realizados). Esto puede activar el motor antifraude, que puede interpretar el intento como duplicado y rechazarlo por precaución. Como consecuencia, los pagos subsiguientes pueden ser temporalmente bloqueados. Se recomienda implementar controles para evitar nuevos intentos inmediatos con los mismos datos de pago. + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.pt.md b/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.pt.md new file mode 100644 index 0000000000..2103c0c720 --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-reasons-for-rejection.pt.md @@ -0,0 +1,83 @@ +# Por que um pagamento é recusado? + +----[mlb]---- +> RED_MESSAGE +> +> Esta documentação é destinada a integradores. Se você é um comprador e teve seu pagamento recusado ao usar o Mercado Pago, consulte [este artigo](https://www.mercadopago.com.br/ajuda/25671) em nossa Central de Ajuda para orientações sobre como proceder. + +------------ +----[mla]---- +> RED_MESSAGE +> +> Esta documentação é destinada a integradores. Se você é um comprador e teve seu pagamento recusado ao usar o Mercado Pago, consulte [este artigo](https://www.mercadopago.com.ar/ayuda/25671s) em nossa Central de Ajuda para orientações sobre como proceder. + +------------ +----[mlm]---- +> RED_MESSAGE +> +> Esta documentação é destinada a integradores. Se você é um comprador e teve seu pagamento recusado ao usar o Mercado Pago, consulte [este artigo](https://www.mercadopago.com.mx/ayuda/26516) em nossa Central de Ajuda para orientações sobre como proceder. + +------------ + +A recusa de pagamentos é uma realidade no mundo das vendas online e pode acontecer por diversas razões. **Um pagamento pode ser recusado por**: + +* Um erro com o meio de pagamento; +* Preenchimento incorreto das informações por parte do cliente; +* Cartão sem saldo suficiente; +* Violação de requisitos de segurança necessários; +* Movimentos suspeitos indicando risco de fraude; +* Problemas na comunicação entre adquirentes e subadquirentes. + +Você pode encontrar as **informações e checar o estado de um pagamento** via API, através do endpoint :TagComponent{tag="API" text="Obter order por ID" href="/developers/pt/reference/orders/online-payments/get-order/get"}. O campo `transactions.payments.status` indica se o pagamento foi ou não aprovado, enquanto o campo `transactions.payments.status_detail` traz mais detalhes, incluindo os motivos de recusa. + +```curl +... +"transactions": { + "payments": [ + { + "id": "PAY01J67CQQH5904WDBVZEM4JMEP3", + "amount": "24.90", + "reference_id": "01JEVQM899NWSQC4FYWWW7KTF9", + "status": "failed", + "status_detail": "insufficient_amount", +... +``` + +> SUCCESS_MESSAGE +> +> Também é possível achar mais informações sobre pagamentos na atividade da conta de [Mercado Pago](https://www.mercadopago[FAKER][URL][DOMAIN]/activities). + +:::AccordionComponent{title="Recusas devido a erros de preenchimento"} +Estes motivos de recusa acontecem devido a **erros no momento do checkout**. Isso pode acontecer por diversos motivos, como por exemplo falha de entendimento da tela de pagamento, problemas de experiência do comprador, falta de validação nos campos, ou também erros que o comprador pode cometer na hora de preencher seus dados, principalmente os dados de cartão. + +Nestes casos o campo `transactions.payments.status_detail` será retornado como: + +* `bad_filled_card_data` + +::: +:::AccordionComponent{title="Recusas pelo banco emissor"} +Ao realizar um **pagamento com cartão de crédito ou débito**, por exemplo, o banco emissor pode recusar a cobrança por diferentes motivos, como data de validade expirada, saldo ou limite insuficientes, cartão desabilitado ou bloqueado para compras online. + +Nestes casos o campo `transactions.payments.status_detail` poderá retornar: + +* `required_call_for_authorize` +* `card_disabled` +* `cc_rejected_duplicated_payment` +* `insufficient_amount` +* `invalid_installments` +* `max_attempts_exceeded` + +::: +:::AccordionComponent{title="Recusas por prevenção contra fraudes"} +Fazemos o acompanhamento em tempo real das transações procurando **reconhecer recursos e padrões suspeitos** que apontam para uma tentativa de fraude. Isso é feito tanto pelos algoritmos do Mercado Pago quanto pelos bancos, tudo para evitar ao máximo estornos (*chargebacks*). + +Quando o nosso sistema de prevenção de fraude detectar um pagamento suspeito, o campo `transactions.payments.status_detail` poderá retornar: + +* `high_risk` +* `rejected_by_issuer` + +> WARNING +> +> Em alguns casos, a resposta `high_risk` pode ocorrer quando dois pagamentos consecutivos são realizados com os mesmos itens ou com parâmetros muito semelhantes (como valores em `payer` e `items` idênticos em ambos os pagamentos realizados). Isso pode acionar o motor antifraude, que pode interpretar a tentativa como duplicada e rejeitá-la por precaução. Como consequência, os pagamentos subsequentes podem ser temporariamente bloqueados. É recomendável implementar controles para evitar novas tentativas imediatas com os mesmos dados de pagamento. + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-recommendations.en.md b/guides/checkout-api-orders/improve-payment-approval-recommendations.en.md new file mode 100644 index 0000000000..85cbb33dc2 --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-recommendations.en.md @@ -0,0 +1,217 @@ +# Recommendations to improve approval + +To **prevent a legitimate payment from being rejected** for not meeting security validations, you need to include as much information as possible when performing the operation and ensure your checkout has an optimized interface. + +Check out our **recommendations to improve your approval rate**. + +:::::AccordionComponent{title="Get and send the Device ID"} +The **Device ID** is important information to ensure better security and, consequently, a better payment approval rate. It is a **unique identifier for each buyer's device** at the time of purchase. + +When a frequent buyer makes a purchase from a different device than usual, this might be seen as atypical behavior. Although it is not necessarily fraud, the Device ID helps us refine our evaluation and prevent us from rejecting legitimate payments. + +::::TabsComponent + +:::TabComponent{title="Device ID in web applications"} +To use Device ID on the web and prevent possible fraudulent purchases, follow these steps: + +> WARNING +> +> If you're already using [Mercado Pago's JS SDK](/developers/en/docs/sdks-library/client-side/mp-js-v2), you **do not** need to add the security script because the Device ID is obtained by default. In this case, go directly to the [Device ID usage](/developers/en/docs/checkout-api-v2/additional-settings/improve-payment-approval/recommendations#bookmark_3._use_the_device_id) step. + +#### 1. Add Mercado Pago's security script + +To implement Device ID generation on your site, add this script to your checkout page: + +```html + +``` + +> NOTE +> +> You can add the Mercado Pago security script to any page on your site by replacing the `view` value with the name of the section where you want to add it, such as `home` or `search`, for example. This helps to enrich the information collected for generating the Device ID. + +#### 2. Get the Device ID + +When you've added Mercado Pago's security script to your site, a _Javascript_ global variable called `MP_DEVICE_SESSION_ID` will be automatically created, containing the Device ID. + +If you prefer to use another variable, you can specify the name by adding the `output` attribute to the security _script_, like this: + +```html + +``` + +You can also **create your own variable**. Just add an `html` tag to your site with the identifier `id="deviceID"`, like this: + +```html + +``` + +#### 3. Use the Device ID + +Once you have the Device ID value, you need to **send it to our servers** when creating a payment. It is very simple: just add this `header` to your request: + +```html +X-meli-session-id: device_id +``` + +> NOTE +> +> Do not forget to replace `device_id` with the name of the variable where you stored your Device ID value. + +::: +:::TabComponent{title="Device ID in mobile applications"} +If you have a native mobile application, you can capture device information with our SDK and send it when creating the _token_. Follow these steps: + +#### 1. Add the dependency + +Based on your mobile application's operating system, add this dependency: + +[[[ +```ios +=== +Put this code in the **Podfile** file. +=== +use_frameworks! +pod 'MercadoPagoDevicesSDK' +``` +```android +=== +Add the repository and dependency to the **build.gradle** file. +=== +repositories { + maven { + url "https://artifacts.mercadolibre.com/repository/android-releases" + } +} +dependencies { + implementation 'com.mercadolibre.android.device:sdk:4.0.1' +} +``` +]]] + +#### 2. Initialize the module + +After adding the dependency, initialize the module using one of these languages: + +[[[ +```swift +=== +We recommend initializing the **AppDelegate** in the **didFinishLaunchingWithOptions** event. +=== +import MercadoPagoDevicesSDK +... +func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { + ... + MercadoPagoDevicesSDK.shared.execute() + ... +} +``` +```objective-c +=== +We recommend initializing the **AppDelegate** in the **didFinishLaunchingWithOptions** event. +=== +@import 'MercadoPagoDevicesSDK'; +... +- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + ... + [[MercadoPagoDevicesSDK shared] execute]; + ... +} +``` +```java +=== +We recommend initializing in the **MainApplication** class. +=== +import com.mercadolibre.android.device.sdk.DeviceSDK; +DeviceSDK.getInstance().execute(this); +``` +]]] + +#### 3. Capture the information + +Use any of these functions to get the information in the format you need: + +[[[ +```swift +MercadoPagoDevicesSDK.shared.getInfo() // Returns a Device object that is Codable +MercadoPagoDevicesSDK.shared.getInfoAsJson() // Returns an object in JSON +MercadoPagoDevicesSDK.shared.getInfoAsJsonString() // Returns the JSON in String format +MercadoPagoDevicesSDK.shared.getInfoAsDictionary() // Returns a Dictionary object +``` +```objective-c +[[[MercadoPagoDevicesSDK] shared] getInfoAsJson] // Returns an object in JSON +[[[MercadoPagoDevicesSDK] shared] getInfoAsJsonString] // Returns the JSON in String format +[[[MercadoPagoDevicesSDK] shared] getInfoAsDictionary] // Returns a Dictionary object +``` +```java +Device device = DeviceSDK.getInstance().getInfo() // Returns a Device object that is serializable +Map deviceMap = DeviceSDK.getInstance().getInfoAsMap() // Returns a Map +String jsonString = DeviceSDK.getInstance().getInfoAsJsonString() // Returns a String in JSON format +``` +]]] + +#### 4. Send the information + +Finally, send the information you obtained in the `device` field when creating the `card_token`. + +``` +{ + ..., + "device":{ + "fingerprint":{ + "os":"iOS", + "system_version":"8.3", + "ram":18446744071562067968, + "disk_space":498876809216, + "model":"MacBookPro9,2", + "free_disk_space":328918237184, + "vendor_ids":[ + { + "name":"vendor_id", + "value":"C2508642-79CF-44E4-A205-284A4F4DE04C" + }, + { + "name":"uuid", + "value":"AB28738B-8DC2-4EC2-B514-3ACF330482B6" + } + ], + "vendor_specific_attributes":{ + "feature_flash":false, + "can_make_phone_calls":false, + "can_send_sms":false, + "video_camera_available":true, + "cpu_count":4, + "simulator":true, + "device_languaje":"en", + "device_idiom":"Phone", + "platform":"x86_64", + "device_name":"iPhone Simulator", + "device_family":4, + "retina_display_capable":true, + "feature_camera":false, + "device_model":"iPhone Simulator", + "feature_front_camera":false + }, + "resolution":"375x667" + } +} +``` + +::: +:::: + +::::: +:::AccordionComponent{title="Include all payment data"} +To optimize payment security validation and improve approvals, it is important to **send as much data as possible about the buyer and the product**. + +Take a look at all the attributes you can send when :TagComponent{tag="API" text="creating an order" href="/developers/en/reference/orders/online-payments/create/post"}, especially the additional information (`additional_info`), such as **buyer data**, **product details**, and **shipping information**. + +There are also **extra fields** you can send based on **your business sector**. You can see more details about each sector and the data we recommend including in the [Industry Data](/developers/en/docs/checkout-api-v2/additional-settings/improve-payment-approval/industry-data) documentation. + +::: +:::AccordionComponent{title="Improve the user experience"} +Sometimes buyers can make mistakes when filling in their information at checkout. That's why it is good to review each step, the interactions, and even the design, to make sure everything is as clear as possible. + +If a payment is rejected, it is important to explain to your customers why it was rejected and what they can do to fix it. This way, they'll have all the information they need to pay without problems. Check out [here](/developers/en/docs/checkout-api-v2/payment-management/status/order-status) our **recommended messages for the main rejection reasons**. + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-recommendations.es.md b/guides/checkout-api-orders/improve-payment-approval-recommendations.es.md new file mode 100644 index 0000000000..77305f0ad7 --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-recommendations.es.md @@ -0,0 +1,217 @@ +# Recomendaciones para mejorar la aprobación + +Para **evitar que un pago legítimo sea rechazado** por no cumplir con las validaciones de seguridad, necesitas incluir la mayor cantidad de información posible al realizar la operación y asegurarte de que tu checkout tenga una interfaz optimizada. + +Ve a continuación nuestras **recomendaciones para mejorar tu aprobación**. + +:::::AccordionComponent{title="Obtener y enviar el Device ID"} +El **Device ID** es una información importante para garantizar una mejor seguridad y, por lo tanto, una mejor tasa de aprobación de pagos. Es un **identificador único para cada dispositivo del comprador** en el momento de la compra. + +Si un comprador frecuente hace una compra desde un dispositivo diferente al que suele usar, esto puede verse como un comportamiento atípico. Aunque no necesariamente sea un fraude, el ID del dispositivo nos ayuda a afinar la evaluación y evitar que rechacemos pagos legítimos. + +::::TabsComponent + +:::TabComponent{title="Device ID en aplicaciones web"} +Para usar el Device ID en la web y evitar posibles compras fraudulentas, sigue estos pasos: + +> WARNING +> +> Si ya estás usando el [SDK JS de Mercado Pago](/developers/es/docs/sdks-library/client-side/mp-js-v2), **no** necesitas agregar el _script_ de seguridad porque el Device ID se obtiene por defecto. En este caso, pasa directamente al paso de [uso del Device ID](/developers/es/docs/checkout-api-v2/additional-settings/improve-payment-approval/recommendations#bookmark_3._usa_el_device_id). + +#### 1. Agrega el script de seguridad de Mercado Pago + +Para implementar la generación del Device ID en tu sitio, agrega este _script_ en tu página de checkout: + +```html + +``` + +> NOTE +> +> Puedes agregar el _script_ de seguridad de Mercado Pago en cualquier página de tu sitio sustituyendo el valor de `view` por el nombre de la sección en la que deseas añadirlo, como `home` o `search`, por ejemplo. Esto ayuda a enriquecer la información recopilada para generar el Device ID. + +#### 2. Obtén el Device ID + +Cuando hayas agregado el _script_ de seguridad de Mercado Pago en tu sitio, se creará automáticamente una variable global de _Javascript_ llamada `MP_DEVICE_SESSION_ID`, que contiene el Device ID. + +Si prefieres usar otra variable, puedes indicar el nombre agregando el atributo `output` al _script_ de seguridad, como en este ejemplo: + +```html + +``` + +También puedes **crear tu propia variable**. Solo tienes que agregar una etiqueta `html` en tu sitio con el identificador `id="deviceID"`, así: + +```html + +``` + +#### 3. Usa el Device ID + +Una vez que tengas el valor de Device ID, necesitas **enviarlo a nuestros servidores** al crear un pago. Es muy simple: solo agrega este `header` a tu solicitud: + +```html +X-meli-session-id: device_id +``` + +> NOTE +> +> No olvides reemplazar `device_id` por el nombre de la variable donde guardaste tu valor de Device ID. + +::: +:::TabComponent{title="Device ID en aplicaciones móviles"} +Si tienes una aplicación móvil nativa, puedes capturar la información del dispositivo con nuestro SDK y enviarla cuando crees el _token_. Sigue estos pasos: + +#### 1. Agrega la dependencia + +Según el sistema operativo de tu aplicación móvil, agrega esta dependencia: + +[[[ +```ios +=== +Pon este código en el archivo **Podfile**. +=== +use_frameworks! +pod 'MercadoPagoDevicesSDK' +``` +```android +=== +Agrega el repositorio y la dependencia en el archivo **build.gradle**. +=== +repositories { + maven { + url "https://artifacts.mercadolibre.com/repository/android-releases" + } +} +dependencies { + implementation 'com.mercadolibre.android.device:sdk:4.0.1' +} +``` +]]] + +#### 2. Inicializa el módulo + +Después de agregar la dependencia, inicializa el módulo usando uno de estos lenguajes: + +[[[ +```swift +=== +Te recomendamos inicializar el **AppDelegate** en el evento **didFinishLaunchingWithOptions**. +=== +import MercadoPagoDevicesSDK +... +func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { + ... + MercadoPagoDevicesSDK.shared.execute() + ... +} +``` +```objective-c +=== +Te recomendamos inicializar el **AppDelegate** en el evento **didFinishLaunchingWithOptions**. +=== +@import 'MercadoPagoDevicesSDK'; +... +- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + ... + [[MercadoPagoDevicesSDK shared] execute]; + ... +} +``` +```java +=== +Te recomendamos inicializar en la clase **MainApplication**. +=== +import com.mercadolibre.android.device.sdk.DeviceSDK; +DeviceSDK.getInstance().execute(this); +``` +]]] + +#### 3. Captura la información + +Usa cualquiera de estas funciones para obtener la información en el formato que necesites: + +[[[ +```swift +MercadoPagoDevicesSDK.shared.getInfo() // Te da un objeto Device que es Codificable +MercadoPagoDevicesSDK.shared.getInfoAsJson() // Te da un objeto en JSON +MercadoPagoDevicesSDK.shared.getInfoAsJsonString() // Te da el JSON en formato de String +MercadoPagoDevicesSDK.shared.getInfoAsDictionary() // Te da un objeto Dictionary +``` +```objective-c +[[[MercadoPagoDevicesSDK] shared] getInfoAsJson] // Te da un objeto en JSON +[[[MercadoPagoDevicesSDK] shared] getInfoAsJsonString] // Te da el JSON en formato de String +[[[MercadoPagoDevicesSDK] shared] getInfoAsDictionary] // Te da un objeto Dictionary +``` +```java +Device device = DeviceSDK.getInstance().getInfo() // Te da un objeto Device, que es serializable +Map deviceMap = DeviceSDK.getInstance().getInfoAsMap() // Te da un Map +String jsonString = DeviceSDK.getInstance().getInfoAsJsonString() // Te da una String en formato JSON +``` +]]] + +#### 4. Envía la información + +Por último, envía la información que obtuviste en el campo `device` cuando crees el `card_token`. + +``` +{ + ..., + "device":{ + "fingerprint":{ + "os":"iOS", + "system_version":"8.3", + "ram":18446744071562067968, + "disk_space":498876809216, + "model":"MacBookPro9,2", + "free_disk_space":328918237184, + "vendor_ids":[ + { + "name":"vendor_id", + "value":"C2508642-79CF-44E4-A205-284A4F4DE04C" + }, + { + "name":"uuid", + "value":"AB28738B-8DC2-4EC2-B514-3ACF330482B6" + } + ], + "vendor_specific_attributes":{ + "feature_flash":false, + "can_make_phone_calls":false, + "can_send_sms":false, + "video_camera_available":true, + "cpu_count":4, + "simulator":true, + "device_languaje":"en", + "device_idiom":"Phone", + "platform":"x86_64", + "device_name":"iPhone Simulator", + "device_family":4, + "retina_display_capable":true, + "feature_camera":false, + "device_model":"iPhone Simulator", + "feature_front_camera":false + }, + "resolution":"375x667" + } +} +``` + +::: +:::: + +::::: +:::AccordionComponent{title="Incluye todos los datos del pago"} +Para optimizar la validación de seguridad de los pagos y mejorar las aprobaciones, es importante que **envíes la mayor cantidad de datos posible sobre el comprador y el producto**. + +Fíjate en todos los atributos que puedes enviar al :TagComponent{tag="API" text="crear una order" href="/developers/es/reference/orders/online-payments/create/post"}, especialmente en la información adicional (`additional_info`), como los **datos del comprador**, los **detalles del producto** y la **información de envío**. + +También hay **campos extra** que puedes enviar según **tu rubro**. Puedes ver más detalles sobre cada sector y los datos que te recomendamos incluir en la documentación de [Datos de industria](/developers/es/docs/checkout-api-v2/additional-settings/improve-payment-approval/industry-data). + +::: +:::AccordionComponent{title="Mejora la experiencia del usuario"} +A veces los compradores pueden equivocarse al completar sus datos en el checkout. Por eso, es bueno que revises cada paso, las interacciones y hasta el diseño, para asegurarte de que todo esté lo más claro posible. + +Si un pago es rechazado, es importante que le expliques a tus clientes por qué se rechazó y qué pueden hacer para solucionarlo. Así tendrán toda la información que necesitan para pagar sin problemas. Ve [aquí](/developers/es/docs/checkout-api-v2/payment-management/status/order-status) nuestras **recomendaciones de mensajes para los principales motivos de rechazo**. + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/improve-payment-approval-recommendations.pt.md b/guides/checkout-api-orders/improve-payment-approval-recommendations.pt.md new file mode 100644 index 0000000000..344226979f --- /dev/null +++ b/guides/checkout-api-orders/improve-payment-approval-recommendations.pt.md @@ -0,0 +1,217 @@ +# Recomendações para melhorar a aprovação + +Para **evitar que um pagamento legítimo seja recusado** por não atender as validações de segurança, é necessário incluir o máximo de informações possíveis na hora de realizar a operação e também que seu checkout esteja com uma interface otimizada. + +Veja abaixo nossas **recomendações para melhorar sua aprovação**. + +:::::AccordionComponent{title="Obter e enviar o Device ID"} +O **Device ID** é uma informação importante para garantir uma melhor segurança e, consequentemente, uma melhor taxa de aprovação de pagamentos. Ele representa um **identificador único para cada dispositivo do comprador** no momento da compra. + +Caso um comprador frequente faça uma compra a partir de um dispositivo diferente do habitual, isso pode representar um comportamento atípico. Embora possa não ser necessariamente fraude, o ID do dispositivo nos ajuda a refinar a avaliação e nos impede de rejeitar pagamentos legítimos. + +::::TabsComponent + +:::TabComponent{title="Device ID em aplicações web"} +Para usar o Device ID na web e evitar possíveis compras fraudulentas, siga os passos abaixo: + +> WARNING +> +> Caso já esteja utilizando o [SDK JS do Mercado Pago](/developers/pt/docs/sdks-library/client-side/mp-js-v2), **não** será necessário adicionar o _script_ de segurança porque o Device ID será obtido por padrão. Neste caso, siga diretamente para a etapa de [utilização do Device ID](/developers/pt/docs/checkout-api-v2/additional-settings/improve-payment-approval/recommendations#editor_4#bookmark_3._utilize_o_device_id). + +#### 1. Adicione o script de segurança do Mercado Pago + +Para implementar a geração do device ID em seu site, adicione o seguinte _script_ na sua página de checkout: + +```html + +``` + +> NOTE +> +> Você pode adicionar o _script_ de segurança do Mercado Pago em qualquer página de seu site substituindo o valor de `view` pelo nome da seção na qual deseja adicioná-lo, como `home` ou `search`, por exemplo. Isso ajuda a enriquecer as informações coletadas para geração do Device ID. + +#### 2. Obtenha o Device ID + +Uma vez que você tenha adicionado o _script_ de segurança do Mercado Pago em seu site, uma variável global de _Javascript_ é criada automaticamente com o nome `MP_DEVICE_SESSION_ID`, cujo valor é o Device ID. + +Se você preferir atribuí-lo a outra variável, indique o nome adicionando o atributo `output` ao _script_ de segurança, como no exemplo abaixo. + +```html + +``` + +Você também pode **criar sua própria variável**. Para isso, adicione uma tag `html` no seu site com o identificador `id="deviceID"`, como no exemplo abaixo. + +```html + +``` + +#### 3. Utilize o Device ID + +Uma vez que você tenha o valor de Device ID, é preciso que você **o envie aos nossos servidores** ao criar um pagamento. Para isso, basta acrescentar o seguinte `header` à requisição: + +```html +X-meli-session-id: device_id +``` + +> NOTE +> +> Lembre-se de substituir `device_id` pelo nome da variável que contém o seu valor de Device ID. + +::: +:::TabComponent{title="Device ID em aplicações móveis"} +Se você possui uma aplicação móvel nativa, poderá capturar a informação do dispositivo com nosso SDK e enviar no momento de criar o _token_. Para isso, siga as etapas abaixo. + +#### 1. Adicione a dependência + +De acordo com o sistema operacional em que está configurada a aplicação móvel, adicione a dependência abaixo. + +[[[ +```ios +=== +Insira o código abaixo no arquivo **Podfile**. +=== +use_frameworks! +pod ‘MercadoPagoDevicesSDK’ +``` +```android +=== +Insira o repositório e a dependência abaixo no arquivo **build.gradle**. +=== +repositories { + maven { + url "https://artifacts.mercadolibre.com/repository/android-releases" + } +} +dependencies { + implementation 'com.mercadolibre.android.device:sdk:4.0.1' +} +``` +]]] + +#### 2. Inicialize o módulo + +Após adicionar a dependência, inicialize o módulo com uma das linguagens abaixo. + +[[[ +```swift +=== +Recomendamos a inicialização do **AppDelegate** no envento **didFinishLaunchingWithOptions**. +=== +import MercadoPagoDevicesSDK +... +func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { + ... + MercadoPagoDevicesSDK.shared.execute() + ... +} +``` +```objective-c +=== +Recomendamos a inicialização do **AppDelegate** no envento **didFinishLaunchingWithOptions**. +=== +@import ‘MercadoPagoDevicesSDK’; +... +- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + ... + [[MercadoPagoDevicesSDK shared] execute]; + ... +} +``` +```java +=== +Recomendamos a inicialização na classe **MainApplication**. +=== +import com.mercadolibre.android.device.sdk.DeviceSDK; +DeviceSDK.getInstance().execute(this); +``` +]]] + +#### 3. Capture a informação + +Execute alguma das funções abaixo para obter a informação no formato que precisar. + +[[[ +```swift +MercadoPagoDevicesSDK.shared.getInfo() // Devolve um objeto Device que é Codificável +MercadoPagoDevicesSDK.shared.getInfoAsJson() // Devolve um objeto em JSON +MercadoPagoDevicesSDK.shared.getInfoAsJsonString() // Devolve o JSON em formato de String +MercadoPagoDevicesSDK.shared.getInfoAsDictionary() // Devolve um objeto Dictionary +``` +```objective-c +[[[MercadoPagoDevicesSDK] shared] getInfoAsJson] // Devolve um objeto em JSON +[[[MercadoPagoDevicesSDK] shared] getInfoAsJsonString] // Devolve o JSON em formato de String +[[[MercadoPagoDevicesSDK] shared] getInfoAsDictionary] // Deolve um objeto Dictionary +``` +```java +Device device = DeviceSDK.getInstance().getInfo() // Devolve um objeto Device, que é serializável +Map deviceMap = DeviceSDK.getInstance().getInfoAsMap() // Devolve um Map +String jsonString = DeviceSDK.getInstance().getInfoAsJsonString() // Devolve uma String no formato JSON +``` +]]] + +#### 4. Envie a informação + +Por último, envie a informação obtida no campo `device` ao criar o `card_token`. + +``` +{ + ..., + "device":{ + "fingerprint":{ + "os":"iOS", + "system_version":"8.3", + "ram":18446744071562067968, + "disk_space":498876809216, + "model":"MacBookPro9,2", + "free_disk_space":328918237184, + "vendor_ids":[ + { + "name":"vendor_id", + "value":"C2508642-79CF-44E4-A205-284A4F4DE04C" + }, + { + "name":"uuid", + "value":"AB28738B-8DC2-4EC2-B514-3ACF330482B6" + } + ], + "vendor_specific_attributes":{ + "feature_flash":false, + "can_make_phone_calls":false, + "can_send_sms":false, + "video_camera_available":true, + "cpu_count":4, + "simulator":true, + "device_languaje":"en", + "device_idiom":"Phone", + "platform":"x86_64", + "device_name":"iPhone Simulator", + "device_family":4, + "retina_display_capable":true, + "feature_camera":false, + "device_model":"iPhone Simulator", + "feature_front_camera":false + }, + "resolution":"375x667" + } +} +``` + +::: +:::: + +::::: +:::AccordionComponent{title="Detalhar todas as informações sobre o pagamento"} +Para otimizar a validação de segurança dos pagamentos e melhorar as aprovações, é importante fazer **o envio do máximo de dados sobre o comprador e o produto**. + +Se atente a todos os atributos disponíveis para serem enviados ao :TagComponent{tag="API" text="criar uma order" href="/developers/pt/reference/orders/online-payments/create/post"}, prestando atenção especialmente nas informações adicionais (`additional_info`), como nos **dados do comprador**, nos **detalhes sobre o produto** e nas **informaçÕes de envio**. + +Existem também **campos extras** que podem ser enviados de acordo com **o ramo de atividade**. Você pode encontrar mais detalhes sobre cada setor e os dados que recomendamos incluir em cada um deles na documentação de [Dados de indústria](/developers/pt/docs/checkout-api-v2/additional-settings/improve-payment-approval/industry-data). + +::: +:::AccordionComponent{title="Melhorar a experiência do usuário"} +Muitas vezes o comprador pode errar na hora de preencher seus dados no checkout. Por isso, vale a pena revisar cada passo, interações e até design, para checar se tudo está claro como deveria. + +Se um pagamento for negado, é importante também que você explique aos seus clientes o motivo da recusa e o que eles poderão fazer para resolver o problema. Assim, seus clientes terão todas as informações necessárias para pagar sem problemas. Veja [aqui](/developers/pt/docs/checkout-api-v2/payment-management/status/order-status). **recomendações de mensagens para os principais motivos de recusa**. + +::: \ No newline at end of file diff --git a/guides/checkout-api-orders/integration-test-cards.en.md b/guides/checkout-api-orders/integration-test-cards.en.md index 31aefe8fca..61a1253f0c 100644 --- a/guides/checkout-api-orders/integration-test-cards.en.md +++ b/guides/checkout-api-orders/integration-test-cards.en.md @@ -10,7 +10,7 @@ To make a successful test purchase, fill in the required data at checkout follow ### Buyer Email -In the **email** field, enter the email address **test @testuser.com**, which is the only one allowed for testing. This way, your system will understand that it is a purchase made with a test buyer user. +In the **email** field, enter the email address `test@testuser.com`, **which is the only one allowed for testing**. This way, your system will understand that it is a purchase made with a test buyer user. ### Card Details diff --git a/guides/checkout-api-orders/integration-test-cards.es.md b/guides/checkout-api-orders/integration-test-cards.es.md index 7cc4b05a63..322642e3d1 100644 --- a/guides/checkout-api-orders/integration-test-cards.es.md +++ b/guides/checkout-api-orders/integration-test-cards.es.md @@ -10,7 +10,7 @@ Para realizar una compra de prueba exitosa, completa los datos requeridos en el ### E-mail del comprador -En el campo **e-mail**, ingresa el correo electrónico **test @testuser.com**, que es el único permitido para pruebas. De esta manera, tu sistema entenderá que se trata de una compra realizada con un usuario comprador de prueba. +En el campo **e-mail**, ingresa el correo electrónico `test@testuser.com`, **que es el único permitido para pruebas**. De esta manera, tu sistema entenderá que se trata de una compra realizada con un usuario comprador de prueba. ### Datos de la tarjeta diff --git a/guides/checkout-api-orders/integration-test-cards.pt.md b/guides/checkout-api-orders/integration-test-cards.pt.md index a71aa92faf..4032c8540f 100644 --- a/guides/checkout-api-orders/integration-test-cards.pt.md +++ b/guides/checkout-api-orders/integration-test-cards.pt.md @@ -10,7 +10,7 @@ Para realizar uma compra de teste com sucesso, complete os dados requeridos no c ### E-mail do comprador -No campo **e-mail**, insira o e-mail **test @testuser.com**, que é o único permitido para testes. Desta forma, seu sistema entenderá que se trata de uma compra realizada com um usuário comprador de teste. +No campo **e-mail**, insira o e-mail `test@testuser.com`, **que é o único permitido para testes. Desta forma**, seu sistema entenderá que se trata de uma compra realizada com um usuário comprador de teste. ### Dados do cartão diff --git a/guides/checkout-api-orders/payment-integration-boleto.en.md b/guides/checkout-api-orders/payment-integration-boleto.en.md index 43e89d2e8f..aacefe9b57 100644 --- a/guides/checkout-api-orders/payment-integration-boleto.en.md +++ b/guides/checkout-api-orders/payment-integration-boleto.en.md @@ -175,7 +175,7 @@ curl -X POST \ { "amount": "200.00", "payment_method": { - "id": "bolbradesco", + "id": "boleto", "type": "ticket" } } diff --git a/guides/checkout-api-orders/payment-integration-boleto.es.md b/guides/checkout-api-orders/payment-integration-boleto.es.md index 0e1e8613f4..e6c48007df 100644 --- a/guides/checkout-api-orders/payment-integration-boleto.es.md +++ b/guides/checkout-api-orders/payment-integration-boleto.es.md @@ -175,7 +175,7 @@ curl -X POST \ { "amount": "200.00", "payment_method": { - "id": "bolbradesco", + "id": "boleto", "type": "ticket" } } diff --git a/guides/checkout-api-orders/payment-integration-boleto.pt.md b/guides/checkout-api-orders/payment-integration-boleto.pt.md index 75458080c1..c9bebbdbd9 100644 --- a/guides/checkout-api-orders/payment-integration-boleto.pt.md +++ b/guides/checkout-api-orders/payment-integration-boleto.pt.md @@ -175,7 +175,7 @@ curl -X POST \ { "amount": "200.00", "payment_method": { - "id": "bolbradesco", + "id": "boleto", "type": "ticket" } } diff --git a/guides/checkout-api-orders/payment-integration-cards.en.md b/guides/checkout-api-orders/payment-integration-cards.en.md index 04507169ea..c3077ea4a1 100644 --- a/guides/checkout-api-orders/payment-integration-cards.en.md +++ b/guides/checkout-api-orders/payment-integration-cards.en.md @@ -841,7 +841,7 @@ In case of success, the response will look like the example below. "status": "action_required", "status_detail": "waiting_payment", "payment_method": { - "id": "bolbradesco", + "id": "boleto", "type": "ticket", "ticket_url": "https://www.mercadopago.com.ar/payments/86797024510/ticket?caller_id=1870026883&payment_method_id=rapipago&payment_id=86797024510&payment_method_reference_id=6004835002&hash=0331521a-9ddb-44a2-851c-65f77d8d394e", "barcode_content": "3335008800000000006004835002100020000242462010", diff --git a/guides/checkout-api-orders/payment-integration-cards.es.md b/guides/checkout-api-orders/payment-integration-cards.es.md index 1ce687f731..9755a4d8d4 100644 --- a/guides/checkout-api-orders/payment-integration-cards.es.md +++ b/guides/checkout-api-orders/payment-integration-cards.es.md @@ -838,7 +838,7 @@ En caso de éxito, la respuesta se verá como el ejemplo a continuación. "status": "action_required", "status_detail": "waiting_payment", "payment_method": { - "id": "bolbradesco", + "id": "boleto", "type": "ticket", "ticket_url": "https://www.mercadopago.com.ar/payments/86797024510/ticket?caller_id=1870026883&payment_method_id=rapipago&payment_id=86797024510&payment_method_reference_id=6004835002&hash=0331521a-9ddb-44a2-851c-65f77d8d394e", "barcode_content": "3335008800000000006004835002100020000242462010", diff --git a/guides/checkout-api-orders/payment-integration-cards.pt.md b/guides/checkout-api-orders/payment-integration-cards.pt.md index 680f2752a0..c8bd600742 100644 --- a/guides/checkout-api-orders/payment-integration-cards.pt.md +++ b/guides/checkout-api-orders/payment-integration-cards.pt.md @@ -838,7 +838,7 @@ Em caso de sucesso, a resposta será semelhante ao exemplo abaixo. "status": "action_required", "status_detail": "waiting_payment", "payment_method": { - "id": "bolbradesco", + "id": "boleto", "type": "ticket", "ticket_url": "https://www.mercadopago.com.ar/payments/86797024510/ticket?caller_id=1870026883&payment_method_id=rapipago&payment_id=86797024510&payment_method_reference_id=6004835002&hash=0331521a-9ddb-44a2-851c-65f77d8d394e", "barcode_content": "3335008800000000006004835002100020000242462010", diff --git a/reference/api-json/orders.json b/reference/api-json/orders.json index b41b935283..9e6691068e 100644 --- a/reference/api-json/orders.json +++ b/reference/api-json/orders.json @@ -9,8 +9,8 @@ ], "description": { "en": "This endpoint allows to create Orders in \"automatic\" (processing the transaction in a single stage) or \"manual\" (processing the transaction in stages that can be configured and executed incrementally) mode for payment and cashout transactions. In case of success, the request will return a response with status 201", - "pt": "Este endpoint permite criar uma order no modo \"automático\" (processando a transação em uma única etapa) ou \"manual\" (processando a transação em etapas que podem ser configuradas e executadas de forma incremental) para transações de pagamento e cashout. Em caso de sucesso, a requisição retornará uma resposta com o status 201", - "es": "Este endpoint permite crear una order en modo \"automático\" (procesando la transacción en una sola etapa) o \"manual\" (procesando la transacción en etapas que pueden ser configuradas y ejecutadas de manera incremental) para transacciones de pago y cashout. En caso de éxito, la solicitud devolverá una respuesta con el estado 201" + "pt": "Este endpoint permite criar uma Order no modo \"automático\" (processando a transação em uma única etapa) ou \"manual\" (processando a transação em etapas que podem ser configuradas e executadas de forma incremental) para transações de pagamento e cashout. Em caso de sucesso, a requisição retornará uma resposta com o status 201", + "es": "Este endpoint permite crear una Order en modo \"automático\" (procesando la transacción en una sola etapa) o \"manual\" (procesando la transacción en etapas que pueden ser configuradas y ejecutadas de manera incremental) para transacciones de pago y cashout. En caso de éxito, la solicitud devolverá una respuesta con el estado 201" }, "parameters": [ { @@ -269,72 +269,72 @@ "type": "string", "example": "https://www.mercadopago.com.ar/payments/86797024510/ticket?caller_id=1870026883&payment_method_id=rapipago&payment_id=86797024510&payment_method_reference_id=6004835002&hash=0331521a-9ddb-44a2-851c-65f77d8d394e", "description": { - "en": "Ticket URL. It is returned for offline payment methods, such as Pix, Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", - "pt": "URL do ticket. É retornado para meios de pagamento offline, como Pix, Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", - "es": "URL del ticket. Se devuelve para medios de pago offline, como Pix, Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." + "en": "Ticket URL. It is returned for offline payment methods, such as Pix, Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", + "pt": "URL do ticket. É retornado para meios de pagamento offline, como Pix, Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", + "es": "URL del ticket. Se devuelve para medios de pago offline, como Pix, Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." } }, "barcode_content": { "type": "string", "example": "3335008800000000006004835002100020000242462010", "description": { - "en": "Barcode content. It is returned for offline payment methods, such as Rapipago, Pago fácil, Boleto, OXXO and Paycash.", - "pt": "Conteúdo do código de barras. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, Boleto, OXXO e Paycash.", - "es": "Contenido del código de barras. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, Boleto, OXXO y Paycash." + "en": "Barcode content. It is returned for offline payment methods, such as Rapipago, Pago fácil, boleto, OXXO and Paycash.", + "pt": "Conteúdo do código de barras. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, boleto, OXXO e Paycash.", + "es": "Contenido del código de barras. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, boleto, OXXO y Paycash." } }, "reference": { "type": "string", "example": "6005407530", "description": { - "en": "Reference number. It is returned for offline payment methods, such as Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", - "pt": "Número de referência. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", - "es": "Número de referencia. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." + "en": "Reference number. It is returned for offline payment methods, such as Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", + "pt": "Número de referência. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", + "es": "Número de referencia. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." } }, "verification_code": { "type": "string", "example": "6005407530", "description": { - "en": "Verification code. It is returned for offline payment methods, such as Rapipago, Pago fácil, Boleto, oxxo, paycash, Banamex and BBVA Bancomer.", - "pt": "Código de verificação. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, Boleto, oxxo, paycash, Banamex e BBVA Bancomer.", - "es": "Código de verificación. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, Boleto, oxxo, paycash, Banamex y BBVA Bancomer." + "en": "Verification code. It is returned for offline payment methods, such as Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex and BBVA Bancomer.", + "pt": "Código de verificação. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex e BBVA Bancomer.", + "es": "Código de verificación. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex y BBVA Bancomer." } }, "financial_institution": { "type": "string", "example": "bradesco", "description": { - "en": "Financial institution. It is returned for offline payment methods, such as Boleto, Banamex and BBVA Bancomer.", - "pt": "Instituição financeira. É retornado para meios de pagamento offline, como Boleto, Banamex e BBVA Bancomer.", - "es": "Institución financiera. Se devuelve para métodos de pago offline, como Boleto, Banamex y BBVA Bancomer." + "en": "Financial institution. It is returned for offline payment methods, such as boleto, Banamex and BBVA Bancomer.", + "pt": "Instituição financeira. É retornado para meios de pagamento offline, como boleto, Banamex e BBVA Bancomer.", + "es": "Institución financiera. Se devuelve para métodos de pago offline, como boleto, Banamex y BBVA Bancomer." } }, "digitable_line": { "type": "string", "example": "23793380296060054351030006333303799140000020000", "description": { - "en": "Digitable line. It is returned for the payment method 'Boleto'.", - "pt": "Linha digitável. É retornado para o meio de pagamento 'Boleto'.", - "es": "Línea digitable. Se devuelve para el medio de pago 'Boleto'." + "en": "Digitable line. It is returned for the payment method 'boleto'.", + "pt": "Linha digitável. É retornado para o meio de pagamento 'boleto'.", + "es": "Línea digitable. Se devuelve para el medio de pago 'boleto'." } }, "qr_code": { "type": "string", "example": "00020126580014br.gov.bcb.pix0136b76aa9c2-2ec4-4110-954e-ebfe34f05b61520400005303986540510.005802BR5912TESTPVBWOSBE6009Sao Paulo62240520mpqrinter715936942186304C3C0", "description": { - "en": "QR code. It is returned for offline payment method pix.", - "pt": "Código QR. É retornado para o meio de pagamento offline pix.", - "es": "Código QR. Se devuelve para el método de pago offline pix." + "en": "QR code. It is returned for offline payment method Pix.", + "pt": "Código QR. É retornado para o meio de pagamento Pix.", + "es": "Código QR. Se devuelve para el método de pago offline Pix." } }, "qr_code_base64": { "type": "string", "example": "iVBORw0KGgoAAAANSUhEUgAABWQAAAVkAQAAAAB79i", "description": { - "en": "QR code in base64. It is returned for offline payment method pix.", - "pt": "Código QR em base64. É retornado para o meio de pagamento offline pix.", - "es": "Código QR en base64. Se devuelve para el método de pago offline pix." + "en": "QR code in base64. It is returned for offline payment method Pix.", + "pt": "Código QR em base64. É retornado para o meio de pagamento offline Pix.", + "es": "Código QR en base64. Se devuelve para el método de pago offline Pix." } } } @@ -1020,7 +1020,7 @@ { "title": "boleto", "description": { - "en": "Boleto payment.", + "en": "boleto payment.", "es": "Pago con boleto.", "pt": "Pagamento com boleto." } @@ -1165,72 +1165,72 @@ "type": "string", "example": "https://www.mercadopago.com.ar/payments/86797024510/ticket?caller_id=1870026883&payment_method_id=rapipago&payment_id=86797024510&payment_method_reference_id=6004835002&hash=0331521a-9ddb-44a2-851c-65f77d8d394e", "description": { - "en": "Ticket URL. It is returned for offline payment methods, such as Pix, Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", - "pt": "URL do ticket. É retornado para meios de pagamento offline, como Pix, Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", - "es": "URL del ticket. Se devuelve para métodos de pago offline, como Pix, Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." + "en": "Ticket URL. It is returned for offline payment methods, such as Pix, Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", + "pt": "URL do ticket. É retornado para meios de pagamento offline, como Pix, Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", + "es": "URL del ticket. Se devuelve para métodos de pago offline, como Pix, Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." } }, "barcode_content": { "type": "string", "example": "3335008800000000006004835002100020000242462010", "description": { - "en": "Barcode content. It is returned for offline payment methods, such as Rapipago, Pago fácil, Boleto, OXXO and Paycash.", - "pt": "Conteúdo do código de barras. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, Boleto, OXXO e Paycash.", - "es": "Contenido del código de barras. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, Boleto, OXXO y Paycash." + "en": "Barcode content. It is returned for offline payment methods, such as Rapipago, Pago fácil, boleto, OXXO and Paycash.", + "pt": "Conteúdo do código de barras. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, boleto, OXXO e Paycash.", + "es": "Contenido del código de barras. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, boleto, OXXO y Paycash." } }, "reference": { "type": "string", "example": "6005407530", "description": { - "en": "Reference number. It is returned for offline payment methods, such as Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", - "pt": "Número de referência. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", - "es": "Número de referencia. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." + "en": "Reference number. It is returned for offline payment methods, such as Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer and Clabe.", + "pt": "Número de referência. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer e Clabe.", + "es": "Número de referencia. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex, BBVA Bancomer y Clabe." } }, "verification_code": { "type": "string", "example": "6005407530", "description": { - "en": "Verification code. It is returned for offline payment methods, such as Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex and BBVA Bancomer.", - "pt": "Código de verificação. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex e BBVA Bancomer.", - "es": "Código de verificación. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, Boleto, OXXO, Paycash, Banamex y BBVA Bancomer." + "en": "Verification code. It is returned for offline payment methods, such as Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex and BBVA Bancomer.", + "pt": "Código de verificação. É retornado para meios de pagamento offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex e BBVA Bancomer.", + "es": "Código de verificación. Se devuelve para métodos de pago offline, como Rapipago, Pago fácil, boleto, OXXO, Paycash, Banamex y BBVA Bancomer." } }, "financial_institution": { "type": "string", "example": "bradesco", "description": { - "en": "Financial institution. It is returned for offline payment methods, such as Boleto, Banamex and BBVA Bancomer.", - "pt": "Instituição financeira. É retornado para meios de pagamento offline, como Boleto, Banamex e BBVA Bancomer.", - "es": "Institución financiera. Se devuelve para medios de pago offline, como Boleto, Banamex y BBVA Bancomer." + "en": "Financial institution. It is returned for offline payment methods, such as boleto, Banamex and BBVA Bancomer.", + "pt": "Instituição financeira. É retornado para meios de pagamento offline, como boleto, Banamex e BBVA Bancomer.", + "es": "Institución financiera. Se devuelve para medios de pago offline, como boleto, Banamex y BBVA Bancomer." } }, "digitable_line": { "type": "string", "example": "23793380296060054351030006333303799140000020000", "description": { - "en": "Digitable line. It is returned for payment method 'Boleto bancário'.", - "pt": "Linha digitável. É retornado para o meio de pagamento 'Boleto bancário'.", - "es": "Línea digitable. Se devuelve para el medio de pago 'Boleto bancário'." + "en": "Digitable line. It is returned for payment method 'boleto'.", + "pt": "Linha digitável. É retornado para o meio de pagamento 'boleto'.", + "es": "Línea digitable. Se devuelve para el medio de pago 'boleto'." } }, "qr_code": { "type": "string", "example": "00020126580014br.gov.bcb.pix0136b76aa9c2-2ec4-4110-954e-ebfe34f05b61520400005303986540510.005802BR5912TESTPVBWOSBE6009Sao Paulo62240520mpqrinter715936942186304C3C0", "description": { - "en": "QR code. It is returned for offline payment method pix.", - "pt": "Código QR. É retornado para o meio de pagamento offline pix.", - "es": "Código QR. Se devuelve para el método de pago offline pix." + "en": "QR code. It is returned for offline payment method Pix.", + "pt": "Código QR. É retornado para o meio de pagamento offline Pix.", + "es": "Código QR. Se devuelve para el método de pago offline Pix." } }, "qr_code_base64": { "type": "string", "example": "iVBORw0KGgoAAAANSUhEUgAABWQAAAVkAQAAAAB79i", "description": { - "en": "QR code in base64. It is returned for offline payment method pix.", - "pt": "Código QR em base64. É retornado para o meio de pagamento offline pix.", - "es": "Código QR en base64. Se devuelve para el método de pago offline pix." + "en": "QR code in base64. It is returned for offline payment method Pix.", + "pt": "Código QR em base64. É retornado para o meio de pagamento offline Pix.", + "es": "Código QR en base64. Se devuelve para el método de pago offline Pix." } } } @@ -2378,9 +2378,9 @@ "checkout-api-manual" ], "description": { - "en": "Performs the processing of an order and its transactions using the reference ID obtained in the response to its creation. In case of success, the request will return a response with status 200", - "pt": "Este endpoint permite executar o processamento de uma order e suas transações utilizando o ID de referência obtido na resposta à sua criação. Em caso de sucesso, a requisição retornará uma resposta com o status 200", - "es": "Realiza el procesamiento de una order y sus transacciones asociadas utilizando el ID de referencia obtenido en la respuesta a su creación. En caso de éxito, la solicitud devolverá una respuesta con el estado 200" + "en": "Performs the processing of an order and its transactions using the reference ID obtained in the response to its creation. In case of success, the request will return a response with status 200.", + "pt": "Este endpoint permite executar o processamento de uma order e suas transações utilizando o ID de referência obtido na resposta à sua criação. Em caso de sucesso, a requisição retornará uma resposta com o status 200.", + "es": "Realiza el procesamiento de una order y sus transacciones asociadas utilizando el ID de referencia obtenido en la respuesta a su creación. En caso de éxito, la solicitud devolverá una respuesta con el estado 200." }, "parameters": [ { @@ -3313,9 +3313,9 @@ "date_of_expiration": { "type": "string", "description": { - "en": "Date and time of the expiration of the payment. It is returned in the response to the Create order request. In the case of offline payment methods, such as Boleto, Pix, Pago Fácil, or OXXO, if an expiration_time is not sent, this field adopts a default value that depends on the payment method.", - "pt": "Data de expiração do pagamento. É retornado na resposta à requisição Criar order. No caso de meios de pagamento offline, como Boleto, Pix, Pago Fácil ou OXXO, caso não seja enviado um expiration_time, ele adota um valor padrão que depende do meio de pagamento.", - "es": "Fecha y hora de vencimiento del pago. Se devuelve en la respuesta a la solicitud Crear order. En el caso de medios de pago offline, como Boleto, Pix, Pago Fácil u OXXO, si no es enviado un expiration_time, adopta un valor por defecto que dependerá del medio de pago." + "en": "Date and time of the expiration of the payment. It is returned in the response to the Create order request. In the case of offline payment methods, such as boleto, Pix, Pago Fácil, or OXXO, if an expiration_time is not sent, this field adopts a default value that depends on the payment method.", + "pt": "Data de expiração do pagamento. É retornado na resposta à requisição Criar order. No caso de meios de pagamento offline, como boleto, Pix, Pago Fácil ou OXXO, caso não seja enviado um expiration_time, ele adota um valor padrão que depende do meio de pagamento.", + "es": "Fecha y hora de vencimiento del pago. Se devuelve en la respuesta a la solicitud Crear order. En el caso de medios de pago offline, como boleto, Pix, Pago Fácil u OXXO, si no es enviado un expiration_time, adopta un valor por defecto que dependerá del medio de pago." }, "example": "2023-03-01T10:00:00.000-04:00" }, @@ -3524,7 +3524,7 @@ { "title": "boleto", "description": { - "en": "Boleto payment.", + "en": "boleto payment.", "es": "Pago con boleto.", "pt": "Pagamento com boleto." } @@ -3828,8 +3828,8 @@ "example": "Pres. Altino", "description": { "en": "Payer's address neighborhood. Required for \"payment_method.id\" boleto", - "pt": "Bairro do endereço do pagador. Obrigatório para \"payment_method.id\" boleto", - "es": "Barrio de la dirección del pagador. Requerido para \"payment_method.id\" boleto" + "pt": "Bairro do endereço do pagador. Obrigatório para \"payment_method.id\" boleto.", + "es": "Barrio de la dirección del pagador. Requerido para \"payment_method.id\" boleto." } }, "state": { @@ -3846,8 +3846,8 @@ "example":"Osasco", "description": { "en": "Payer's address city. Required for \"payment_method.id\" boleto", - "pt": "Cidade do endereço do pagador. Obrigatório para \"payment_method.id\" boleto", - "es": "Ciudad de la dirección del pagador. Requerido para \"payment_method.id\" boleto" + "pt": "Cidade do endereço do pagador. Obrigatório para \"payment_method.id\" boleto.", + "es": "Ciudad de la dirección del pagador. Requerido para \"payment_method.id\" boleto." } }, "complement": { @@ -4212,8 +4212,8 @@ "title": "waiting_capture", "description": { "en": "In cases of 'status=action_required', integrator action is required to complete processing. This \"status_detail\" indicates that the capture of an authorized payment is needed.", - "es": "En los casos de status=action_required, es necesaria una acción del integrador para completar el procesamiento. Este \"status_detail\" indica que se aguarda la captura de un pago autorizado.", - "pt": "Em casos de status=action_required, a ação do integrador é necessária para concluir o processamento. Este \"status_detail\" indica que está aguardando a captura de um pagamento autorizado." + "es": "En los casos de 'status=action_required', es necesaria una acción del integrador para completar el procesamiento. Este \"status_detail\" indica que se aguarda la captura de un pago autorizado.", + "pt": "Em casos de 'status=action_required', a ação do integrador é necessária para concluir o processamento. Este \"status_detail\" indica que está aguardando a captura de um pagamento autorizado." } }, { @@ -4290,8 +4290,8 @@ "title": "waiting_capture", "description": { "en": "In cases of 'status=action_required', integrator action is required to complete processing. This \"status_detail\" indicates that the capture of an authorized payment is needed.", - "es": "En los casos de status=action_required, es necesaria una acción del integrador para completar el procesamiento. Este \"status_detail\" indica que se aguarda la captura de un pago autorizado.", - "pt": "Em casos de status=action_required, a ação do integrador é necessária para concluir o processamento. Este \"status_detail\" indica que está aguardando a captura de um pagamento autorizado." + "es": "En los casos de 'status=action_required', es necesaria una acción del integrador para completar el procesamiento. Este \"status_detail\" indica que se aguarda la captura de un pago autorizado.", + "pt": "Em casos de 'status=action_required', a ação do integrador é necessária para concluir o processamento. Este \"status_detail\" indica que está aguardando a captura de um pagamento autorizado." } }, { @@ -5405,9 +5405,9 @@ { "title": "cannot_cancel_order", "description": { - "en": "The status of the order does not allow its cancelation. Only Orders with status 'action_required' or 'created' can be canceled.", - "es": "El estado en el que se encuentra la order no permite su cancelación. Solo pueden ser canceladas Orders con status 'action_required' o 'created'.", - "pt": "O status da order não permite o seu cancelamento. Apenas Orders com status 'action_required' ou 'created' podem ser canceladas." + "en": "The status of the order does not allow its cancelation. Only orders with \"status\" 'action_required' or 'created' can be canceled.", + "es": "El estado en el que se encuentra la order no permite su cancelación. Solo pueden ser canceladas orders con \"status\" 'action_required' o 'created'.", + "pt": "O status da order não permite o seu cancelamento. Apenas orders com \"status\" 'action_required' ou 'created' podem ser canceladas." } } ] @@ -5463,9 +5463,9 @@ { "title": "cannot_refund_order", "description": { - "en": "Error. Order cannot be refunded. The status of the order does not allow its refund. Only Orders with status 'processed' can be refunded.", - "pt": "Erro. Order não pode ser reembolsada. O status da order não permite o reembolso. Apenas Orders com status 'processed' podem ser reembolsadas.", - "es": "Error. Order no puede ser reembolsada. El estado de la order no permite su reembolso. Solo pueden ser reembolsadas Orders con status 'processed'." + "en": "Error. Order cannot be refunded. The status of the order does not allow its refund. Only Orders with \"status\" 'processed' can be refunded.", + "pt": "Erro. Order não pode ser reembolsada. O status da order não permite o reembolso. Apenas Orders com \"status\" 'processed' podem ser reembolsadas.", + "es": "Error. Order no puede ser reembolsada. El estado de la order no permite su reembolso. Solo pueden ser reembolsadas Orders con \"status\" 'processed'." } } ] @@ -5550,9 +5550,9 @@ { "title": "operation_not_supported", "description": { - "en": "The operation is not supported for this order. Please check the order type and status and try again.", - "es": "La operación no es soportada para esta order. Comprueba el type y status de la order e intenta nuevamente.", - "pt": "A operação não é suportada para esta order. Verifique o type e status da order e tente novamente." + "en": "The operation is not supported for this order. Please check the order \"status\" and \"status\" and try again.", + "es": "La operación no es soportada para esta order. Comprueba el \"status\" y \"status\" de la order e intenta nuevamente.", + "pt": "A operação não é suportada para esta order. Verifique o \"status\" e \"status\" da order e tente novamente." } } ] diff --git a/reference/api-json/user-cases/order_user_case_oxxo.json b/reference/api-json/user-cases/order_user_case_oxxo.json index 7b1fa83da2..27b1d12313 100644 --- a/reference/api-json/user-cases/order_user_case_oxxo.json +++ b/reference/api-json/user-cases/order_user_case_oxxo.json @@ -130,7 +130,7 @@ "example": "waiting_payment" }, "capture_mode": { - "example": "automatic" + "example": "automatic_async" }, "created_date": { "example": "2025-04-25T13:51:07.942Z"