Realiza tu primera transaccion

Inicio rápido

Para comenzar con una integración rápida, recomendamos el uso de nuestro Checkout, el cual te permitirá realizar un pago de prueba sin invertir mucho tiempo.

Flujo del proceso de pago

1. El cliente llega a la página de pago de sitio o plataforma.

2. Relizas una petición del lado del servidor para crear un checkout de OrkestaPay

3. Redireccionas al cliente la URL que se te va a proporcionar (checkout_redirect_url)

4. El cliente visualiza un resumen de su pedido, así como las diferentes opciones de pago

5. Cuando el cliente realice el pago y éste sea exitoso, será redireccionado a una página web que nos debiste de indicar en el paso 2.

6. Puedes realizar una consulta a nuestra API para verificar el estatus de la orden y aplicar tu lógica de negocio.

Antes de empezar

Para continuar con esta guía de inicio rápido, debes contar con tus llaves del API y autenticarte para poder consumir los servicios del API.

Paso 1: Crear un nuevo checkout

Cuando el cliente este listo para pagar, debes de enviar la petición del lado del servidor para crear un nuevo checkout. La respuesta del servicio de creación de checkout, devolverá una URL (checkout_redirect_url) para redireccionar al cliente a una página de pago de OrkestaPay.

Ejemplo de petición al servicio

curl --request POST \
     --url https://api.sand.orkestapay.com/v1/checkouts \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer REPLACE_WITH_YOUR_ACCESS_TOKEN' \
     --data '
{
    "completed_redirect_url": "REPLACE_WITH_YOUR_SUCCESS_URL",
    "canceled_redirect_url": "REPLACE_WITH_YOUR_CANCEL_URL",
    "allow_save_payment_methods": false,
    "locale": "ES_LATAM",
    "order": {
        "merchant_order_id": "1366656595193",
        "currency": "MXN",
        "subtotal_amount": 1000,
        "country_code": "MX",
        "discounts": [
            {
                "amount": 10
            }
        ],
        "total_amount": 990,
        "products": [
            {
                "id": "7197",
                "name": "Pantalla TCL Smart TV Serie A3 A343 HD Android TV 40",
                "quantity": 1,
                "unit_price": 1000
            }
        ],
        "customer": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@yopmail.com"
        }
    }
}
'

Ejemplo de respuesta del servicio

{
    "checkout_id": "chk_e69283cb55814402b9372a2f834cc8a8",
    "checkout_redirect_url": "https://checkout.sand.orkestapay.com/#/checkout/chk_e69283cb55814402b9372a2f834cc8a8/6f2d8077c669f0512cb655c1f2d19b3cc020f5fd8b17152e0d3de675575e8f69",
    "completed_redirect_url": "https://example.com/complete?order_id=ord_a73c91e6f6f949a3a39c9557f353d308",
    "canceled_redirect_url": "https://example.com/cancel?order_id=ord_a73c91e6f6f949a3a39c9557f353d308",
    "allow_save_payment_methods": false,
    "locale": "ES_LATAM",
    "placed_at": "1713480514319",
    "order": {
        "order_id": "ord_a73c91e6f6f949a3a39c9557f353d308",
        "status": "CREATED",
        "expires_at": "1713566914212",
        "merchant_order_id": "1366656595193",
        "country": "México",
        "country_code": "MX",
        "currency": "MXN",
        "taxes": [],
        "discounts": [
            {
                "amount": 10
            }
        ],
        "subtotal_amount": 1000,
        "total_amount": 990,
        "products": [
            {
                "product_id": "7197",
                "quantity": 1,
                "unit_price": 1000,
                "name": "Pantalla TCL Smart TV Serie A3 A343 HD Android TV 40"
            }
        ],
        "customer": {
            "customer_id": "cus_414bae1120844159bf10f1d6c7b30d74",
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@yopmail.com",
            "created_at": "1713480514197",
            "updated_at": "1713480514197"
        },
        "placed_at": "1713480514267",
        "metadata": {}
    }
}

Documentación API

Aquí podrás encontrar más información sobre el servicio de creación de checkout: https://orkestapay.readme.io/reference/create-checkout

Paso 2: Redireccionar al usuario al checkout de pago

Una vez que hayas obtenido la respuesta del servicio de creación de checkout, redirecciona al cliente a la URL que venga indicada en la propiedad checkout_redirect_url.

En esta URL el cliente podrá visualizar un resumen de su orden y las opciones de pago para finalizar su compra.

Paso 3: Manejar la respuesta del pago

Una vez que el cliente ha realizado su pago de forma exitosa, éste será redireccionado a la URL (completed_redirect_url) que previamente fue indicada en la petición de creación del checkout.

A esta URL que debe ser manejada por el comercio que esta integrado OrkestaPay, se le concatenará el order_id del checkout, de modo que se pueda consultar el estatus de dicha orden y verificar si ya quedó completada (COMPLETED). Así podrás implementar la lógica de negocio que sea más conveniente para tu comercio.

Documentación API

En la siguiente URL, podrás encontrar la documentación para consultar el estatus de la orden: https://orkestapay.readme.io/reference/get-order