Retrieves the details of a specific collection for a university.\n\nTo send this request, you must provide a university ID and collection ID in the request path.
OAuth Grant type, Private JWT
Client ID header
University ID to be used in the query
Collection ID to be used in the query
Query param (string, split by comma). Hydrates the collection response. Possible values for this query are:
card_payment_history
Collection response
{
"data": {
"id": "2507b89c-b680-46df-9505-e0b6f78cf295",
"universityId": "pagonxt_esES97452M83D",
"paymentLinkId": "V1PELwCuelhKCr",
"expectedAmount": "20",
"currency": "EUR",
"originCountryId": "AR",
"externalPaymentReference": "REF",
"payment": {
"amount": "20",
"transactionId": "693f01e4-9150-4a73-8fe2-ee9843f9535e",
"currency": "EUR",
"reference": "TEST-1663143819043",
"valueDate": "2022-03-17T10:02:03.482Z",
"paymentMethod": "EU_TRANSFER",
"cardTransactionId": "2507b89c-b680-46df-9505-e0b6f78cf295",
"merchantOrderNumber": "2507b89c-b680-46df-9505-e0b6f78cf295",
"refundData": {
"amount": "1500",
"transactionId": "693f01e4-9150-4a73-8fe2-ee9843f95123",
"operationId": "693f01e4-9150-4a73-8fe2-ee9843f95123",
"currency": "EUR"
},
"originCountry": "Spain"
},
"isSelfPayed": false,
"status": "IN_PROGRESS",
"payer": {
"id": "2507b89c-b680-46df-9505-e0b6f78cf295",
"firstName": "Jeff",
"lastName": "Bezos",
"email": "gwpresi@yahoo.com",
"relationship": "Father",
"birthDate": "1970-01-01T00:00:00.000Z",
"residenceCountryId": "GB",
"nationalityCountryId": "GB",
"passportNumber": "12345678A",
"residentId": "12345678A",
"residentType": "PRC"
},
"student": {
"id": "2507b89c-b680-46df-9505-e0b6f78cf295",
"firstName": "George",
"lastName": "Washington",
"externalId": "12345678ABC",
"iban": "BR1800360305000010009795493C1",
"email": "gwpresi@yahoo.com",
"universityAccountId": "2507b89c-b680-46df-9505-e0b6f78cf295",
"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-03-17T10:02:03.482Z",
"createdAt": "2022-03-17T10:02:03.482Z",
"updatedAt": "2022-03-17T10:02:03.482Z",
"statusHistory": [
{
"id": "2507b89c-b680-46df-9505-e0b6f78cf295",
"status": "IN_PROGRESS",
"date": "2022-03-17T10:02:03.482Z"
}
]
}
}CollectionDetailResponse
Data structure containing collection details
Unique collection ID generated by One Trade
University ID.\n\nThe value is the university ID used in the request path.
Unique payment link ID generated by One Trade
Expected total amount to be payed
Currency code.\n\nThe value is in the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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/).'
Unique ID
Data structure containing details of the related received payment
Amount
Unique identifier generated by One Trade for the received payment.
Currency code.\n\nThe value is in the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Reference of payment
Date of the payment
Payment method name. Each payment method must be enabled for the client if you want to use it.
Unique identifier generated by the card payment processor for the received card payment. Only applicable to collections with payment type VISA_MASTERCARD.
Unique identifier supplied by the merchant for the card payment. Only applicable to collections with payment type VISA_MASTERCARD.
Country where the account from which the payment is made is located
Refund transaction data
Amount
Unique identifier generated by One Trade for the received payment.
Unique identifier generated by One Trade for the collection refund operation.
Currency code.\n\nThe value is in the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Whether the collection is paid by the student
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
Data structure containing payer details
Unique payer ID generated by One Trade
Payer's first name
Payer's last name
Payer's email address
Relationship with student
Date of birth
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/).'
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/).'
Passport identification
Resident identifier
The possible values are:
- PRC People's Republic of China Foreign Permanent Resident ID Card
Data structure containing student details
Unique student ID generated by One Trade
Student's first name
Student's last name
Student's external ID used to identify the student in the university system
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.
Student's email address
Related university e-money account's internal account ID.
Resident identifier
The possible values are:
- PRC People's Republic of China Foreign Permanent Resident ID Card
Resident identifier
The possible values are:
- DNI Spanish national identity document
- PASSPORT
Whether the student has confirmed on the payment form that the information provided is valid
Card payment tracking history
Data structure containing card payment history details
Amount
Card payment providers
Currency code.\n\nThe value is in the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Universally unique ID
Universally unique ID
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'
Card payment status
Array of payment statuses
Data structure containing provider payment status
Generic text
Generic text
Generic text
Whether the student has accepted the privacy conditions on the payment form
Algorithm based reference for bank transfers in Mexico
Expiration date 1 month set by default from the date of creation
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'
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'
Array of status changes
Data structure containing status change details
Universally unique ID
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
Date and time when the collection status was changed.\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'
No content
Bad request
{
"errors": [
{
"code": "BAD_REQUEST",
"level": "FATAL",
"message": "Bad Request",
"description": "Error validating schema"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"message": "Unauthorized",
"level": "ERROR",
"description": "Unauthorized description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Forbidden
{
"errors": [
{
"code": "FORBIDDEN",
"level": "FATAL",
"message": "Forbidden",
"description": "Forbidden description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Not found
{
"errors": [
{
"code": "NOT_FOUND",
"level": "FATAL",
"message": "Not Found",
"description": "Not Found description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Not Acceptable
{
"errors": [
{
"code": "NOT_ACCEPTABLE",
"level": "FATAL",
"message": "Not Acceptable",
"description": "Not Acceptable description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Payload Too Large
{
"errors": [
{
"code": "PAYLOAD_TOO_LARGE",
"level": "FATAL",
"message": "Payload Too Large",
"description": "Payload Too Large description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
URI Too Long
{
"errors": [
{
"code": "URI_TOO_LONG",
"level": "FATAL",
"message": "URI Too Long",
"description": "URI Too Long description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Unprocessable Entity
{
"errors": [
{
"code": "UNPROCESSABLE_ENTITY",
"level": "FATAL",
"message": "Unprocessable Entity",
"description": "Unprocessable Entity description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Too Many Requests
{
"errors": [
{
"code": "TOO_MANY_REQUESTS",
"level": "ERROR",
"message": "Too Many Requests",
"description": "Too Many Requests description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Internal server error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"level": "FATAL",
"message": "Internal server error",
"description": "Internal server error description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Service unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"level": "ERROR",
"message": "Service unavailable",
"description": "Service unavailable error description"
}
]
}{
"errors": [
{
"code": "fail",
"level": "ERROR",
"message": "Health check failed",
"description": "Health check failed"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Gateway timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"level": "ERROR",
"message": "Gateway timeout",
"description": "Gateway timeout error description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue
Default error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"level": "FATAL",
"message": "Error message",
"description": "Error description"
}
]
}Data structure containing the details for errors
Array of errors
Data structure containing the error details
Unique alphanumeric human readable error code
Brief summary of the reported issue
Level of the reported issue. The possible values are.
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue