API Reference - Find Deposit status
¶ Find deposit status
Uber invokes this API server-side to fetch the latest status of the payment deposit. Unlike the other interfaces, partners expose this API.
¶ Interface authentication
For authentication, use the RSA-SHA256 signature with the Uber payments public key. See the Signature request header for more details. You can also use the sandbox public key for development and testing:
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnYzMrDq+EnccKtcs5gQM
uP5aDe9WzdBGyUiervrFCEXmVW+T2nsSKJJR02H84LBKPjz2ioI3L289q1Qx1gj7
gvV9VZCaKejIsdKWnM5QW/1VvARWL2diScZzp5OxKX78X8aevvts79B9cVZUiEOU
E4+TTe9qLOQvbc9SssTbdqiA+1xqU+wW7IfHm5cC5kLb+Kv3pqJ63lMTx2L1iNuO
xinwun8lpdRl2+c7LswqqpUfI7Hfk0QF/XJO01BXsDxCzxkuHoWa4SNL+gNx3M69
vc5ymlZHJNZRPLMIe4+VVRaDe0dCOUcHz3cmXCjkLKfdd3JFAG+8FU/CvE1qzyP4
pwIDAQAB
-----END PUBLIC KEY-----
If the authentication fails, you receive the response: 401 Unauthorized.
¶ Query parameters
| Name | Type | Required | Description |
id
|
String | Required | Deposit ID. |
merchant_reference
|
String | Optional | Transaction reference ID from the partner. |
¶ Request headers
| Name | Type | Description |
Date
|
String | Date in GMT, according to RFC7231 section 7.1.1.2 |
Digest
|
String | Cryptographic hash of request body according to RFC3230 and using SHA256 algorithm. See also RFC5843. |
Signature
|
String | RSA signature of request-target, host, date and digest headers with PKCS v1.5 Padding |
¶ Response status code
Expected response status code: 200 OK
¶ Response body
| Name | Type | Required | Description |
id
|
String | Required | Original deposit id in Uber’s system |
merchant_reference
|
String | Required | Original transaction reference in Partner’s system |
status
|
String | Required | PENDING: payment still in progress
|
confirmed_at
|
String | Optional | Payment confirmed date time in Partner’s system with ISO 8601 format. This field should be present if the status is SUCCEEDED.
|
amount
|
Object | Optional | Value and currency, ISO4217. The value is in E5 format (x * 100000). For example, 10 BRL is: {"value": 1000000, "currency": "BRL"}
|
¶ Example request and response
¶
The following is an example request for the find deposit status. You can replace https://uber.partner.com/v1/payments/query-deposit in the example below with the relevant partner URL.
curl -X GET \
https://uber.partner.com/v1/payments/query-deposit?id=cGdfMGE3OTA1OTItYTIyNi0zY2EyLWFjZjEtNzE0YTAwMzAxMmQz \
-H 'Date: Sat, 08 Jun 2019 20:51:35 GMT' \
-H 'Digest: SHA-256=FkJ3miKx7I099a8n7q3Kmn7P8/dFS1Ebx5POQd185PM=' \
-H 'Signature: keyId="rsa-key", algorithm="rsa-sha256",
headers="(request-target) host date digest",
signature="INCLUDED_SIGNATURE"'
¶ This is an example response:
{
"id": "cGdfMGE3OTA1OTItYTIyNi0zY2EyLWFjZjEtNzE0YTAwMzAxMmQz",
"merchant_reference": "599f4164-4417-4361-9d11-1d9d8b4b9096",
"status": "SUCCEEDED",
"confirmed_at": "2020-04-11T12:00:00Z"
}
¶ Find deposit status errors
| HTTP status code | URL sample | Scenario |
|
https://uber.partner.com/v1/payments/query-deposit?id={{VALlD_DEPOSIT_UUID}}
|
Valid deposit |
|
https://uber.partner.com/v1/payments/query-deposit
|
No deposit ID |
|
https://uber.partner.com/v1/payments/query-deposit?id={{NON_EXISTING_DEPOSIT_UUID}}
|
Non-existing deposit |