Skip to content

Commit

Permalink
Merge pull request #691 from mercadopago/fix/api-docs-fixes
Browse files Browse the repository at this point in the history
Ajustes documentación API | Fix de contenidos y espacios
  • Loading branch information
pabal1708 authored Apr 29, 2020
2 parents a6b50a8 + a60ef36 commit 4af1048
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 27 deletions.
8 changes: 4 additions & 4 deletions guides/payments/api/advanced-integration.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Remember your customers and cards

Use our APIs to save your customer's card references and offer them a better experience. This way, your customers won't need to fill out their data all the times and their payments will be completed faster.
Use our APIs to save your customer's card references and offer them a better experience. This way, your customers won't need to fill out their data every time and their payments will be completed faster.

###       Create customers and cards

Expand Down Expand Up @@ -293,7 +293,7 @@ curl -X POST \

###       Use saved cards for payments

For customers to make payments with their saved data, you need to capture the security code again. For security reasons, Mercado Pago cannot save that information.
For customers to make payments with their saved data, you need to capture the security code again. For security reasons, Mercado Pago can't save that information.

<br>

Expand Down Expand Up @@ -387,7 +387,7 @@ And you can prepare the form like this:

#### &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;2. Capture security code

The customer needs to enter the security code in a flow like that for [card data capture](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/payments/api/receiving-payment-by-card/#bookmark_card_data_capture). You need to create a token by submitting the form with card ID and security code.
The customer needs to enter the security code in a flow similar to [card data capture](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/payments/api/receiving-payment-by-card/#bookmark_card_data_capture). You need to create a token by submitting the form with card ID and security code.

```javascript
doSubmit = false;
Expand Down Expand Up @@ -671,7 +671,7 @@ curl -X GET \

## Cancellations and refunds

Cancellations occur when a cash payment is not completed before the expiration date, and the seller decides to cancel it. And refunds occur when the payment is made, but the seller decides to cancel it, in whole or in part.
Cancellations occur when a cash payment is not completed before the expiration date, and the seller decides to cancel it. And refunds occur when the payment is made, but the seller decides to cancel it, partially or entirely.

For more information, check the [Refunds and Cancellations section](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/manage-account/cancellations-and-refunds/).

Expand Down
12 changes: 6 additions & 6 deletions guides/payments/api/goto-production.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ Once your integration is ready, to start receiving payments you just need to fil

This process can ensure your customers' data security, compliance with legal standards or the provisions in each country, and the best shopping experience for your sales.

[Learn about Mercado Pago terms and conditions](https://www.mercadopago[FAKER][URL][DOMAIN]/ayuda/terminos-y-condiciones_299).
[Learn about Mercado Pago's terms and conditions](https://www.mercadopago[FAKER][URL][DOMAIN]/ayuda/terminos-y-condiciones_299).

## Use the official libraries and ensure data security

On the one hand, you need to use MercadoPago.js library, as provided by Mercado Pago. You cannot change or host it in your servers. And, on the other, you need to make sure not to put the `name` attribute when creating a card data form. This way your servers will never store data when the customer sends the form.
On one hand, you need to use MercadoPago.js library, as provided by Mercado Pago. You can't change or host it on your servers. And, on the other, you need to make sure not to put the `name` attribute when creating a card data form. This way your servers will never store data when the customer sends the form.

These measures protect your customer's sensitive data, meet the required security standards, and keep yourself up to date.
These measures protect your customer's sensitive data, meet the required security standards, and keep yours up to date.

## Don't forget to get an SSL certificate

To ensure security and data protection, you need to have a valid SSL certificate and make the payment form available on an HTTPS page. This protects buyers' transactions and data. You may not have it for tests, but it is mandatory for the production environment.
To ensure security and data protection, you need to have a valid SSL certificate and make the payment form available on an HTTPS page. This protects buyers' transactions and data. You may not have it while running tests, but it is mandatory for the production environment.

## Be transparent with promotions and financing

You need to make clear that promotions are offered by Mercado Pago. You can [include a payment method banner](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/banners/introduction/) or [add a link to the promotions section](https://www.mercadopago.com/mla/credit_card_promos.htm). Besides, you need to inform [financing costs applicable to your customers](https://www.mercadopago[FAKER][URL][DOMAIN]/ayuda/costos-financiacion_621).
You need to be clear about which promotions are offered by Mercado Pago. You can [include a payment method banner](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/banners/introduction/) or [add a link to the promotions section](https://www.mercadopago.com/mla/credit_card_promos.htm). Besides, you need to inform [financing costs applicable to your customers](https://www.mercadopago[FAKER][URL][DOMAIN]/ayuda/costos-financiacion_621).

----[mla]----
> NOTE
Expand Down Expand Up @@ -51,4 +51,4 @@ You need to have a policy on terms and conditions and make it clear that you are
>
> Find all the information required to interact with our APIs.
>
> [API References](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/reference/)
> [API References](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/reference/)
2 changes: 1 addition & 1 deletion guides/payments/api/handling-responses.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Offer your customers clear and accurate information about possible card data entry or payment status errors. This way they are notified of the resolution actions they can take, or any additional step required.

For example, if the card has no sufficient buyer credit balance, you can suggest trying again with another payment method to complete the transaction.
For example, if the card has insufficient balance, you can suggest trying again with another payment method to complete the transaction.


## Collection creation results
Expand Down
10 changes: 5 additions & 5 deletions guides/payments/api/other-features.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Add specific features to your integration based on your business needs.

Offer the possibility of granting an authorization before payment capture. This allows you to make a fund reserve in your buyer's card without making a payment.

For example, to grant an authorization when you reserve a car, or for an estimated purchase price prior confirmation.
For example, to grant an authorization when you reserve a car, or for an estimated purchase price prior to confirmation.


## Make a fund reserve
## Reserve Funds

For fund reserve authorization, you just need to add the `capture=false` attribute like this:

Expand Down Expand Up @@ -137,11 +137,11 @@ It can be rejected or remain pending. Take into account that authorized funds ca
## Capture an authorized payment

To complete the payment, you need to capture the funds reserved for your customer. You can capture the amount, in whole or in part.
To complete the payment, you need to capture the funds reserved for your customer. You can capture the amount, entirely or partially.

### &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Capture the whole reserve amount
### &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Capture the entire amount

To capture the whole amount, you just need to submit the `capture` attribute as `true`.
To capture the full amount, you just need to submit the `capture` attribute as `true`.

[[[
```php
Expand Down
8 changes: 3 additions & 5 deletions guides/payments/api/receiving-payment-by-card.en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Integrate the payment API for cards

Mercado Pago integration by payment API for cards helps you offer all types of payment methods on your website. The entire experience takes place in your store, so customers avoid exiting your site while making a purchase.
Integrating Mercado Pago's payment API for cards allows you to offer a complete payment option within the site. The entire experience takes place in your store, so customers avoid exiting your site while making a purchase.

## How does it work?

Expand Down Expand Up @@ -193,8 +193,6 @@ function getInstallments(){
------------

<br>

### &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;5. Create card token

Before payment submission, you should create a token containing all card information securely. You should generate it as follows:
Expand Down Expand Up @@ -259,9 +257,9 @@ To continue with the Mercado Pago payment process, your backend should know how

In the above example, after the `submit` action, your backend should display a `/process_payment` endpoint, which is defined in the form `action` attribute, to receive all data.

Once the request –with all the collected information– is in your backend, it should be submitted to Mercado Pago through our APIs. The minimum mandatory fields to submit are: `token`,`transaction_amount`, `installments`, `payment_method_id` and `payer.email`.
Once the request –with all the collected information– is in your backend, it should be submitted to Mercado Pago through our APIs. The minimum mandatory fields to submit are: `token`, `transaction_amount`, `installments`, `payment_method_id` and `payer.email`.

For this to work, you should configure your [private key]([FAKER][CREDENTIALS][URL]). Also, to interact with our APIs, you should use [Mercado Pago official SDK](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/payments/api/previous-requirements/#bookmark_install_Mercado_Pago_SDK).
For this to work, you should configure your [private key]([FAKER][CREDENTIALS][URL]). Also, to interact with our APIs, you should use [Mercado Pago official SDK](https://www.mercadopago[FAKER][URL][DOMAIN]/developers/en/guides/payments/api/previous-requirements/#bookmark_install_mercado_pago_sdk).

[[[
```php
Expand Down
2 changes: 0 additions & 2 deletions guides/payments/api/receiving-payment-by-card.es.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,6 @@ function getInstallments(){
------------

<br>

### &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;5. Crea el token de la tarjeta

Antes de enviar el pago, debes crear el token que contendrá de manera segura toda la información de la tarjeta. Lo debes generar de la siguiente manera:
Expand Down
8 changes: 4 additions & 4 deletions guides/payments/api/testing.en.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Test your Integration
# Test your integration

We will explain how to use our test cards and users to check that your payments are correctly created and your messages are effective.

Expand Down Expand Up @@ -49,10 +49,10 @@ curl -X POST \
>Importante
>
> * Both buyer and seller must be test users.
> * You can generate up to 10 concurrent test user accounts. Therefore, we recommend you save each _email_ and _password_.
> * You can generate up to 10 simultaneous test user accounts. Therefore, we recommend you save each _email_ and _password_.
> * Test users expire after 60 days without activity in Mercado Pago.
> * To make test payments we recommend using low amounts.
> * Amounts should observe the ----[mla]---- [minimum and maximum values](https://www.mercadopago/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlm]---- [minimum and maximum values](https://www.mercadopago.com.mx/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlu]---- [minimum and maximum values](https://www.mercadopago.com.uy/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mco]---- [minimum and maximum values](https://www.mercadopago.com.uy/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mpe]---- [minimum and maximum values](https://www.mercadopago.com.pe/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlc]---- [minimum and maximum values](https://www.mercadopago.cl/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlb]---- [minimum and maximum values](https://www.mercadopago.com.br/ajuda/minimo-maximo-posso-pagar_324) ------------ for each payment method.
> * Amounts should be within the ----[mla]---- [minimum and maximum values](https://www.mercadopago/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlm]---- [minimum and maximum values](https://www.mercadopago.com.mx/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlu]---- [minimum and maximum values](https://www.mercadopago.com.uy/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mco]---- [minimum and maximum values](https://www.mercadopago.com.uy/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mpe]---- [minimum and maximum values](https://www.mercadopago.com.pe/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlc]---- [minimum and maximum values](https://www.mercadopago.cl/ayuda/monto-minimo-maximo-medios-de-pago_620) ------------ ----[mlb]---- [minimum and maximum values](https://www.mercadopago.com.br/ajuda/minimo-maximo-posso-pagar_324) ------------ for each payment method.
## Test the payment flow

Expand Down Expand Up @@ -93,7 +93,7 @@ To **test different payment results,** complete the information you want in the
>
> Important
>
> Take into account that you cannot test the entire flow for cash payment methods.
> Consider that you can't test the entire flow for cash payment methods.
## Start receiving payments

Expand Down

0 comments on commit 4af1048

Please sign in to comment.