# MD for: https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/payment-integration/spei-transfers.md \# SPEI Transfers With Mercado Pago's Checkout API, it is also possible to offer payments via SPEI Transfers, a service that allows payments to be made from any bank or financial institution using the CLABE (\_Clave Bancaria Estandarizada\_). If you already \[set up your environment\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/development-environment) and want to offer payments with SPEI Transfer, follow the steps below. > NOTE > > Remember: before setting up the payment methods, choose the way you will process your transactions. The processing mode, whether \*\*manual or automatic\*\*, will be defined at the time of order creation, using the \`processing\_mode\` parameter. For more information, visit the section \[Integration model\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/integration-model). :::AccordionComponent{title="Add payment form" pill="client-side"} To be able to receive payments, you need to add a form in the frontend that securely captures the payer's information. If you already have a development that includes your own payment form, make sure to include SPEI Transfer among the payment options you want to offer, as indicated below, and continue to the \[Submit payment step\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/payment-integration/spei-transfers#:\~:text=server%2Dside-,Submit,-payment). If you do not have a payment form, add the one below to your project, including the identifier for SPEI Transfer among the payment methods to be offered. | Payment method | \`payment\_method\_id\`| |:---:|:---:| | SPEI Transfer | \`clabe\` | \`\`\`html Nombre Appelido E-mail Tipo de documento Número del documento Pagar \`\`\` ::: :::AccordionComponent{title="Submit payment" pill="server-side"} The payment submission must be made by creating an order that contains associated payment transactions. > NOTE > > The creation of a payment can occur asynchronously in an order. In this scenario, the order remains in a processing state and without information. We recommend setting up \[Order topic notifications\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/notifications) to receive updates on the status change, including the updated order data. Alternatively, you can choose to send a \*\*GET\*\* request to the \[/v1/orders/{id}\](https://www.mercadopago.com.mx/developers/en/reference/online-payments/checkout-api/get-order/get) endpoint to retrieve that updated information. To do this, send a \*\*POST\*\* with your :toolTipComponent\[test Access Token\]{content="Private key of the application created in Mercado Pago, that must be used in the backend. You can access it through \*Your integrations > Integration data > Tests > Test credentials\*. The test Access Token starts with the prefix \`APP\_USR\`."} and the required parameters listed below to the endpoint :TagComponent{tag="API" text="/v1/orders" href="/developers/en/reference/online-payments/checkout-api/create-order/post"} and execute the request. \`\`\`curl curl --location 'https://api.mercadopago.com/v1/orders' \\ --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer ' \\ --header 'X-Idempotency-Key: ' \\ { "type": "online", "external\_reference": "ext\_ref\_1234", "processing\_mode": "automatic", "total\_amount": "50.00", "expiration\_time": "P3D", "payer": { "email": "test\_user\_mx@testuser.com", }, "transactions": { "payments": \[ { "amount": "50.00", "payment\_method": { "id": "clabe", "type": "bank\_transfer" } } \] } } \`\`\` See the table below for descriptions of the parameters that are mandatory in the request and those that, although optional, have some important particularity that should be highlighted. | Atribute | Type | Description | Requirement | |---------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| | \`Authorization\` | \_Header\_ | Refers to your private key, the :toolTipComponent\[test Access Token\]{content="Private key of the application created in Mercado Pago, that must be used in the backends. You can access it through \*Your integrations > Integration data > Tests > Test credentials\*. The test Access Token starts with the prefix \`APP\_USR\`."}. | Required | | \`X-Idempotency-Key\` | \_Header\_ | Idempotency key. It is used to ensure that each request is processed only once, avoiding duplications. Use a unique value in the header of your request, such as a UUID V4 or random strings. | Required | | \`processing\_mode\` | \_Body. String\_ | Processing mode of the order. The possible values are: \- \`automatic\`: to create and process the order in automatic mode. \- \`manual\`: to create the order and process it later. For more information, visit the section \[Integration model\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/integration-model). | Required | | \`total\_amount\` | \_Body. String\_ | Total amount for the transaction. | Required | | \`expiration\_time\` | \_Body. String\_ | Allows you to set the due date using the ISO 8601 duration format. While you can configure it to be between 1 and 30 days after the payment is issued, we recommend setting a duration of 3 days ("P3D" in the example) to avoid conflicts between the expiration date and the payment crediting, which can take up to 2 business hours from its completion. In case the payment is made after the established expiration date, the amount will be refunded to the payer's Mercado Pago account. | Optional | | \`payer.email\` | \_Body. String\_ | Buyer’s e-mail. | Required | | \`transaction.payments.payment\_method.id\` | \_Body. String\_ | Identifier of the payment method. In this case, the value should be \`clabe\`. | Required | | \`transaction.payments.payment\_method.type\` | \_Body. String\_ | Type of the payment method. In the case of payments with a slip, the value should be \`bank\_transfer\`. | Required | > SUCCESS\_MESSAGE > > To learn in detail about all the parameters sent and returned in this request, please refer to our \[API Reference\](https://www.mercadopago.com.mx/developers/en/reference/online-payments/checkout-api/create-order/post). Additionally, if you receive an error when submitting the payment, you can consult our \[list of errors\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/payment-management/integration-errors). The response will return the parameter \`ticket\_url\`, which contains the URL with instructions for the buyer to make the payment. You should redirect them to it following the instructions in the \[Make the payment available\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/payment-integration/spei-transfers#:\~:text=client%2Dside-,Make,-the%20payment%20available) step. Additionally, it will show the status \`action\_required\` with \`status\_detail=waiting\_transfer\` until the payment is completed. \`\`\`json { "id": "ORD01J6TC8BYRR0T4ZKY0QR39WGYE", "type": "online", "processing\_mode": "automatic", "external\_reference": "ext\_ref\_1234", "marketplace": "NONE", "total\_amount": "50.00", "country\_code": "MEX", "user\_id": "1245621468", "status": "action\_required", "status\_detail": "waiting\_payment", "capture\_mode": "automatic", "created\_date": "2024-09-02T22:04:01.880469Z", "last\_updated\_date": "2024-09-02T22:04:04.429289Z", "integration\_data": { "application\_id": "4599991948843755" }, "transactions": { "payments": \[ { "id": "PAY01J6TC8BYRR0T4ZKY0QRTZ0E24", "amount": "50.00", "reference\_id": "22dvqmsbq8c", "status": "action\_required", "status\_detail": "waiting\_payment", "payment\_method": { "id": "clabe", "type": "bank\_transfer", "ticket\_url": "https://www.mercadopago.com.mx/sandbox/payments/00000000000/ticket?caller\_id=77777777777&hash=34cb0d7c-81d9-478c-92a5-767d0kakjja", "reference": "1234567890" } } \] } } \`\`\` Among the returned parameters, the ones indicated in the table below stand out. | Attribute | Type | Description | |---|---|---| | \`transactions.payments.status\` | \_String\_ | Returns the status of the transaction. In this case, it will return \`action\_required\` to indicate that an action is required to complete the processing, that is, until the payment is made. | | \`transactions.payments.status\_detail\` | \_String\_ | In cases of bank transfer, as is the case with SPEI Transfers, the \`status\_detail\` obtained is pending (\`waiting\_payment\`) for the user to complete the payment process at their bank. | | \`transactions.payments.payment\_method.ticket\_url\` | \_String\_ | URL to the page with payment instructions via SPEI Transfer. See more information in \[Make the payment available\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-orders/payment-integration/spei-transfers#bookmark\_make\_the\_payment\_available). | | \`transactions.payments.payment\_method.reference\` | \_String\_ | CLABE reference number for the buyer to make the bank transfer. | > WARNING > > If you have created the order in manual mode, remember that processing the payment requires an additional step, which is calling the :TagComponent{tag="API" text="Process order" href="/developers/en/reference/online-payments/checkout-api/process-order/post"}. ::: :::AccordionComponent{title="Make the payment available" pill="client-side"} After the payment is created, and for the client to be able to make the transfer, it is necessary to redirect them to the URL returned in the response to the order creation under the parameter \`ticket\_url\`. \`\`\`json { \[...\] "transactions": { "payments": \[ { \[...\] "payment\_method": { "id": "clabe", "type": "bank\_transfer", "ticket\_url": "https://www.mercadopago.com.mx/payments/113775986440/ticket?caller\_id=1872745950&hash=9545e05b-a530-4c82-9441-a666d0c73f70", "reference": "646010349353743569" } } \] } } \`\`\` To do this, you have two options: - You can automatically redirect the user. - You can provide that URL to the user through a clickable button, following the example below. \`\`\`html [Pagar com Transferências SPEI](https://www.mercadopago.com.mx/payments/51096146182/ticket?caller%5Fid=34728475&hash=f3a8630a-f06a-48e4-b2a6-f95750af7346)\`\`\` ::: :::AccordionComponent{title="Cancel payment" pill="server-side"} If you wish, you can cancel a payment created, as long as it is pending or in process; that is, with \`status=action\_required\`. Additionally, we recommend canceling payments that were not made by the established due date to avoid billing and reconciliation issues. > WARNING > > If 30 days pass after the established due date for a payment and it has not been made, Mercado Pago will consider it expired. In these cases, it is not possible to perform a manual cancellation, and the payment status will change to canceled or expired. For more information, please consult the \[Refunds and cancellations\](https://www.mercadopago.com.mx/developers/en/docs/checkout-api-payments/payment-management/refunds-cancellations) section. :::