Retrieves a list of payment links for a university.

  • Published on Feb 20, 2025
  • 15 minute(s) read
Prev Next
Get
/universities/{university_id}/payment_links

Retrieves a list of payment links for a specific university.

To send this request, you must provide a university ID in the request path.

The payment links included in the response can be filtered by university account ID, full or partial student ID, student name, creation and expiration date, payment amount, and status.

You can also sort the payment links in descending or ascending order by their creation date.

Security
OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
universities.readAccessing universities information
Header parameters
x-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
university_id
stringRequired

University ID to be used in the query

Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esES97452M83D
Query parameters
_limit
integer (int32)

Maximum number of rows to be included on each page in the response.

Fewer rows can be returned, if the query does not yield that many.

Minimum0
Maximum100
Example50
_offset
integer (int32)

Pagination identifier that is returned to the app by the API response when this uses the HATEOAS '_prev' or '_next' links.

The app can navigate from the last returned page to the next or previous page, or to the first page if no offset is specified, but to no other pages.

Minimum0
Maximum100
Example2
_sort
string

Sorting order for the retrieved payment links.

The possible values are:

  • +created_at = Ascending order by creation date
  • -created_at = Descending order by creation date

The default value is '-created_at'.

Valid values[ "+created_at", "-created_at" ]
Default"-created_at"
Example+created_at
university_account_id
string (uuid)

University account ID associated with the payment links to be included in the response.

The university account ID represents an account created within the One Trade system that is associated with a university. A university can have multiple accounts within the One Trade system.

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}$
Exampled317d060-0d41-43ec-ba43-e47e8a25aa5b
student_id
string (uuid)

Full or partial student ID associated with the payment links to be included in the response, in the format defined in the 'student_id_type' parameter

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}$
Exampled317d060-0d41-43ec-ba43-e47e8a25aa5b
student_id_type
string

Format used for the student ID in the 'student_id' parameter.

The possible values are:

  • uuid = Internal UUID
  • external = External ID

The default value is 'uuid'.

Valid values[ "uuid", "external" ]
Default"uuid"
Exampleuuid
student_id_operator
string

Whether the student associated with the payment links to be included in the response needs to be a full or partial match to the student ID provided in the 'student_id' parameter.

The possible values are:

  • like = Student ID can be a partial match
  • equal = Student ID must be an exact match
Valid values[ "like", "equal" ]
Default"equal"
Examplelike
student_name
string

Student full name associated with the payment links to be included in the response.

The filtering performed by this parameter is not case sensitive.

