Get collection list.
OAuth Grant type use on OpenAPI subscriptions, Private JWT
Strong Customer Authorization (SCA) token ID. Required whenever an end-user is consuming movements more than 90 days old.
Client ID header
Customer unique id.
Pagination offset identifier.
Number of values that should be informed per page.
Expands available for collections. List of values split by ,.
Possibles values are: reconciliationInfo, paymentSubject, account, customer and history.
To filter by the external ID used to identify the payment subject by the customer.
To filter by unique identifier for the real e money account related to this specific collection.
Collection status.
The possible values are:
- IN_PROGRESS = Collection is waiting for its payment.
- REJECTED = Collection has been rejected and cannot receive payments any more.
- LOCALLY_PAID = External local partner has received the money.
- COMPLETED = Collection has been payed correctly.
- UNMATCHED_AMOUNT = If there is only one collection IN_PROGRESS and no match. CollectedAmount will save payment amount.
- UNEXPECTED = If we were not expecting any payment.
- UNABLE_TO_MATCH = If there is more than one collection IN_PROGRESS and we cannot determine with one should receive the payment.
- CARD_PAYMENT_FAILED = If card payment process failed.
- CARD_PAYMENT_SUCCESS = If card payment process successfully finished.
- CARD_PAYMENT_CANCELLED = If card payment process cancelled.
Payment methods selected by collections.
List of values split by ,.
The possible values are:
- BANK_TRANSFER -LOCAL_TRANSFER
Minimum collected amount to be included in the response.
The value must be greater than or equal to 0.
Maximum collected amount to be included in the response.
The value must be less than or equal to 2147483647.
Minimum expected amount to be included in the response.
The value must be greater than or equal to 0.
Maximum expected amount to be included in the response.
The value must be less than or equal to 2147483647.
From Date and time when the collection was created.
The value uses the data format defined in ISO 8601 and is expressed in UTC time:
'YYYY-MM-DDThh:mm:ss.sssZ'
To Date and time when the collection was created.
The value uses the data format defined in ISO 8601 and is expressed in UTC time:
'YYYY-MM-DDThh:mm:ss.sssZ'
Filter by expected collection reference used by PagoNxt for reconciliation purposes. Case insensitive and partial match.
Filter by external collection reference supplied by customer. Case insensitive and partial match.
Sort order value.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Collection list response.
{
"collections": [
{
"id": "c75e3057-5514-4b72-bf41-6dba88357c0f",
"customerId": "pagonxt_esESB76134758",
"originCountryCode": "ES",
"paymentLinkId": "sLiKADBoKUSQPJ",
"expectedAmount": {
"value": 250,
"currencyCode": "EUR"
},
"collectedAmount": {
"value": 250,
"currencyCode": "EUR"
},
"expectedReference": "COLLREF1",
"externalReference": "ABCD1234",
"paymentMethodCode": "BANK_TRANSFER",
"reconciliationInfo": {
"collectedAmount": {
"value": 250,
"currencyCode": "EUR"
},
"receivedReference": "ref",
"transactionValueDate": "2022-03-17T10:02:03.482Z",
"transactionOperationDate": "2022-03-17T10:02:03.482Z",
"transactionBookingDate": "2022-03-17T10:02:03.482Z"
},
"status": "COMPLETED",
"paymentSubjectExternalId": "2507b89c-b680-46df-9505-e0b6f78cf294",
"paymentSubject": {
"externalId": "2507b89c-b680-46df-9505-e0b6f78cf294",
"metadataType": "PERSON",
"supplementaryReference": "PN4444BBBA"
},
"realAccountId": "c75e3057-5514-4b72-bf41-6dba88357c0a",
"account": {
"accountIdentifiers": [
{
"accountIdType": "uuid",
"accountId": "2507b89c-b680-46df-9505-e0b6f78cf296",
"countryCode": "ES"
},
{
"accountIdType": "iban",
"accountId": "GB40PNXT09991100000010",
"countryCode": "ES"
},
{
"accountIdType": "bban",
"accountId": "PNXT0999110000001",
"countryCode": "ES"
}
],
"legalEntityBic": "PAGOES20XXX",
"reconciliationModel": "COL-VA"
},
"customer": {
"id": "pagonxt_esESB76134758",
"name": "Customer Company S.A.",
"address": "99 BUSINESS STREET, 28075, LAS PALMAS DE GRAN CANARIA, LAS PALMAS, ES"
},
"createdAt": "2025-02-21T10:43:34.648Z",
"updatedAt": "2025-02-21T10:43:34.648Z",
"statusHistory": [
{
"createdAt": "2025-02-25T16:35:45.677Z",
"status": "IN_PROGRESS"
},
{
"createdAt": "2025-02-25T16:35:45.689Z",
"status": "COMPLETED"
}
]
}
],
"_count": 1,
"_links": {
"self": {
"href": "https://host/em_cs_collections/customers/pagonxt_esESB76134758/collections/?expands=account,paymentSubject,reconciliationInfo,customer,history&_offset=0&status=COMPLETED&payment_methods=BANK_TRANSFER&expected_reference=col&from_expected_amount=1&to_expected_amount=301"
}
}
}Total items.
Paginated links object.
Self link object.
Self link.
Link to the first page of the list.
Link to the previous page of the list.
Link to the next page of the list.
Link to the last page of the list.
Collections list.
Date and time when the entry was created.
Date and time when the entry was updated.
Unique identifier.
Unique identifier for the real e money account related to this specific collection.
Indicate from which country the Payment Method is available. Only valid ISO31661 Alpha 2.
Collection status.
The possible values are:
- IN_PROGRESS = Collection is waiting for its payment.
- REJECTED = Collection has been rejected and cannot receive payments any more.
- LOCALLY_PAID = External local partner has received the money.
- COMPLETED = Collection has been payed correctly.
- UNMATCHED_AMOUNT = If there is only one collection IN_PROGRESS and no match. CollectedAmount will save payment amount.
- UNEXPECTED = If we were not expecting any payment.
- UNABLE_TO_MATCH = If there is more than one collection IN_PROGRESS and we cannot determine with one should receive the payment.
- CARD_PAYMENT_FAILED = If card payment process failed.
- CARD_PAYMENT_SUCCESS = If card payment process successfully finished.
- CARD_PAYMENT_CANCELLED = If card payment process cancelled.
Expected collection reference.
Collection external reference supplied by customer.
External ID used to identify the payment subject by the customer.
The Payment link identifier.
Customer unique id.
Amount expected.
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).
Amount collected.
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).
Payment method code.
Amount collected.
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).
Received collection reference.
Date and time of the transaction value.
Date and time of the transaction operation.
Date and time of the transaction booking.
External ID used to identify the payment subject by the customer.
Unique supplementary reference that can be optionally provided by our customer.
Type of the extra info attached to a payment subject. It can be PERSON or COMPANY.
Optional metadata info. Available properties for PERSON: name, lastName, idNumber and dateOfBirth. Available properties for COMPANY: name and taxId.
Company name.
Person last name.
Person birth date.
Optional identification number that can be the national id, passport or any other id of the person. It's a free string.
Tax id of the company.
Account identifiers.
Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).
Format used for the account number in the accountId property.
The possible values are:
- IBAN = IBAN code
- BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
- UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.
For example:
- In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
- In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Account identifier. Type depends on accountIdType.
Bank Identifier Code (BIC) for the legal entity of the account.
Account reconciliation model. Determines how an account's collections will be reconciled. Only present in real acount. Option are:
PS-VA: Payment subject virtual account
PS-REF: Payment subject referencePS-VA
COL-VA: Collection virtual account
COL-REF: Collection reference
Customer unique id.
Customer company name.
Customer company address.
Date and time when the entry was created.
Historical status of the collection.
No content
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