Skip to main content
GET
Retrieve Deposit

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Path Parameters

order_id
string
required

Order ID

Response

200 - application/json

Successfully retrieved deposit

code
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required