Creates payment subject.

  • Updated on Nov 24, 2025
  • Published on Jun 3, 2025
  • 11 minute(s) read
Prev Next
Post
/customers/{customer_id}/payment_subjects

Create a new payment subject.

Security
OAuth

OAuth Grant type use on OpenAPI subscriptions, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
paymentsubjects.createModifying payment subjects information via open API
Header parameters
x-client-id
string (uuid) Required

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}$
Path parameters
customer_id
stringRequired

Customer unique id.

Min length1
Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esESB76134758
Body parameters

Create payment subject request body.

createPersonPaymentSubject

Create person payment subject.

Create person payment subject example.

{
  "externalId": "extid3",
  "metadataType": "PERSON",
  "supplementaryReference": "PN2222AAAA",
  "metadata": {
    "name": "Juan",
    "lastName": "Gonzales",
    "dateOfBirth": "2024-12-01",
    "idNumber": "25073259Q",
    "email": "hello@myemail.com"
  }
}
createCompanyPaymentSubject

Create company payment subject.

Create company payment subject example.

{
  "externalId": "extid3",
  "metadataType": "COMPANY",
  "supplementaryReference": "PN2222AAAA",
  "metadata": {
    "name": "My Company S.A.",
    "taxId": "25073259Q",
    "email": "hello@mycompany.com"
  }
}
Expand All
object
externalId
string Required

External ID used to identify the payment subject by the customer.

Min length1
Max length255
Pattern^[a-zA-Z0-9\-_]*$
Example1234-abcd
supplementaryReference
string

Unique supplementary reference that can be optionally provided by our customer.

Min length10
Max length10
Pattern^PN[2-9]{4}[A-HJ-KM-NP-Za-hj-km-np-z]{4}$
ExamplePN2222AAAA
metadataType
string

Type of the extra info attached to a payment subject. It can be PERSON or COMPANY.

Valid values[ "PERSON", "COMPANY" ]
ExamplePERSON
metadata
object

Optional metadata info. Available properties for PERSON: name, lastName, idNumber, email and dateOfBirth. Available properties for COMPANY: name, email and taxId.

name
string

Company name.