Min length1
Max length50
Pattern^[A-zÀ-ú\- ]+(?:['_.\s][A-zÀ-ú]+)*$
ExampleSusana Horia
status
string

Status of the payment links to be included in the response

Valid values[ "GENERATED", "EXPIRED", "COMPLETED", "CANCELLED" ]
ExampleGENERATED
from_expiration_date
string (date-time)

Start date and time for the period from which payment links are to be included in the response, based on their expiration date.

The value uses the data format defined in ISO 8601 and is expressed in UTC time:

'YYYY-MM-DDThh:mm:ss.sssZ'

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*$
Example2022-03-17T10:02:03.482Z
to_expiration_date
string (date-time)

End date and time for the period from which payment links are to be included in the response, based on their expiration date.

The value uses the data format defined in ISO 8601 and is expressed in UTC time:

'YYYY-MM-DDThh:mm:ss.sssZ'

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*$
Example2022-03-17T10:02:03.482Z
from_date
string (date-time)

Start date and time for the period from which payment links are to be included in the response, based on their creation date.

The value uses the data format defined in ISO 8601 and is expressed in UTC time:

'YYYY-MM-DDThh:mm:ss.sssZ'

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*$
Example2022-03-17T10:02:03.482Z
to_date
string (date-time)

End date and time for the period from which payment links are to be included in the response, based on their creation date.

The value uses the data format defined in ISO 8601 and is expressed in UTC time:

'YYYY-MM-DDThh:mm:ss.sssZ'

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*$
Example2022-03-17T10:02:03.482Z
from_amount
number (float)

Minimum payment amount of the payment links to be included in the response.

The value must be greater than or equal to 1.

Minimum-2147483647
Maximum2147483647
Example1
to_amount
number (float)

Maximum payment amount of the payment links to be included in the response.\n\nThe value must be less than or equal to 2147483647.

Minimum-2147483647
Maximum2147483647
Example10000
Responses
200

OK

PaymentLinksResponse
{
  "data": [
    {
      "id": "V1PELwCuelhKCr",
      "amount": "250",
      "currency": "EUR",
      "universityAccountId": "a215e160-0c33-45ea-ca23-d37a5a215aa5",
      "studentId": "b515c155-0a24-22ae-ca11-a22d5a247ab8",
      "studentIdNumber": "123456789R",
      "studentFirstName": "George",
      "studentLastName": "Washington",
      "studentEmail": "gwpresi@yahoo.com",
      "studentExternalId": "9c485e92-9c25-41e2-b6a5-a5481716670b",
      "studentResidenceCountry": "ES",
      "studentNationalityCountry": "ES",
      "concept": "Course fees",
      "status": "GENERATED",
      "url": "http://pagonx.com/?id=V1PELwCuelhKCr",
      "expirationDate": "2022-03-17T10:02:03.482Z",
      "collectionId": "45dfb355-9a1f-4a37-90b0-1a727700dab1",
      "paymentMethods": [
        "EU_TRANSFER",
        "VISA_MASTERCARD"
      ],
      "availablePaymentMethods": [
        {
          "code": "EU_TRANSFER",
          "countries": []
        },
        {
          "code": "LOCAL_TRANSFER",
          "countries": [
            "MX"
          ]
        }
      ],
      "successCallback": "https://pagonext.com/university/success",
      "failureCallback": "https://pagonext.com/university/failure",
      "recurrentAmount": "0",
      "externalPaymentReference": "externalRef",
      "createdAt": "2022-01-10T12:14:13.182Z",
      "updatedAt": "2022-01-17T10:02:03.482Z"
    }
  ],
  "_count": "1",
  "_links": {
    "_first": "/?_offset=0&_limit=10",
    "_last": "/?_offset=0&_limit=10"
  }
}
Expand All
object

Response to a request to retrieve a list of payment links

data
Array of object (PaymentLink)

Array of payment links

Max items255
object

Data structure containing payment link details. AvailablePaymentMethods key will be always returned when you get a payment link by id. It will be available in the future by and expand in the get payment link list EP, but currently is not available when getting all payment links

id
string

Unique payment link ID generated by One Trade

Min length14
Max length14
Pattern^[a-zA-Z0-9-]*$
ExampleV1PELwCuelhKCr
amount
number (float)

Amount

Minimum-2147483647
Maximum2147483647
Example25.5
currency
string

Currency code.

The value is in the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]{3}$
ExampleEUR
universityAccountId
string (uuid)

University account ID.

The university account ID represents an account created within the One Trade system that is associated with a university. A university can have multiple accounts within the One Trade system.

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}$
Exampled317d060-0d41-43ec-ba43-e47e8a25aa5b
studentId
string (uuid)

Unique student ID generated by One Trade. They must be of type EXTENDED, with all its required fields, before a payment link can be made for them.

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}$
Exampled317d060-0d41-43ec-ba43-e47e8a25aa5b
studentIdNumber
string

Unique ID

Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esES97452M83D
studentFirstName
string

Student's first name

Min length0
Max length50
Pattern^[a-zA-ZÀ-ÿ\u00f1\u00d1]+(\s*[a-zA-ZÀ-ÿ\u00f1\u00d1]*)*[a-zA-ZÀ-ÿ\u00f1\u00d1]+$
ExampleFernández
studentLastName
string

Student's last name

Min length0
Max length50
Pattern^[a-zA-ZÀ-ÿ\u00f1\u00d1]+(\s*[a-zA-ZÀ-ÿ\u00f1\u00d1]*)*[a-zA-ZÀ-ÿ\u00f1\u00d1]+$
ExampleFernández
studentEmail
string (email)

