Skip to content
StablezactStablezact Docs

Status of a deposit payment

GET
/deposits/status/{paymentId}
curl --request GET \
  --url https://hub.stablezact.com/api/v1/deposits/status/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-Public-Key: <X-Public-Key>'

Reports how much has arrived against how much is owed, which is what makes partial payment visible. amountRemaining is what the customer still needs to send; excessOwed is what is owed back to them.

An id that does not exist returns 500 rather than 404.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
paymentId
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

The deposit.

Media typeapplication/json
object
success
boolean
payment
object
amount
string
amountReceived
string | null
amountRemaining
string | null
excessOwed
string | null
depositAddress

Null when the payment was not made through a deposit address, which this endpoint will still answer for.

string | null
depositMethod
string
confirmations
integer
expiresAt
string format: date-time
Examplegenerated
{
  "success": true,
  "payment": {
    "amount": "example",
    "amountReceived": "example",
    "amountRemaining": "example",
    "excessOwed": "example",
    "depositAddress": "example",
    "depositMethod": "example",
    "confirmations": 1,
    "expiresAt": "2026-04-15T12:00:00Z"
  }
}

401

Section titled “401”

Missing or invalid credentials.

Media typeapplication/json
object
success
boolean
error
required

Short machine-ish reason.

string
message

Longer explanation, when there is one.

string
Example
{
  "error": "API credentials required. Use x-public-key header or x-api-key and x-api-secret headers."
}