{
"deposit_session_id": "<string>",
"customer_id": "<string>",
"status": "active",
"allow_multiple_deposits": true,
"expires_at": 123,
"url": "<string>",
"metadata": {},
"created": 123
}{
"code": 123,
"message": "<string>",
"errorCode": "<string>",
"data": null
}{
"code": 123,
"message": "<string>",
"errorCode": "<string>",
"data": null
}{
"code": 123,
"message": "<string>",
"errorCode": "<string>",
"data": null
}Retrieve a customer deposit
Retrieve a customer deposit session for the current merchant by its ID. Returns 404 if the resource does not exist or belongs to another merchant.
Returns 404 resource_not_found if the deposit session does not exist or belongs to another merchant.
{
"deposit_session_id": "<string>",
"customer_id": "<string>",
"status": "active",
"allow_multiple_deposits": true,
"expires_at": 123,
"url": "<string>",
"metadata": {},
"created": 123
}{
"code": 123,
"message": "<string>",
"errorCode": "<string>",
"data": null
}{
"code": 123,
"message": "<string>",
"errorCode": "<string>",
"data": null
}{
"code": 123,
"message": "<string>",
"errorCode": "<string>",
"data": null
}Authorizations
Bearer API Key, for example Bearer sk_live_xxx.
Unix timestamp in seconds. Must be within 5 minutes of the server time.
Random string for replay protection, 16–64 characters.
HMAC-SHA256 signature computed using the merchant API Secret, encoded as lowercase hex.
Headers
Unix timestamp in seconds. Must be within 5 minutes of the server time.
Random string for replay protection, 16–64 characters. A new UUID is recommended for each request.
16 - 64Compute HMAC-SHA256 over {timestamp}.{nonce}.{requestBody} using the merchant API Secret and encode the result as lowercase hex. For GET requests, requestBody is an empty string.
Path Parameters
Deposit session ID.
1Response
Query successful.
Deposit session ID.
StablePay customer ID.
Deposit session status.
active, closed, expired Whether multiple deposits are allowed using the same link.
Expiration time in Unix seconds. Always null when the link never expires.
Hosted checkout URL.
Merchant-defined metadata.
Show child attributes
Show child attributes
Creation time in Unix seconds.
Was this page helpful?