Student's email address

Max length76
Pattern^\S+@\S+\.\S+$
Examplegwpresi@yahoo.com
studentExternalId
string (uuid)

Student's external ID used to identify the student in the university system

Max length36
Pattern^[a-zA-Z0-9-]*$
Example9c485e92-9c25-41e2-b6a5-a54381716670
studentResidenceCountry
string

Country code for the country where the student resides.

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

Country code for the country of which the student is a citizen.

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

Payment purpose

Max length50
Pattern^[a-zA-Z0-9 /?:()., +-]*$
ExampleCourse fees
status
string

Payment link status.

The possible values are:

  • GENERATED = Payment link has been created but has not yet been used to make a payment
  • EXPIRED = Payment link has not been used to make a payment and its expiration date has passed
  • COMPLETED = Payment link has been used to make a payment.
  • CANCELLED = Payment link has been cancelled and cannot been used to make a payment
Valid values[ "GENERATED", "EXPIRED", "COMPLETED", "CANCELLED" ]
ExampleGENERATED
url
string

Payment link URL to be sent to the student

Max length2048
Pattern^(www|http:|https:)+[^\s]+[\w]$
Examplehttp://pagonx.com/?id=V1PELwCuelhKCr
expirationDate
string (date-time)

Date and time when the payment link expires.

The value uses the data format defined in ISO 8601 and is expressed in UTC time:

'YYYY-MM-DDThh:mm:ss.sssZ'

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*$
Example2022-03-17T10:02:03.482Z
collectionId
string (uuid)

Unique ID of the collection associated with the payment link. Applies only when the value of 'status' is 'COMPLETED'.

The value can be used in requests to the EMoney Universities Collection Management API to view the status of the payment represented by the collection.

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}$
Exampled317d060-0d41-43ec-ba43-e47e8a25aa5b
paymentMethods
Array of string (PaymentMethodName)

Payment methods for payment link

Min items1
Max items255
string

Payment method name. Each payment method must be enabled for the client if you want to use it.

Valid values[ "EU_TRANSFER", "VISA_MASTERCARD", "LOCAL_TRANSFER", "CARD_RECURRENT" ]
ExampleEU_TRANSFER
availablePaymentMethods
Array of object (PaymentMethodCountries)

Available payment methods and origin countries available for a payment link

Min items1
Max items255
object

Payment method with all allowed countries

code
string

Payment method name. Each payment method must be enabled for the client if you want to use it.

Valid values[ "EU_TRANSFER", "VISA_MASTERCARD", "LOCAL_TRANSFER", "CARD_RECURRENT" ]
ExampleEU_TRANSFER
countries
Array of string (CountryCode)

Array of countries

Min items0
Max items195
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
successCallback
string

It is a URL for redirection in case the payment is positive or negative to an address set by the university itself when the payment link is created

Max length999
Pattern^((https?|HTTPS?):\/\/)[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(\/[a-zA-Z0-9\\/?:.;,@!"$()'+=#&%_-]*)?$
Examplehttps://pagonext.com/university/redirection
failureCallback
string

It is a URL for redirection in case the payment is positive or negative to an address set by the university itself when the payment link is created

Max length999
Pattern^((https?|HTTPS?):\/\/)[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(\/[a-zA-Z0-9\\/?:.;,@!"$()'+=#&%_-]*)?$
Examplehttps://pagonext.com/university/redirection
recurrentAmount
number (float)

When making a recurrent payment, this is the first payment amount. If 0, first payment will only be an authorization without any charge. Must be less than amount

Minimum-2147483647
Maximum2147483647
Example25.5
externalPaymentReference
string

Unique ID

Max length50
Pattern^[a-zA-Z0-9\-_]*$
Examplepagonxt_esES97452M83D
createdAt
string (date-time)

Date and time when the payment link was created.

The value uses the data format defined in ISO 8601 and is expressed in UTC time:

'YYYY-MM-DDThh:mm:ss.sssZ'

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*$
Example2022-03-17T10:02:03.482Z
updatedAt
string (date-time)

Date and time when the payment link was updated.

The value uses the data format defined in ISO 8601 and is expressed in UTC time:

'YYYY-MM-DDThh:mm:ss.sssZ'

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*$
Example2022-03-17T10:02:03.482Z
_count
integer (int32)

Number of records in the list

Minimum0
Maximum999
Example10
_links
object (_Links)

Data structure containing the links for moving between the list pages

_self
string

Link to self page

Max length999
Pattern^[a-zA-Z0-9 _&-\/?=]*$
Example/emoney_uni_mktpls_platform/universities/pagonxt_esesdef456456/payment_links/zlvomtx3heeyps
_first
string

Link to the first page of the list.

The exact value depends on the data to be accessed.

The exact content of the page depends on the input parameters provided in the request, such as the offset.

Max length999
Pattern^[a-zA-Z0-9 _&-\/?=]*$
Example/?_offset=0&_limit=10
_last
string

Link to the last page of the list.

The exact value depends on the data to be accessed.

The exact content of the page depends on the input parameters provided in the request, such as the offset.

Max length999
Pattern^[a-zA-Z0-9 _&-\/?=]*$
Example/?_offset=10&_limit=10
_prev
string

Link to the previous page of the list.

The exact value depends on the data to be accessed.

The exact content of the page depends on the input parameters provided in the request, such as the offset.

Max length999
Pattern^[a-zA-Z0-9 _&-\/?=]*$
Example/?_offset=30&_limit=10
_next
string

Link to the next page of the list.

The exact value depends on the data to be accessed.

The exact content of the page depends on the input parameters provided in the request, such as the offset.

Max length999
Pattern^[a-zA-Z0-9 _&-\/?=]*$
Example/?_offset=40&_limit=10
204

No content

400

Bad request

Error400Example
{
  "errors": [
    {
      "code": "400",
      "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 ]*$
ExampleCode
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

Error401Example
{
  "errors": [
    {
      "code": "401",
      "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 ]*$
ExampleCode
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

Error403Example
{
  "errors": [
    {
      "code": "403",
      "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 ]*$
ExampleCode
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

Error404Example
{
  "errors": [
    {
      "code": "404",
      "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 ]*$
ExampleCode
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 parameter is missing or does not contain one of the allowable types, for example, 'application/json'.

Error406Example
{
  "errors": [
    {
      "code": "406",
      "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 ]*$
ExampleCode
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

Payload too large.

Most web servers have a limit of 8192 bytes (8KB) for a request object. If the object is larger, the server closes the connection to prevent the client from continuing with the request.

Error413Example
{
  "errors": [
    {
      "code": "413",
      "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 ]*$
ExampleCode
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.

The request URI is longer than 2000 chars.

Error414Example
{
  "errors": [
    {
      "code": "414",
      "message": "URI Too Long",
      "level": "FATAL",
      "description": "Description of the URI Too Long 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 ]*$
ExampleCode
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

example-1
{
  "errors": [
    {
      "code": "422",
      "message": "Unprocessable Entity",
      "level": "FATAL",
      "description": "Description of the Unprocessable Entity 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 ]*$
ExampleCode
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

Error429Example
{
  "errors": [
    {
      "code": "429",
      "message": "Too Many Requests",
      "level": "FATAL",
      "description": "Description of the Too Many Requests 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 ]*$
ExampleCode
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

Error500Example
{
  "errors": [
    {
      "code": "500",
      "message": "Internal Server Error",
      "level": "FATAL",
      "description": "Description of the Internal Server Error 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 ]*$
ExampleCode
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

Error503Example
{
  "errors": [
    {
      "code": "503",
      "message": "Service Unavailable",
      "level": "ERROR",
      "description": "Description of the Service Unavailable 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 ]*$
ExampleCode
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

Error504Example
{
  "errors": [
    {
      "code": "504",
      "message": "Gateway Timeout",
      "level": "ERROR",
      "description": "Description of the Gateway Timeout 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 ]*$
ExampleCode
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

Error404Example
{
  "errors": [
    {
      "code": "404",
      "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 ]*$
ExampleCode
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