Retrieves a list of collections for a university.

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

Retrieves a list of collections for a specific university.\n\nTo send this request, you must provide a university ID in the request path.\n\nThe collections included in the response can be filtered by university account ID, full or partial collection and student ID, creation date, payment method, and status.\n\nYou can also sort the collections in descending or ascending order by their creation date and return the total amount for all retrieved collections.

Security
OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
universities.readAccessing university 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}$
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.\n\nFewer 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.\n\nThe 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 collections.\n\nThe possible values are:\n- +created_at = Ascending order by creation date\n- -created_at = Descending order by creation date\n\nThe 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 collections to be included in the response.\n\nThe 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.

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

Full or partial collection ID for the collections to be included in the response

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

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

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

Format used for the student ID in the 'student_id' parameter.\n\nThe possible values are:\n- uuid = Internal UUID\n- external = External ID\n\nThe default value is 'uuid'.

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

Whether the student associated with the collections to be included in the response needs to be a full or partial match to the student ID provided in the 'student_id' parameter.\n\nThe possible values are:\n- like = Student ID can be a partial match\n- equal = Student ID must be an exact match

Valid values[ "like", "equal" ]
Default"equal"
Examplelike
from_date
string (date-time)

Start date and time for the period from which collections are to be included in the response, based on their creation date.\n\nThe value uses the data format defined in ISO 8601 and is expressed in UTC time:\n\n'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 collections are to be included in the response, based on their creation date.\n\nThe value uses the data format defined in ISO 8601 and is expressed in UTC time:\n\n'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
payment_method
string

Payment method for the collections to be included in the response.\n\nThe possible values are:\n- EU_TRANSFER = Payment is made through the student's virtual account\n- CREDIT_AND_DEBIT_CARD = Payment is made directly by credit or debit card

