# Get a cashout status

## Retrieve Cashout Status

> This API allows you to retrieve the status of a cashout.

```json
{"openapi":"3.0.0","info":{"title":"Cashout Status API","version":"v3"},"servers":[{"url":"https://api-stg.onekeypayments.com","description":"Staging environment"}],"paths":{"/v3/cashout/status":{"post":{"summary":"Retrieve Cashout Status","description":"This API allows you to retrieve the status of a cashout.","tags":["Cashout"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["login","pass"],"properties":{"login":{"type":"string","description":"Your onekeypayments CASHOUTS API login key. Length 32 max."},"pass":{"type":"string","description":"Your onekeypayments CASHOUTS API pass key. Length 32 max."},"cashout_id":{"type":"number","description":"The ID of the cashout to check status of. It is the one generated by onekeypayments when the cashout was created. (Required if external_id is not provided)"},"external_id":{"type":"string","description":"The ID of the cashout to check status of. It is the one you sent when the cashout was created. (Required if cashout_id is not provided)"}}}}}},"parameters":[{"in":"header","name":"Content-Type","required":true,"schema":{"type":"string","default":"application/json"},"description":"Media type of the body sent to the API. Must be application/json."},{"in":"header","name":"Payload-Signature","required":true,"schema":{"type":"string"},"description":"Control Signature."}],"responses":{"200":{"description":"The status of the cashout was successfully retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"cashout_status":{"type":"integer","description":"Status code of the cashout.\n- 0: PENDING - The cashout was accepted by onekeypayments but it wasn't sent to the bank yet. It can still be Canceled.\n- 1: COMPLETED - The money reached the customer's account.\n- 2: CANCELLED - The cashout was cancelled by you.\n- 3: REJECTED - The cashout was rejected by the bank due to invalid bank account, account closed, etc.\n- 4: DELIVERED - The cashout was sent to the bank for processing. At this point it can't be cancelled anymore.\n- 5: ON HOLD - Cashout set to on hold by you. It won't be processed until manually changed again to Pending status.\n","enum":[0,1,2,3,4,5]},"cashout_status_description":{"type":"string","description":"Description of the status. (e.g., \"Completed\", \"Pending\", etc.)"},"rejection_code":{"type":"integer","description":"Rejection code if the cashout status is REJECTED. See `enum` for possible bank rejection codes.\n","enum":[800,801,802,803,804,805,806,807,808,809,810,811,812,813,814,815,816,817,818,819,820,821,822,824]},"rejection_reason":{"type":"string","description":"Textual reason for rejection, corresponding to the rejection_code. (e.g., \"ERROR_ACCOUNT_INCORRECT\")"},"provider_external_reference":{"type":"string","description":"ID of the transaction on the bank side. For Pix, it's the E2E ID (End-to-end)."},"bank":{"type":"object","description":"Object containing information about the bank of the beneficiary.","properties":{"code":{"type":"string","description":"Code of the bank of the beneficiary."},"name":{"type":"string","description":"Name of the bank of the beneficiary."},"branch":{"type":"string","description":"Branch of the beneficiary's bank account."},"account":{"type":"string","description":"Account number of the beneficiary's bank account."},"beneficiary_name":{"type":"string","description":"Name of the owner of the account."}}}}}}}},"400":{"description":"Bad Request. This can be due to various reasons including invalid parameters, malformed JSON, KYC errors, or other client-side errors. \nSpecific error codes and messages will be provided in the response body.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized access. This can be due to invalid credentials or an unregistered IP address.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}}},"412":{"description":"Precondition Failed. Typically indicates the cashout ID was not found.\n","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}}},"500":{"description":"Internal Server Error. This can be due to various server-side issues.\nSpecific error codes and messages may be provided in the response body.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code (typically a onekeypayments internal code)"},"message":{"type":"string","description":"Error message corresponding to the code"},"details":{"type":"string","nullable":true,"description":"Additional error details if available"}}}}}}}}
```


---

# Agent Instructions: 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:

```
GET https://apidocs.onekeypayments.com/api-reference/cashouts-api/manage-cashouts/get-a-cashout-status.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.