Retrieves the details of a specific payment link for a university.
To send this request, you must provide a university ID and payment link ID in the request path.
OAuth Grant type, Private JWT
Client ID header
University ID to be used in the query
Payment link ID to be used in the query
Response, depending on the request type:
- For a GET or PATCH request, '200 OK'
- For a POST request, '201 Created'
{
"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": "COMPLETED",
"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"
},
"_links": {
"_self": "/emoney_uni_mktpls_platform/universities/universityId/payment_links/V1PELwCuelhKCr"
}
}Response to a request to create or retrieve a payment link
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
Unique payment link ID generated by One Trade
Amount
Currency code.
The value is in the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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.
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.
Unique ID
Student's first name
Student's last name
Student's email address
Student's external ID used to identify the student in the university system
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/).
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/).
Payment purpose
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
Payment link URL to be sent to the student
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'
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.
Payment methods for payment link
Payment method name. Each payment method must be enabled for the client if you want to use it.
Available payment methods and origin countries available for a payment link
Payment method with all allowed countries
Payment method name. Each payment method must be enabled for the client if you want to use it.
Array of countries
Country code.
The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).
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
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
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
Unique ID
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'
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'
Data structure containing the links for moving between the list pages
Link to self page
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.
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.
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.
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.
No content
Bad request
{
"errors": [
{
"code": "400",
"message": "Bad Request",
"level": "FATAL",
"description": "Description of the Bad Request error"
}
]
}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": "401",
"message": "Unauthorized",
"level": "FATAL",
"description": "Description of the Unauthorized error"
}
]
}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": "403",
"message": "Forbidden",
"level": "FATAL",
"description": "Description of the Forbidden error"
}
]
}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": "404",
"message": "Not Found",
"level": "FATAL",
"description": "Description of the Not Found error"
}
]
}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.
The 'Accept' header parameter is missing or does not contain one of the allowable types, for example, 'application/json'.
{
"errors": [
{
"code": "406",
"message": "Not Acceptable",
"level": "FATAL",
"description": "Description of the Not Acceptable error"
}
]
}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.
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.
{
"errors": [
{
"code": "413",
"message": "Request Entity Too Large",
"level": "FATAL",
"description": "Description of the Request Entity Too Large error"
}
]
}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.
The request URI is longer than 2000 chars.
{
"errors": [
{
"code": "414",
"message": "URI Too Long",
"level": "FATAL",
"description": "Description of the URI Too Long error"
}
]
}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": "422",
"message": "Unprocessable Entity",
"level": "FATAL",
"description": "Description of the Unprocessable Entity error"
}
]
}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": "429",
"message": "Too Many Requests",
"level": "FATAL",
"description": "Description of the Too Many Requests error"
}
]
}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": "500",
"message": "Internal Server Error",
"level": "FATAL",
"description": "Description of the Internal Server Error error"
}
]
}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": "503",
"message": "Service Unavailable",
"level": "ERROR",
"description": "Description of the Service Unavailable error"
}
]
}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": "504",
"message": "Gateway Timeout",
"level": "ERROR",
"description": "Description of the Gateway Timeout error"
}
]
}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": "404",
"message": "Not Found",
"level": "FATAL",
"description": "Description of the Not Found error"
}
]
}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