Min length1
Max length50
Pattern^[A-zÀ-ú\- ]+(?:['_.\s][A-zÀ-ú]+)*$
ExampleEU_TRANSFER
with_amount
boolean

Whether the total amount for all retrieved collections is to be included in the response.\n\nIf the value is true, the '_amount' element is included in the response.

ExampleTrue
status
string

Status of the collections to be included in the response. The possible values are:

  • IN_PROGRESS = Student has not yet executed the payment
  • COMPLETED = Student has executed the payment, the university has acknowledged receipt of the funds
  • UNMATCHED_AMOUNT = Amount received by the university from the student does not match the collection amount
  • CARD_PAYMENT_SUCCESS = Successful card payment received
  • CARD_PAYMENT_FAILED = Failed card payment received
  • LOCALLY_PAID = Local payment received
  • REJECTED = Money from locally paid collection could not be transferred to final account
  • REFUNDED = The payment has been refunded to the original payment method
Valid values[ "IN_PROGRESS", "COMPLETED", "REJECTED", "LOCALLY_PAID", "UNMATCHED_AMOUNT", "CARD_PAYMENT_SUCCESS", "CARD_PAYMENT_FAILED", "REFUNDED" ]
ExampleIN_PROGRESS
from_expected_amount

Minimum amount to be included in the response. Filters by expected collection amount.\n\nThe value must be greater than or equal to 0.

Example0.5
to_expected_amount

Maximum amount to be included in the response. Filters by expected collection amount.\n\nThe value must be less than or equal to 2147483647.

Example10000
from_received_amount

Minimum amount to be included in the response. Filters by payment amount.\n\nThe value must be greater than or equal to 0

Example0.5
to_received_amount

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

Example10000
_expand
string

Query param (string, split by comma). Hydrates the collection response. Possible values for this query are:

  • card_payment_history
Min length1
Max length255
Pattern^[a-zA-Z_0-9]*$
Examplecard_payment_history
Responses
200

University collections response

GetCollectionsResponse
{
  "data": [
    {
      "id": "9c485e92-9c25-41e2-b6a5-a54381716670",
      "universityId": "pagonxt_esES97452M83D",
      "paymentLinkId": "V1PELwCuelhKCr",
      "isSelfPayed": false,
      "status": "IN_PROGRESS",
      "expectedAmount": "1500",
      "currency": "EUR",
      "originCountryId": "AR",
      "externalPaymentReference": "REF",
      "payment": {
        "amount": "1500",
        "transactionId": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
        "currency": "EUR",
        "valueDate": "2022-03-14T12:00:00.000Z",
        "reference": "123-FDSFEFE",
        "paymentMethod": "EU_TRANSFER",
        "originCountry": "Argentina",
        "cardTransactionId": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
        "merchantOrderNumber": "2507b89c-b680-46df-9505-e0b6f78cf295",
        "refundData": {
          "amount": "1500",
          "transactionId": "693f01e4-9150-4a73-8fe2-ee9843f95123",
          "operationId": "693f01e4-9150-4a73-8fe2-ee9843f95123",
          "currency": "EUR"
        }
      },
      "payer": {
        "id": "f7815b9f-3628-468c-a8ef-8d195ff45768",
        "firstName": "Emanuel David",
        "lastName": "Ginóbili",
        "email": "emanuelgi@nba.com",
        "relationship": "Father",
        "birthDate": "1970-01-01T00:00:00.000Z",
        "residenceCountryId": "ES",
        "nationalityCountryId": "ES",
        "passportNumber": "12312312A",
        "residentId": "12345678A",
        "residentType": "PRC"
      },
      "student": {
        "id": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
        "firstName": "George",
        "lastName": "Washington",
        "externalId": "12345678ABC",
        "iban": "GB59PAGO72899000000081",
        "email": "georgewashington@wh.gov",
        "universityAccountId": "2507b89c-b680-46df-9505-e0b6f78cf333",
        "residentId": "477376197205082595",
        "residentType": "PRC",
        "documentId": "E59659321",
        "documentType": "PASSPORT"
      },
      "cardPaymentHistory": [
        {
          "amount": "1050.5",
          "type": "GETNET",
          "currency": "EUR",
          "cardTransactionId": "59f85645-7021-42a7-b8e7-5db617608da6",
          "merchantOrderNumber": "8294b53b-1171-461b-bb23-ade995a9e348",
          "createdAt": "2023-10-20T13:22:07.450Z",
          "status": "SUCCESS",
          "statuses": [
            {
              "code": "201.0000",
              "severity": "information",
              "description": "3d-acquirer:The resource was successfully created."
            },
            {
              "code": "500.1074",
              "severity": "warning",
              "description": "3d-acquirer:System unavailable: The MPI system is not reachable. The 3-D secure process cannot be verified."
            }
          ]
        }
      ],
      "validInformation": false,
      "conditionsPrivacy": false,
      "reference": "1998II157KAU04660243",
      "expirationDate": "2022-04-14T12:00:00.000Z",
      "createdAt": "2022-03-14T12:00:00.000Z",
      "updatedAt": "2022-03-14T12:00:00.000Z"
    }
  ],
  "_count": "1",
  "_links": {
    "_last": "/universities/9c485e92-9c25-41e2-b6a5-a54381716670/collections?_offset=1&_limit=1&_sort=-created_at",
    "_next": "/universities/9c485e92-9c25-41e2-b6a5-a54381716670/collections?_offset=1&_limit=1&_sort=-created_at"
  }
}
GetCollectionsQueryWithAmountResponse
{
  "data": [
    {
      "id": "9c485e92-9c25-41e2-b6a5-a54381716670",
      "universityId": "pagonxt_esES97452M83D",
      "paymentLinkId": "V1PELwCuelhKCr",
      "isSelfPayed": false,
      "status": "IN_PROGRESS",
      "expectedAmount": "1500",
      "currency": "EUR",
      "originCountryId": "AR",
      "externalPaymentReference": "REF",
      "payment": {
        "amount": "1500",
        "transactionId": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
        "reference": "123-FDSFEFE",
        "valueDate": "2022-03-14T12:00:00.000Z",
        "currency": "EUR",
        "paymentMethod": "EU_TRANSFER",
        "originCountry": "Argentina",
        "cardTransactionId": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
        "merchantOrderNumber": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
        "refundData": {
          "amount": "1500",
          "transactionId": "693f01e4-9150-4a73-8fe2-ee9843f95123",
          "operationId": "693f01e4-9150-4a73-8fe2-ee9843f95123",
          "currency": "EUR"
        }
      },
      "payer": {
        "id": "f7815b9f-3628-468c-a8ef-8d195ff45768",
        "firstName": "Emanuel David",
        "lastName": "Ginóbili",
        "email": "emanuelgi@nba.com",
        "relationship": "Father",
        "birthDate": "1970-01-01T00:00:00.000Z",
        "residenceCountryId": "ES",
        "nationalityCountryId": "ES",
        "passportNumber": "12312312A",
        "residentId": "12312312A",
        "residentType": "PRC"
      },
      "student": {
        "id": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
        "firstName": "George",
        "lastName": "Washington",
        "externalId": "12345678ABC",
        "iban": "GB59PAGO72899000000081",
        "email": "georgewashington@wh.gov",
        "universityAccountId": "2507b89c-b680-46df-9505-e0b6f78cf333",
        "residentId": "477376197205082595",
        "residentType": "PRC",
        "documentId": "E59659321",
        "documentType": "PASSPORT"
      },
      "cardPaymentHistory": [
        {
          "amount": "1050.5",
          "type": "GETNET",
          "currency": "EUR",
          "cardTransactionId": "59f85645-7021-42a7-b8e7-5db617608da6",
          "merchantOrderNumber": "8294b53b-1171-461b-bb23-ade995a9e348",
          "createdAt": "2023-10-20T13:22:07.450Z",
          "status": "SUCCESS",
          "statuses": [
            {
              "code": "201.0000",
              "severity": "information",
              "description": "3d-acquirer:The resource was successfully created."
            },
            {
              "code": "500.1074",
              "severity": "warning",
              "description": "3d-acquirer:System unavailable: The MPI system is not reachable. The 3-D secure process cannot be verified."
            }
          ]
        }
      ],
      "validInformation": false,
      "conditionsPrivacy": false,
      "reference": "1998II157KAU04660243",
      "expirationDate": "2022-04-14T12:00:00.000Z",
      "createdAt": "2022-03-14T12:00:00.000Z",
      "updatedAt": "2022-03-14T12:00:00.000Z"
    }
  ],
  "_count": "1",
  "_links": {
    "_last": "/universities/9c485e92-9c25-41e2-b6a5-a54381716670/collections?with_amount=true&_offset=1&_limit=1&_sort=-created_at",
    "_next": "/universities/9c485e92-9c25-41e2-b6a5-a54381716670/collections?with_amount=true&_offset=1&_limit=1&_sort=-created_at"
  },
  "_amount": "1500"
}
Expand All
object

UniversityCollectionsListResponse schema

data
Array of object (Collection)

data list

Max items255
object

University collection

id
string (uuid)

Unique collection ID generated by One Trade

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

University ID.\n\nThe value is the university ID used in the request path.

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

Unique payment link ID generated by One Trade

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

Expected total amount to be payed

Minimum0
Maximum999999999
Example13000
currency
string

Currency code.\n\nThe 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
originCountryId
string

Country code of the account identifier 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-zA-Z]{2}$)$
ExampleGB
externalPaymentReference
string

Unique ID

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

Data structure containing details of the related received payment

amount
number (float)

Amount

Minimum0
Maximum999999999
Example13000
transactionId
string

Unique identifier generated by One Trade for the received payment.

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

Currency code.\n\nThe 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
reference
string | null

Reference of payment

Min length1
Max length100
Pattern^[a-zA-Z0-9\-_]*$
ExampleTEST-1663143819043
valueDate
string (date-time) | null

Date of the payment

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
paymentMethod
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
cardTransactionId
string

Unique identifier generated by the card payment processor for the received card payment. Only applicable to collections with payment type VISA_MASTERCARD.

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

Unique identifier supplied by the merchant for the card payment. Only applicable to collections with payment type VISA_MASTERCARD.

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

Country where the account from which the payment is made is located

Min length1
Max length50
Pattern^[A-zÀ-ú\- ]+(?:['_.\s][A-zÀ-ú]+)*$
ExampleSpain
refundData
object

Refund transaction data

amount
number (float)

Amount

Minimum0
Maximum999999999
Example13000
transactionId
string

Unique identifier generated by One Trade for the received payment.

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

Unique identifier generated by One Trade for the collection refund operation.

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

Currency code.\n\nThe 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
isSelfPayed
boolean

Whether the collection is paid by the student

ExampleFalse
status
string

The possible values are:

  • IN_PROGRESS = Student has not yet executed the payment
  • COMPLETED = Student has executed the payment, the university has acknowledged receipt of the funds
  • UNMATCHED_AMOUNT = Amount received by the university from the student does not match the collection amount
  • CARD_PAYMENT_SUCCESS = Successful card payment received
  • CARD_PAYMENT_FAILED = Failed card payment received
  • LOCALLY_PAID = Local payment received
  • REJECTED = Money from locally paid collection could not be transferred to final account
  • REFUNDED = The payment has been refunded to the original payment method
Valid values[ "IN_PROGRESS", "COMPLETED", "REJECTED", "LOCALLY_PAID", "UNMATCHED_AMOUNT", "CARD_PAYMENT_SUCCESS", "CARD_PAYMENT_FAILED", "REFUNDED" ]
ExampleIN_PROGRESS
payer
object

Data structure containing payer details

id
string (uuid)

Unique payer ID generated by One Trade

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

Payer's first name

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleRamón García
lastName
string

Payer's last name

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleRamón García
email
string (email)

Payer's email address

Max length50
Pattern^\S+@\S+\.\S+$
Examplegwpresi@yahoo.com
relationship
string

Relationship with student

Min length1
Max length50
Pattern^[a-zA-Z\s]*$
ExampleFather
birthDate
string (date-time)

Date of birth

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$
Example1970-01-01T00:00:00Z
residenceCountryId
string

Country code of the account identifier 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-zA-Z]{2}$)$
ExampleGB
nationalityCountryId
string

