API Reference - Read Deposit
¶ Read deposit
Get the deposit information in order to debug or surface the appropriate information in your internal tools and dashboards. Make your request at this endpoint:
GET /v1/payments/deposits/:id
¶ Authentication
OAuth 2.0 bearer token with the payments.deposits
scope.
¶ Path parameters
Name | Type | Description |
---|---|---|
id | UUID | Deposit ID |
¶ Example request and response
The following is an example request for the read deposit resource. To use this request, replace $token
in the example below with the access token.
curl "https://sandbox-api.uber.com/v1/payments/deposits/ad18f686-84dc-4255-841b-5f2153c70887" -H "Authorization: Bearer $token"
This is an example of what you can expect to see in response:
{
"deposit": {
"id": "8a7ae66b-4866-7efb-14ae-f0b5711c65f4",
"destination": {
"id": "cHBfYjA3NDA5MzItYzI2Mi00MTk5LThkZGItY2Y2NGRhMTU0OWQ4",
"owner_id": "e00905e1-066d-4c44-bd9d-ea8fd7d7be8e",
"type": "Account",
"uri": "//payments/customers/e00905e1-066d-4c44-bd9d-ea8fd7d7be8e/accounts/cHBfYjA3NDA5MzItYzI2Mi00MTk5LThkZGItY2Y2NGRhMTU0OWQ4"
},
"source": {
"id": "Z3NfZjNmMmU2MDYtMjYzYS0zMzY2LThjOWMtMmQ0MGU1ODE2ZWZj",
"owner_id": "a7b46663-3b97-40be-9b3e-ab805a56b269",
"type": "Account",
"uri": "//payments/customers/a7b46663-3b97-40be-9b3e-ab805a56b269/accounts/Z3NfZjNmMmU2MDYtMjYzYS0zMzY2LThjOWMtMmQ0MGU1ODE2ZWZj"
},
"state": {
"value": "CREATED"
},
"amount": {
"value": 1000000,
"currency": "EUR"
},
"description": "",
"country_iso2": "NL",
"session_id": "36adcbfd-15fc-45e6-bd51-0f2a52c17c93",
"funding_method": "TEST_FUNDING_METHOD",
"type": "Deposit",
"uri": "//payments/deposits/8a7ae66b-4866-7efb-14ae-f0b5711c65f4"
}
}
¶ Read deposit errors
HTTP status code | URL sample | Scenario |
---|---|---|
200 | https://sandbox-api.uber.com/v1/payments/deposits/{{VALID_DEPOSIT_UUID}} | Existing deposit |
400 | https://sandbox-api.uber.com/v1/payments/deposits/MMMMMMMM-MMMM-MMMM-MMMMM | Invalid deposit UUID |
404 | https://sandbox-api.uber.com/v1/payments/deposits/{{NON_EXISTING_DEPOSIT_UUID}} | Non-existing deposit |
403 | https://sandbox-api.uber.com/v1/payments/deposits/{{UNAUTHORIZED_EXISTING_DEPOSIT_UUID}} | Unauthorized deposit |