Replaces a webhook subscription.

  • Published on May 28, 2025
  • 12 minute(s) read
Prev Next
Put
/subscriptions/{subscription_id}

Replaces an existing webhook subscription.

Security
HTTP
Type bearer

JWT authentication security

OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
subscriptions.updateUpdate Access
Header parameters
x-b3-traceid
string

Overall ID of the trace, shared by every span in the trace.

The value is 64 or 128 bits long.

Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Example80f198ee56343ba864fe8b2a57d3eff7
x-b3-parentspanid
string

Position of the parent operation in the trace tree.

The value is 64 bits long.

The value is omitted when the span is the root of the trace tree.

Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Example05e3ac9a4f6e3b90
x-b3-spanid
string

Position of the current operation in the trace tree.

The value is 64 bits long.

Do not interpret the value: it may or may not be derived from the value of the TraceId.

Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Examplee457b5a2e4d86bd1
x-b3-sampled
string

Sampling decision.

Sampling is a mechanism to reduce the volume of data in the tracing system. In B3, sampling applies consistently per-trace: once the sampling decision is made, the same value must be consistently sent downstream. This means that either all or no spans share a trace ID.

The possible values are:

  • 0 = Deny
  • 1 = Accept
  • d = Debug
Min length0
Max length32
Pattern^[a-zA-Z0-9_]*$
Example1
x-santander-client-id
stringRequired

Client ID header

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Examplea1b30a84-7bf3-442e-84a0-e935d8163b5a
Path parameters
subscription_id
stringRequired

Identifies a subscription for the current client

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
Body parameters

Details for creating or modifying a webhook subscription

SubscriptionInputMtls
{
  "type": "payment-status",
  "callbackUrl": "https://example.com/webhook",
  "auth": {
    "type": "mtls"
  }
}
SubscriptionInputPrivateJwt
{
  "type": "payment-status",
  "callbackUrl": "https://example.com/webhook",
  "auth": {
    "type": "oauth-privatejwt",
    "url": "https://onetrade.dev.api.pagonxt.com/oauth/token",
    "scopes": "resource.read resource.write",
    "subscription": "00fe9330-9bdf-4cd4-ae8c-00cf22f736b2"
  }
}
object

Details for creating or modifying a webhook subscription.

auth

Security information to load before calling the callback. Must set one of the valid types:

  • mtls
  • oauth-privatejwt
OneOf
OAuthPrivateJWTSecurity
object (OAuthPrivateJWTSecurity)
type
string Required

Security type for OAuth PrivateJWT authentication

Valid values[ "oauth-privatejwt" ]
Exampleoauth-privatejwt
url
string (uri) Required

Generic HTTPS URL with query parameters and fragment

Min length0
Max length255
Pattern^https://(%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+([).!';/?:,])?$
Examplehttps://example.com/webhook
subscription
string Required

Valid Universally Unique Identifier

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
scopes
string

Authorization scopes for OAuth PrivateJWT security

Min length0
Max length2048
Pattern^\S+( \S+)*$
Exampleresources.read resources.create
MtlsSecurity
object (MtlsSecurity)
type
string Required

Security type for MTLS authentication

Valid values[ "mtls" ]
Examplemtls
callbackUrl
string (uri) Required

Generic HTTPS URL with query parameters and fragment

Min length0
Max length255
Pattern^https://(%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+([).!';/?:,])?$
Examplehttps://example.com/webhook
OneOf
PaymentStatusSubscriptionInput
object (PaymentStatusSubscriptionInput)
type
Valid values[ "payment-status" ]
Examplepayment-status
AccountsEntriesSubscriptionInput
object (AccountsEntriesSubscriptionInput)
type
Valid values[ "accounts-entries" ]
Examplepayment-status
customerId
string Required

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
CollectionStatusSubscriptionInput
object (CollectionStatusSubscriptionInput)
type
Valid values[ "collection-status" ]
Examplepayment-status
customerId
string Required

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
RecurrentCardPaymentsSubscriptionInput
object (RecurrentCardPaymentsSubscriptionInput)
type
Valid values[ "recurrent-card-payments" ]
Examplepayment-status
customerId
string Required

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
PayInCollectionStatusSubscriptionInput
object (PayInCollectionStatusSubscriptionInput)
type
Valid values[ "payin-collection-status" ]
Examplepayment-status
customerId
string Required

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
Responses
200

Webhook subscription response

SubscriptionMtls
{
  "id": "2507b89c-b680-46df-9505-e0b6f78cf295",
  "type": "payment-status",
  "callbackUrl": "https://example.com/webhook",
  "auth": {
    "type": "mtls"
  },
  "maxSequenceNumber": "1"
}
SubscriptionOAuthPrivateJwt
{
  "id": "00fe9330-9bdf-4cd4-ae8c-00cf22f736b2",
  "type": "payment-status",
  "callbackUrl": "https://example.com/webhook",
  "auth": {
    "type": "oauth-privatejwt",
    "url": "https://onetrade.dev.api.pagonxt.com/oauth/token",
    "scopes": "resource.read resource.write",
    "subscription": "00fe9330-9bdf-4cd4-ae8c-00cf22f736b2"
  },
  "maxSequenceNumber": "1"
}
object

Webhook subscription details. entityIds represents the entities that this callback applies to, if not specified it applies all entities.

auth

