> For the complete documentation index, see [llms.txt](https://apidocs.onekeypayments.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/basic-deposits/oneshot.md).

# OneShot

### Deposit with OneShot redirect

{% stepper %}
{% step %}

#### Create a deposit request

You will need to create a deposit request to our OneShot API, taking into care the following considerations:

* [x] sending all the mandatory payer information
* [x] indicating that is a credit/debit card payment by sending **`CC`** as `payment_method` 

{% tabs %}
{% tab title="Example request" %}

```sh
curl -L \
  --request POST \
  --url 'https://api-stg.onekeypayments.com/v3/deposits' \
  --header 'Content-Type: application/json' \
  --header 'X-Date: 2025-07-17T13:13:15.442Z' \
  --header 'X-Login: text' \
  --header 'Authorization: text' \
  --data '{
    "invoice_id" : "1000000001",
    "amount": "1000",
    "country": "MX",
    "currency": "MXN",
    "payer": {
        "id": "11",
        "document": "CURP4321TEST",
        "first_name": "Ricardo",
        "last_name": "Carlos",
        "email": "juanCarlos@hotmail.com"
    },
    "payment_method": "CC",
    "client_ip": "123.123.123.123",
    "back_url": "https://www.merchant.com/deposit_cancelled",
    "success_url": "https://www.merchant.com/deposit_completed",
    "error_url": "https://www.merchant.com/deposit_error",
    "notification_url": "https://www.merchant.com/onekeypayments/notify"
    "logo": "https://www.merchant.com/merchant-logo.png",
}'
```

{% endtab %}

{% tab title="Example response" %}

<pre class="language-json"><code class="lang-json">{
    "checkout_type": "ONE_SHOT",
<strong>    "redirect_url": "https://pay-stg.depositcheckout.com/validate/W9H0knNO7iu14F2nMe1Dtv6eMKJw2yvx",
</strong>    "deposit_id": 301623200,
    "user_id": "11",
    "merchant_invoice_id": "1000000001",
    "payment_info": {
        "type": "CREDIT_CARD",
        "payment_method": "CC",
        "payment_method_name": "Generic CC payment method",
        "amount": 1000.0,
        "currency": "MXN",
        "expiration_date": "2025-07-17 18:02:28",
        "created_at": "2025-07-17 17:42:26"
    }
}
</code></pre>

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

#### Open the `redirect_url` in a new tab

In the response you will receive the redirect\_url where the user should be sent in order to visualize the credit card checkout hosted on our systems.

{% hint style="success" %}

### Note that you can include your brand logo in our checkout!

You can either send it via API or define it statically within the Merchant Panel.
{% endhint %}

<figure><img src="/files/4NgLGPyJhAzzfh1my7C8" alt="" width="188"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Retrieve the Deposit final status

Everytime that the deposit changes it's status, you will receive a webhook notification with the **`deposit_id`** for you to retrieve the status.

```json
{
  "deposit_id": 301623200
}
```

{% hint style="info" %}

### For more information on this point visit <a href="/pages/4J1W8bBUsf3m6C60jdyS" class="button primary" data-icon="message-medical">Notifications</a>.

{% endhint %}
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidocs.onekeypayments.com/guides/deposits/create-deposits/credit-cards/basic-deposits/oneshot.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.