Our API Docs just got a new look!

OneShot

Our OneShot solution will enable you to redirect the user to our checkout page where the user will see all the details for completing the deposit, and also will enable you to render the checkout page on your website (in the case of using Alternative Payment Methods).

Alternative Payment Methods world-class integration

Our OneShot integration allows you to render the checkout information on your website.

We will always send you the redirect_url parameter with the checkout hosted in our end.

But if you are looking for the best user experience, you can display the checkout in your site with your own custom design. You will receive in the response the required information in the metadata[] object within the payment_info[], such as QR codes, bar codes, banking copy/paste addresses, bank transfer details and more!

QR code and Digitable Line
{
    "checkout_type": "ONE_SHOT",
    "redirect_url": "https://payment-stg.depositcheckout.com/v1/checkout/eyJhbGciOiJIUzM4NCJ9.eyJqdGkiOiI1NzIyNjAwMiIsImlhdCI6MTc1MjUyMDk1NywiZXhwIjoxNzUzODE2OTU3LCJsYW5ndWFnZSI6InB0In0.50XjLnTTgaPowAHG7v8jP5jsXsUu6pp7mn5InR3UC-uFofNKVMOl9CEFNmH1FOOw/BR/IX/0341/31581",
    "iframe": true,
    "deposit_id": 301621986,
    "merchant_invoice_id": "postmanTest410953016",
    "payment_info": {
        "type": "VOUCHER",
        "payment_method": "IX",
        "payment_method_name": "Pix",
        "amount": 50.00,
        "currency": "BRL",
        "expiration_date": "2025-07-14 22:22:36",
        "created_at": "2025-07-14 19:22:36",
        "metadata": {
            "payer_document": "84721238045",
            "reference": 57226002,
            "show_terms_conditions": true,
            "payer_document_type": "CPF",
            "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9AQAAAACn+1GIAAACN0lEQVR4Xt3UMZL3EBgHYJq4QjRxtaSJKySN0MQVopGrScMVaFjfX/abWewFVpV5Zoj39QOkn8ODPwUeTERa6oTfOexCSNdEwokiFXfog9D4tnvg5LnwL5CnXPCWhv4KmroIAPLHb5CUJuqW7iLf+6jAA6ze8V1LBXlY6ok6d/m/Hz/BQz7uHCD5+JV2IfFFnGwx0Dl9dCHcUjhz3MJOrLSwhuTsdKT0eJR4WbQGPxPlLhyHRSTVhfxlNnaYPO/6TGkgPfdtoB+pPI/PlBac3XDcsN4j2PuQz3lRfBiW3KU+hORuu83/yi+/rSFuYAbIIL0B9lm0hZXmnVHh2QSWLvgJcSSUO7FKogtJOmGPeHBGpeuCHwH2B8ePumAJTA1JBT5NRE/L40v5NXh4oRzqWz5ClXNpwc8TI+cwL/5NUA0jlEnxnH//vY8K4rpuM4Nmj4yVFtbgV6yCEMmZ3IQ+oLitDHqwru+UGiI55xWZPSmlcRdCvlzwJJrRWA6qAT8OKAgXh10+5bc1JL6NA5tHHOmbjxo81YAoS6VfrrJoDRE9UulhUXFinyvWwqIMFuq2AJbyGwjBYMvANrL3tw1ENkB3R5qunP8+oKAiG4nN5b/7qMCT/BRcYEL5xSk5rSHfj+dcicbPU+LQQH62Qhyx0Ayqko8aQtIb1URw9kaqBXFhCwBxgsNSfgvKHrdeZA7o53r0ICWz7UmeU3nYGkjXOgzbSu1eGtRA3ro0gB3Or0fpRw0/x9+GL70BgIv6XzUUAAAAAElFTkSuQmCC",
            "digitable_line": "00020101021226850014br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/0a7702b2-c6b6-439a-9fd5-cc70c0c2353c5204000053039865802BR5925SOLAPA SERVICOS ADMINISTR6008CURITIBA62070503***6304AD87"
        }
    }
}

Hosted checkout

In the event that not all mandatory data is sent in the initial API call, the system will automatically trigger an intermediate flow known as the Hosted flow. This ensures the payment can still be completed.

  • What happens: The API will return the parameter checkout_type with value HOSTED and a redirect_url.

  • Required action: You must redirect the user to that URL. On our hosted page, we will collect the missing information from the user before presenting them with the final checkout instructions in the same tab.

Build the solution

Last updated

Was this helpful?