Security information to load before calling the callback. Must set one of the valid types:

  • mtls
  • oauth-privatejwt
OneOf
OAuthPrivateJWTSecurity
object (OAuthPrivateJWTSecurity)
type
string

Security type for OAuth PrivateJWT authentication

Valid values[ "oauth-privatejwt" ]
Exampleoauth-privatejwt
url
string (uri)

Generic HTTPS URL with query parameters and fragment

Min length0
Max length255
Pattern^https://(%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+([).!';/?:,])?$
Examplehttps://example.com/webhook
subscription
string

Valid Universally Unique Identifier

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
scopes
string

Authorization scopes for OAuth PrivateJWT security

Min length0
Max length2048
Pattern^\S+( \S+)*$
Exampleresources.read resources.create
MtlsSecurity
object (MtlsSecurity)
type
string

Security type for MTLS authentication

Valid values[ "mtls" ]
Examplemtls
callbackUrl
string (uri)

Generic HTTPS URL with query parameters and fragment

Min length0
Max length255
Pattern^https://(%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+([).!';/?:,])?$
Examplehttps://example.com/webhook
id
string

Valid Universally Unique Identifier

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
maxSequenceNumber
integer (int64)

Sequence number of the webhook call. Calls are numbered starting from 1 as they are sent.

Minimum0
Maximum9223372036854775807
Example23
OneOf
PaymentStatusSubscriptionInput
object (PaymentStatusSubscriptionInput)
type
Valid values[ "payment-status" ]
Examplepayment-status
AccountsEntriesSubscriptionInput
object (AccountsEntriesSubscriptionInput)
type
Valid values[ "accounts-entries" ]
Examplepayment-status
customerId
string

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
CollectionStatusSubscriptionInput
object (CollectionStatusSubscriptionInput)
type
Valid values[ "collection-status" ]
Examplepayment-status
customerId
string

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
RecurrentCardPaymentsSubscriptionInput
object (RecurrentCardPaymentsSubscriptionInput)
type
Valid values[ "recurrent-card-payments" ]
Examplepayment-status
customerId
string

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
PayInCollectionStatusSubscriptionInput
object (PayInCollectionStatusSubscriptionInput)
type
Valid values[ "payin-collection-status" ]
Examplepayment-status
customerId
string

Customer ID

Min length1
Max length30
Pattern^[a-zA-Z0-9_-]{1,30}$
Examplepagonxt_esESpuo1726272A
filterEntityIds
Array of string (EntityId)

Entity IDs.

Min items1
Max items10000
string

Entity ID. Varies depending on Webhook type. For payment-status is payment id, for accounts-entries is account id and for collections-status is collection id.

Min length1
Max length36
Pattern^[a-zA-Z0-9_-]{1,36}$
Examplea1726272A
400

Bad request

err400Example
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "level": "FATAL",
      "message": "Bad Request",
      "description": "Error validating schema"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
401

Unauthorized

err401Example
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "ERROR",
      "description": "Authorization credentials are missing or invalid"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
403

Forbidden

err403Example
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "level": "FATAL",
      "message": "Forbidden",
      "description": "Logged in user is not authorized to access data"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
404

Not found

err404Example
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "level": "FATAL",
      "message": "Not Found",
      "description": "Requested resource was not found but may be available later"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
406

Not acceptable

err406Example
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "level": "FATAL",
      "message": "Not Acceptable",
      "description": "Request content not acceptable"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
409

Conflict

err409Example
{
  "errors": [
    {
      "code": "CONFLICT",
      "level": "FATAL",
      "message": "Conflict",
      "description": "Request conflicts with the current state of the target resource"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
413

Payload too large

err413Example
{
  "errors": [
    {
      "code": "PAYLOAD_TOO_LARGE",
      "level": "FATAL",
      "message": "Payload Too Large",
      "description": "Payload is larger than the maximum size allowed by the server"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
414

URI too long

err414Example
{
  "errors": [
    {
      "code": "URI_TOO_LONG",
      "level": "FATAL",
      "message": "URI Too Long",
      "description": "URI is longer than the maximum size allowed by the server"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
415

Unsupported media type

err415Example
{
  "errors": [
    {
      "code": "UNSUPPORTED_MEDIA_TYPE",
      "level": "FATAL",
      "message": "Unsupported Media Type",
      "description": "Media format is not supported by the server"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
422

Unprocessable entity

err422Example
{
  "errors": [
    {
      "code": "UNPROCESSABLE_ENTITY",
      "level": "FATAL",
      "message": "Unprocessable Entity",
      "description": "Request was well formed but there are semantic errors"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
429

Too many requests

err429Example
{
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "level": "ERROR",
      "message": "Too Many Requests",
      "description": "User has sent too many requests"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
500

Internal server error

err500Example
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "message": "Internal server error",
      "description": "Server has encountered an error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
503

Service unavailable

err503Example
{
  "errors": [
    {
      "code": "SERVICE_UNAVAILABLE",
      "level": "ERROR",
      "message": "Service unavailable",
      "description": "Server is not ready to handle the request"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
504

Gateway timeout

err504Example
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT",
      "level": "ERROR",
      "message": "Gateway timeout",
      "description": "Server cannot get a gateway response in time"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
default

Default error

errDefaultExample
{
  "errors": [
    {
      "code": "Error code",
      "level": "ERROR",
      "message": "Error message",
      "description": "Error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid