Struct Error 

pub struct Error {
    pub correlation_id: Option<String>,
    pub error_link: Option<Url>,
    pub error_message: String,
    pub error_type: ErrorType,
    pub unauthorized_capabilities: Vec<CapabilityName>,
}

An error response including the code for the type of error and a human-readable message describing the error.

JSON schema

{
 "description": "An error response including the code for the type of error and a human-readable message describing the error.",
 "examples": [
   {
     "correlationId": "41deb8d59a9dc9a7-IAD",
     "errorLink": "https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request",
     "errorMessage": "Invalid request.",
     "errorType": "invalid_request"
   }
 ],
 "type": "object",
 "required": [
   "errorMessage",
   "errorType"
 ],
 "properties": {
   "correlationId": {
     "description": "A unique identifier for the request that generated the error. This can be used to help debug issues with the API.",
     "examples": [
       "41deb8d59a9dc9a7-IAD"
     ],
     "type": "string"
   },
   "errorLink": {
     "description": "A link to the corresponding error documentation.",
     "examples": [
       "https://docs.cdp.coinbase.com/api-reference/v2/errors#invalid-request"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/Url"
       }
     ]
   },
   "errorMessage": {
     "description": "The error message.",
     "examples": [
       "Unable to create EVM account"
     ],
     "type": "string"
   },
   "errorType": {
     "$ref": "#/components/schemas/ErrorType"
   },
   "unauthorizedCapabilities": {
     "description": "The capability code(s) that were not authorized for the customer on\nthis request. Present only when `errorType` is\n`customer_not_authorized`; absent for every other error type.\n\nUse this list to render onboarding UX for the listed capabilities, or\nfetch `GET /v2/customers/{customerId}` and inspect each entry's\n`status` / `requirements` to discover what (if anything) can be\nsubmitted to resolve the block.\n",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/CapabilityName"
     }
   }
 }
}

Fields

correlation_id: Option<String>

A unique identifier for the request that generated the error. This can be used to help debug issues with the API.

error_link: Option<Url>

A link to the corresponding error documentation.

error_message: String

The error message.

error_type: ErrorType

unauthorized_capabilities: Vec<CapabilityName>

The capability code(s) that were not authorized for the customer on this request. Present only when errorType is customer_not_authorized; absent for every other error type.

    Use this list to render onboarding UX for the listed capabilities, or
    fetch `GET /v2/customers/{customerId}` and inspect each entry's
    `status` / `requirements` to discover what (if anything) can be
    submitted to resolve the block.

Implementations

impl Error

pub fn builder() -> Error

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Error> for Error

fn from(value: &Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: Error) -> Self

Converts to this type from the input type.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Error> for Error

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Error) -> Result<Self, ConversionError>

Performs the conversion.