Country code of the account identifier 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-zA-Z]{2}$)$
ExampleGB
passportNumber
string | null

Passport identification

Max length50
Pattern^[A-z0-9]{6,9}$
ExampleE59659321
residentId
string | null

Resident identifier

Max length50
Pattern[\s\S\d]
Example477376197205082595
residentType
string | null

The possible values are:

  • PRC People's Republic of China Foreign Permanent Resident ID Card
Valid values[ "PRC" ]
ExamplePRC
student
object

Data structure containing student details

id
string (uuid)

Unique student ID generated by One Trade

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

Student's first name

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleRamón García
lastName
string

Student's last name

Max length50
Pattern^(?:[_.,&\-\sa-zA-ZÀ-ÿ\u00f1\u00d1])+$
ExampleRamón García
externalId
string

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

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

IBAN of the virtual account that has been automatically generated and assigned to the student.\n\nThe student makes payments for their course to the university into this account.

Max length50
Pattern^[0-9A-Z\s]*$
ExampleBR1800360305000010009795493C1
email
string (email)

Student's email address

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

Related university e-money account's internal account ID.

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
residentId
string | null

Resident identifier

Max length50
Pattern[\s\S\d]
Example477376197205082595
residentType
string | null

The possible values are:

  • PRC People's Republic of China Foreign Permanent Resident ID Card
Valid values[ "PRC" ]
ExamplePRC
documentId
string | null

