¶ Cancel deposit

Cancel the deposit draft order to make it unusable for any further state changes. Should be called only after a successful update-deposit call. Make your request at this endpoint:

POST /v1/payments/deposits/:id/cancel

¶ Authentication

OAuth 2.0 bearer token with the payments.deposits scope.

¶ Path parameters

¶ Request headers

¶ Body parameters

¶ Example request and response

¶ Example request

The following is an example request for the cancel deposit resource. To use this request, replace $token in the example below with the access token.

curl -X POST \
  "https://sandbox-api.uber.com/v1/payments/deposits/3dad6604-c805-4153-9286-b58dca9b6ca7/cancel" \
  -H "Authorization: Bearer $token" \
  -H 'X-Idempotency-Key: 3dad6604-c805-4153-9286-b58dca9b6ca7-cancel' \
  -H 'Content-Type: application/json' \
  -d '{
    "cancel_reason": "USER_CANCELLED"
}'

This is an example of what you can expect to see in response:

{
	"deposit": {
		"id": "b6118d57-2106-3873-094c-2e7a4ab9f967",
		"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": "CANCELLED",
			"detail": "USER_CANCELLED"
		},
		"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/b6118d57-2106-3873-094c-2e7a4ab9f967"
	}
}

¶ Cancel deposit errors

¶ Cancel deposit header errors