Create a Payin

It allows you to create a Payin. Confirmation about payin status will come via callback to the URL specified by merchant during authorization phase.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
How to test in Chile?
  1. Create a session by sending a request: Below are the required parameters, and on the right, you can dynamically see how the request looks. Additionally, you need to enter the authentication token. Make sure the country matches the selected currency. After that, you can proceed to click on Try It!
📘

How to enable bank buttons

To enable this flow, just set the “bank” parameter with the desired bank.

Set one bank alongside its respective logo, and then replicate the same setup with different bank parameters. You have the flexibility to include all desired banks or a selection. To ensure customers have access to the full range of banks, incorporate a separate button featuring Cleo's logo without utilizing the 'bank' parameter.

See the example for the Chilean market

  1. Receiving the callback: As a response, if the request was successful, you will receive a response like the following:
{
"status": "PENDING",
"url":"[https://transfer.staging.cleo.cl/fintoc-widget?session_id=bb215e25-909b-4c09-bfd3-6f1f](https://transfer.staging.cleo.cl/fintoc-widget?session_id=bb215e25-909b-4c09-bfd3-6f1f)",
"sessionId": "bb215e25-909b-4c09-bfd3-6f1f29b657bb"
}
  1. Entering the test session: Copy the received URL and paste it into your browser. You’ll be redirected to the user’s flow:

    3.1. Choose any of these 3 banks: Banco Estado / Banco de Chile / Banco BCI
    Use RUT 11111111-1 and this password: 1234

    3.2. Click on "Continuar"

    3.3. Click on "Continuar"

    3.4. If you see a message "Ingresa los valores de tu tarjeta de coordenadas", use this
    combination: 12 34 56

  2. Done: After following these steps, the transaction will be a SUCCESS.

How to test in Peru?
  1. Create a session by sending a request: Below are the required parameters, and on the right, you can dynamically see how the request looks. Additionally, you need to enter the authentication token. Make sure the country matches the selected currency. After that, you can proceed to click on Try It!
📘

Remember

To test in Peru, you should use the following data:

  • customerDocumentId: 12345678
  • customerDocumentType: dni
  1. Receiving the callback: As a response, if the request was successful, you will receive a response like the following:
{
"status": "PENDING",
"url": "[https://cleopagos.com?id=e5b45ad4-a47c-4278-81a7-4d2483dc8593](https://cleopagos.com?id=e5b45ad4-a47c-4278-81a7-4d2483dc8593)",
"sessionId": "3c3cac16-1fb9-4a85-b798-d70224983679"
}
  1. Entering the test session: Copy the received URL and paste it into your browser. You’ll be redirected to the user’s flow:

  2. Done: After following these steps, the transaction will be a SUCCESS.

How to test in Mexico?
  1. Create a session by sending a request: Below are the required parameters, and on the right, you can dynamically see how the request looks. Additionally, you need to enter the authentication token. Make sure the country matches the selected currency. After that, you can proceed to click on Try It!
  2. Receiving the callback: As a response, if the request was successful, you will receive a response like the following:
{
"status": "PENDING",
"url":"[https://qt-sandbox.etpay.com/session/MG4PV5VOeIpaR9yryTeT9SGuH5pUkb3zXSTFaBR2Ukkn7pF3zdcwxdELjzwzUv3S](https://qt-sandbox.etpay.com/session/MG4PV5VOeIpaR9yryTeT9SGuH5pUkb3zXSTFaBR2Ukkn7pF3zdcwxdELjzwzUv3S)",
"sessionId": "c1f42966-2584-4eb3-8f89-b567ce425a52"
}
  1. Entering the test session: Copy the received URL and paste it into your browser. You’ll be redirected to the following site:
ETP1
Redirection site
  1. Make the test payment: Complete the field with the following email: [email protected] and click on ‘Continuar’. You will see the following screen:
ETP2
Payment data
  1. Done: After following these steps, wait a few minutes and the transaction will be a SUCCESS. You will see this screen:
ETP3
Payment confirmation
Body Params
string
enum
required

Country for payin payment

Allowed:
string

Customer phone, format depends on selected country

string

Customer email

number
required

Deposit amount, minimum amount depends on selected country

string
enum
required

Currency, depends on selected country

Allowed:
string
required

URL where customer will be redirected if payin is not successful

string
required

URL where customer will be redirected if payin is successful

string
required

URL where a callback will be sent to when status changes

string

External key provided by the merchant, can be used to identify the payin session

string
required

Customer external key

string

Customer document id, depends on selected country

string
enum

Customer document type. CL: RUT, MX: RFC or CURP, PE: DNI

Allowed:
string

Comment for payin payment

string
Customer bank, depends on selected country
    <details><summary>CL</summary>santander, scotiabank, estado, bci, falabella, bancodechile, itau, ripley, bice, test_bank</details>
    <details><summary>PE</summary>bcp, interbank, scotia, bbva, pichincha, falabella, alfin, caja_piura, caja_arequipa, caja_huancayo</details>
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json