Get payment link by id.
OAuth Grant type use on OpenAPI subscriptions, Private JWT
Client ID header
Customer unique id.
Payment link unique id
Payment link response.
{
"id": "7r4hQemUHqYUjH",
"amount": 251,
"currencyCode": "EUR",
"realAccountId": "88c7699a-31ce-4d8f-8df4-c5423c0dc0f0",
"customerId": "pagonxt_esESB76134758",
"paymentSubjectId": "d405530d-f9ae-422f-a3a3-acfe88265445",
"description": "Course fees",
"externalPaymentReference": "ABCD01234",
"status": "GENERATED",
"url": "https://ms.dev.emi.pagonxt.corp/em-cs-payment-form/THEME_NAME/init-payment?v=061ebf78b0fe89b38e98141ef7f48cf36efb6a93b1ca2b9eb4f35b04b75b1540&id=7r4hQemUHqYUjH&cid=pagonxt_esESB76134758",
"expirationDate": "2025-03-17T10:02:03.482Z",
"paymentMethods": [
{
"id": "84349a11-29b8-464a-831a-cad56d6a72f5",
"code": "BANK_TRANSFER",
"countries": [
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"CV",
"KH",
"CM",
"CA",
"KY",
"CF",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SX",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
}
],
"recurrentCardPaymentConfiguration": {
"id": "88c7699a-31ce-4d8f-8df4-c5423c0dc0f0",
"installmentAmount": 100,
"hasOneOffPaymentOption": true,
"createdAt": "2025-01-17T12:15:46.321Z",
"updatedAt": "2025-01-17T12:15:46.320Z"
},
"successCallback": "https://pagonxt.com/university/success",
"failureCallback": "https://pagonxt.com/university/failure",
"paymentReference": "PN2222BBBC",
"createdAt": "2025-01-18T12:15:46.320Z",
"updatedAt": "2025-01-17T12:15:46.320Z",
"_links": {
"self": {
"href": "https://host/em_cs_collections/customers/pagonxt_esESB76134758/payment_links/7r4hQemUHqYUjH"
}
}
}Date and time when the entry was created.
Date and time when the entry was updated.
The Payment link identifier.
Customer unique id.
A 32 bit floating point number.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Unique identifier.
Payment purpose.
Payment link URL to be sent to the payment subject.
Unique identifier.
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'
Payment link status.
The possible values are:
- GENERATED = Payment link has been created but has not yet been used to make a payment
- COMPLETED = Payment link has been used to make a payment.
- CANCELLED = Payment link has been cancelled and cannot been used to make a payment
It is a URL for redirection in case the payment is positive, to an address set by the customer itself.
It is a URL for redirection in case the payment is negative, to an address set by the customer itself.
Payment reference used by PagoNxt for reconciliation purposes.
External payment reference provided by customer.
Unique identifier.
Payment methods available for the payment link.
Unique identifier.
Payment method codes.
Countries available for the payment method.
Payment Link Recurrent Card Config object.
Date and time when the entry was created.
Date and time when the entry was updated.
Unique identifier.
A 32 bit floating point number.
Enables one off card payment option
Single links object.
Self links object.
Self link.
Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"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": "UNAUTHORIZED",
"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": "FORBIDDEN",
"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": "NOT_FOUND",
"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 does not specifically contain one of the allowable types. Missing Accept header, usually 'application/json'
{
"errors": [
{
"code": "NOT_ACCEPTABLE",
"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
Request Entity Too Large Most web servers have a limit of 8192 bytes (8 KB). The server will close the connection to prevent the client from continuing the request.
{
"errors": [
{
"code": "ENTITY_TOO_LARGE",
"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
{
"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