Get deposit status

Retrieve Deposit Status

get

Retrieve the status of a previously created deposit. This endpoint allows you to retrieve the status of a deposit request.

Path parameters

deposit_idintegerRequired

onekeypayments deposit_id. It is obtained when creating the deposit.

Header parameters

Content-TypestringRequired

Media type of the body sent to the API. (Note: For GET, typically no request body)

Default: application/json

X-Datestring · date-timeRequired

ISO8601 Datetime with Timezone. Example: 2020-06-24T17:13:21Z

X-LoginstringRequired

Merchant X-Login API Key

AuthorizationstringRequired

Authentication signature hash

X-Idempotency-KeystringOptional

Unique idempotency key for ensuring that the same request is not processed more than once. (Typically for state-changing requests)

Responses

200

Deposit status successfully retrieved

application/json

400

The deposit_id specified is not valid

application/json

401

Unauthorized access

application/json

404

The deposit_id specified could not be found

application/json

get

/deposits/{deposit_id}

HTTPcURLJavaScriptPython

GET /v3/deposits/{deposit_id} HTTP/1.1
Host: api-stg.onekeypayments.com
Content-Type: application/json
X-Date: 2026-03-03T03:30:06.747Z
X-Login: text
Authorization: text
Accept: */*

{
  "user_id": "11",
  "deposit_id": 300004285,
  "invoice_id": "989409592",
  "country": "BR",
  "currency": "BRL",
  "local_amount": 53162,
  "usd_amount": 1000,
  "bonus_amount": 100,
  "bonus_relative": false,
  "payment_method": "VI",
  "payment_type": "CREDIT_CARD",
  "status": "COMPLETED",
  "payer": {
    "document": "17532655253",
    "document_type": "CPF",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Smith",
    "address": {
      "city": "Sao Paulo",
      "state": "SP",
      "street": "John Street 2453",
      "zip_code": "938475-234"
    }
  },
  "fee_amount": 2.5,
  "fee_currency": "USD",
  "refunded": false,
  "current_payer_verification": "UNMATCHED",
  "card_detail": {
    "card_holder": "John Smith",
    "brand": "Visa",
    "masked_card": "1234 56** **** 6789",
    "expiration": "2023-12",
    "card_type": "DEBIT",
    "transaction_result": "Transaction Approved"
  }
}