Resident identifier

Max length50
Pattern[\s\S\d]
Example477376197205082595
documentType
string | null

The possible values are:

  • DNI Spanish national identity document
  • PASSPORT
Valid values[ "DNI", "PASSPORT" ]
ExamplePASSPORT
validInformation
boolean

Whether the student has confirmed on the payment form that the information provided is valid

ExampleFalse
cardPaymentHistory
Array of object (CardPaymentHistory)

Card payment tracking history

Max items10
object

Data structure containing card payment history details

amount
number (float)

Amount

Minimum0
Maximum999999999
Example13000
type
string

Card payment providers

Valid values[ "GETNET" ]
Default"GETNET"
ExampleGETNET
currency
string

Currency code.\n\nThe 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
cardTransactionId
string (uuid)

Universally unique ID

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
merchantOrderNumber
string (uuid)

Universally unique ID

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
createdAt
string (date-time)

Date and time when the collection was created.\n\nThe value uses the data format defined in ISO 8601 and is expressed in UTC time:\n\n'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
status
string

Card payment status

Valid values[ "IN_PROGRESS", "SUCCESS", "FAILED" ]
Default"SUCCESS"
ExampleSUCCESS
statuses
Array of object (CardPaymentProviderStatus)

Array of payment statuses

Max items50
object

Data structure containing provider payment status

code
string

Generic text

Max length255
Pattern^[a-zA-Z0-9\-_. :,]*$
Example2001.0000
severity
string

Generic text

Max length255
Pattern^[a-zA-Z0-9\-_. :,]*$
Example2001.0000
description
string

Generic text

Max length255
Pattern^[a-zA-Z0-9\-_. :,]*$
Example2001.0000
conditionsPrivacy
boolean

Whether the student has accepted the privacy conditions on the payment form

ExampleFalse
reference
string | null

Algorithm based reference for bank transfers in Mexico

Min length1
Max length50
Pattern^[a-zA-Z0-9\-_]*$
Example1998II157KAU04660243
expirationDate
string (date-time)

Expiration date 1 month set by default from the date of creation

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
createdAt
string (date-time)

Date and time when the collection was created.\n\nThe value uses the data format defined in ISO 8601 and is expressed in UTC time:\n\n'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 collection was updated.\n\nThe value uses the data format defined in ISO 8601 and is expressed in UTC time:\n\n'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

_first
string

Link to the first page of the list.\n\nThe exact value depends on the data to be accessed.\n\nThe 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/collections?_offset=0&_limit=10
_last
string

Link to the last page of the list.\n\nThe exact value depends on the data to be accessed.\n\nThe 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/collections?_offset=10&_limit=10
_prev
string

Link to the previous page of the list.\n\nThe exact value depends on the data to be accessed.\n\nThe 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/collections?_offset=30&_limit=10
_next
string

Link to the next page of the list.\n\nThe exact value depends on the data to be accessed.\n\nThe 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/collections?_offset=40&_limit=10
_amount
number (double)

Amount of the filtered collections

Minimum-999999999
Maximum999999999
Example99.99
string (binary)
Max length9000000
ExampleSystem.Byte[]
string (binary)
Max length9000000
ExampleSystem.Byte[]
204

No content

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

err401Example
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "ERROR",
      "description": "Unauthorized 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
403

Forbidden

err403Example
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "level": "FATAL",
      "message": "Forbidden",
      "description": "Forbidden 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
404

Not found

err404Example
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "level": "FATAL",
      "message": "Not Found",
      "description": "Not Found 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
406

Not Acceptable

err406Example
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "level": "FATAL",
      "message": "Not Acceptable",
      "description": "Not Acceptable 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
413

Payload Too Large

err413Example
{
  "errors": [
    {
      "code": "PAYLOAD_TOO_LARGE",
      "level": "FATAL",
      "message": "Payload Too Large",
      "description": "Payload Too Large 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
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
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