Min length1
Max length255
Pattern^(?:['_.,&\-\sa-zA-ZÀ-ÿ0-9])+$
ExampleMonsters S.A.
lastName
string

Person last name.

Min length1
Max length255
Pattern^(?:['_.,&\-\sa-zA-ZÀ-ÿ0-9])+$
ExampleWashington
email
string

Company email.

Min length1
Max length254
Pattern^[\w.]+@([\w-]+\.)+[\w-]{2,4}$
Examplename@email.com
dateOfBirth
string

Person birth date.

Min length10
Max length10
Pattern^\d{4}-\d{2}-\d{2}$
Example1998-03-17
idNumber
string

Optional identification number that can be the national id, passport or any other id of the person. It's a free string.

Min length1
Max length255
Pattern^[a-zA-Z0-9-]+$
Example25073259Q
taxId
string

Tax id of the company.

Min length1
Max length255
Pattern^[a-zA-Z0-9-]+$
ExampleA12345678
realAccountId
string (uuid)

Parent real account UUID. If provided, a virtual account under this real account will be assigned to the new payment subject.

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
Responses
201

New payment subject response.

{
  "id": "8ff529e3-d6c8-4ee6-afe3-b71c05e06f63",
  "customerId": "eventTEST251024",
  "externalId": "1000",
  "metadataType": "PERSON",
  "createdAt": "2024-12-09T11:08:06.721Z",
  "updatedAt": "2024-12-09T11:08:06.721Z",
  "customer": {
    "id": "eventTEST251024",
    "name": "Phone Company",
    "address": "Calle Nueva, 28001, Madrid, MADRID, ES"
  },
  "virtualAccount": {
    "accountIdentifiers": [
      {
        "accountIdType": "uuid",
        "accountId": "fbb5217f-2a88-47cd-8ad8-5df73afdf9b1"
      },
      {
        "accountIdType": "iban",
        "accountId": "ES0967222000420000004643"
      },
      {
        "accountIdType": "bban",
        "accountId": "67222000420000004643",
        "country": "ES"
      }
    ],
    "realAccountId": "76a251e2-59c6-4de9-96a2-911cf13519a0",
    "legalEntityBic": "PAGOES22XXX"
  },
  "metadata": {
    "name": "Juan",
    "lastName": "Gonzales",
    "dateOfBirth": "2024-12-01",
    "idNumber": "25073259Q"
  },
  "_links": {
    "self": {
      "href": "https://host/customers/eventTEST251024/payment_subjects/8ff529e3-d6c8-4ee6-afe3-b71c05e06f63"
    }
  }
}
Expand All
object
createdAt
string (date-time)

Date and time when the entry was created.

Max length24
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$
Example2024-10-04T10:02:03.482Z
updatedAt
string (date-time)

Date and time when the entry was updated.

Max length24
Pattern^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$
Example2024-10-04T10:02:03.482Z
id
string (uuid)

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
customerId
string

Customer unique id.

Min length1
Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esESB76134758
externalId
string

External ID used to identify the payment subject by the customer.

Min length1
Max length255
Pattern^[a-zA-Z0-9\-_]*$
Example1234-abcd
supplementaryReference
string

Unique supplementary reference that can be optionally provided by our customer.

Min length10
Max length10
Pattern^PN[2-9]{4}[A-HJ-KM-NP-Za-hj-km-np-z]{4}$
ExamplePN2222AAAA
metadataType
string

Type of the extra info attached to a payment subject. It can be PERSON or COMPANY.

Valid values[ "PERSON", "COMPANY" ]
ExamplePERSON
metadata
object

Optional metadata info. Available properties for PERSON: name, lastName, idNumber, email and dateOfBirth. Available properties for COMPANY: name, email and taxId.

name
string

Company name.

Min length1
Max length255
Pattern^(?:['_.,&\-\sa-zA-ZÀ-ÿ0-9])+$
ExampleMonsters S.A.
lastName
string

Person last name.

Min length1
Max length255
Pattern^(?:['_.,&\-\sa-zA-ZÀ-ÿ0-9])+$
ExampleWashington
email
string

Company email.

Min length1
Max length254
Pattern^[\w.]+@([\w-]+\.)+[\w-]{2,4}$
Examplename@email.com
dateOfBirth
string

Person birth date.

Min length10
Max length10
Pattern^\d{4}-\d{2}-\d{2}$
Example1998-03-17
idNumber
string

Optional identification number that can be the national id, passport or any other id of the person. It's a free string.

Min length1
Max length255
Pattern^[a-zA-Z0-9-]+$
Example25073259Q
taxId
string

Tax id of the company.

Min length1
Max length255
Pattern^[a-zA-Z0-9-]+$
ExampleA12345678
virtualAccount
object

New payment subject virtual account. Only created if a real account id is provided.

accountIdentifiers
Array of object (AccountIdentifier)

List of account identifiers.

Max items3
object
accountId

Account identifier. Type depends on accountIdType.

AnyOf
string (uuid)
string
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
string
string
Min length15
Max length34
Pattern^[A-Z]{2}[0-9A-Z\s]{17,32}$
ExampleGB40PNXT09991100000010
string
string
Min length11
Max length30
Pattern^[0-9A-Z\s]{11,30}$
ExamplePNXT09991100000010
accountIdType
string

Format used for the account number in the accountId property.

The possible values are:

  • IBAN = IBAN code
  • BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
  • UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.

For example:

  • In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
  • In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Valid values[ "iban", "bban", "uuid" ]
Exampleiban
country
string

Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]{2}$
ExampleGB
supplementaryId
string

Account reference for referenced virtual accounts. Unique by customer and real account.

Min length10
Max length10
Pattern^PN[2-9]{4}[A-HJ-KM-NP-Z]{4}$
ExamplePN2345ABCD
legalEntityBic
string

Bic of the legal entity associated with the account.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@.#&+-_ ''""]*$
ExamplePNXTGB2LXXX
realAccountId
string (uuid)

Parent real account 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
customer
object

New payment subject customer. Only returned when a virtual account is created for the payment subject.

id
string

Customer unique id.

Min length1
Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esESB76134758
name
string

Customer company name.

Max length255
Pattern^(?:['_.,&\-\sa-zA-ZÀ-ÿ0-9])+$
ExampleMock Company S.A.
address
string

Customer company address.

Max length255
Pattern^[A-Za-z0-9À-ÖØ-öø-ÿªº&?-©®,."':\s\-{}$^[\]_()+*|\\]*$
Example99 BUSINESS STREET, 28075, LAS PALMAS DE GRAN CANARIA, LAS PALMAS, ES
_links
object

Single links object.

self
object

Self links object.

href
string

Self link.

Max length999
Pattern^(www|http:|https:)+[^\s]+[\w]$
Examplehttps://host/?_offset=0&_limit=10
400

Bad Request

example-1
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "message": "Bad Request",
      "level": "FATAL",
      "description": "Description of the Bad Request error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
401

Unauthorized

example-1
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "FATAL",
      "description": "Description of the Unauthorized error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
403

Forbidden

example-1
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "message": "Forbidden",
      "level": "FATAL",
      "description": "Description of the Forbidden error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
404

Not Found

example-1
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "message": "Not Found",
      "level": "FATAL",
      "description": "Description of the Not Found error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
406

Not Acceptable The Accept header does not specifically contain one of the allowable types. Missing Accept header, usually 'application/json'

example-1
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "message": "Not Acceptable",
      "level": "FATAL",
      "description": "Description of the Not Acceptable error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
413

Request Entity Too Large Most web servers have a limit of 8192 bytes (8 KB). The server will close the connection to prevent the client from continuing the request.

example-1
{
  "errors": [
    {
      "code": "ENTITY_TOO_LARGE",
      "message": "Request Entity Too Large",
      "level": "FATAL",
      "description": "Description of the Request Entity Too Large error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
414

URI Too Long

err414Example
{
  "errors": [
    {
      "code": "URI_TOO_LONG",
      "level": "FATAL",
      "message": "URI Too Long",
      "description": "URI Too Long description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
415

Unsupported Media Type. The requested content type is not supported by the REST service

example-1
{
  "errors": [
    {
      "code": "UNSUPPORTED_MEDIA_TYPE",
      "message": "Unsupported Media Type",
      "level": "FATAL",
      "description": "Description of the Unsupported Media Type error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
422

Unprocessable Entity

err422Example
{
  "errors": [
    {
      "code": "UNPROCESSABLE_ENTITY",
      "level": "FATAL",
      "message": "Unprocessable Entity",
      "description": "Unprocessable Entity description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
429

Too Many Requests

err429Example
{
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "level": "ERROR",
      "message": "Too Many Requests",
      "description": "Too Many Requests description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
500

Internal server error

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

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
503

Service unavailable

err503Example
{
  "errors": [
    {
      "code": "SERVICE_UNAVAILABLE",
      "level": "ERROR",
      "message": "Service unavailable",
      "description": "Service unavailable error description"
    }
  ]
}
healthFailedExample
{
  "errors": [
    {
      "code": "fail",
      "level": "ERROR",
      "message": "Health check failed",
      "description": "Health check failed"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
504

Gateway timeout

err504Example
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT",
      "level": "ERROR",
      "message": "Gateway timeout",
      "description": "Gateway timeout error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription
default

Default error

errDefaultExample
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "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 items0
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

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

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleMessage
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
Pattern^[a-zA-Z0-9. /_-]*$
ExampleDescription