Skip to main content

Get All Payment Series

Returns a list of all payment series with pagination, based on the filters passed on as query parameters.

Request parameters

FieldDescriptionType
pageNumber of the desired page for which data should be returned. Page numbers use zero-based numbering e.g. to get the 10th page, you need to set page=9.Int
pageSizeNumber of Payment series per Page requested (e.g. 10).Int
createdAtLteCreated before the provided date & time (Lte: Lower Than or Equal → <=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'ZString
createdAtGteCreated after the provided date & time (Gte: Greater Than or Equal → >=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'ZString
updatedAtLteUpdated before the provided date & time (Lte: Lower Than or Equal → <=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'ZString
updatedAtGteUpdated after the provided date & time (Gte: Greater Than or Equal → >=). Format: yyyy-MM-dd'T'HH:mm:ss.SS'ZString
deletedPossible values: true, falseString
externalMerchantIdCustom merchant external reference linked to the payment serie during its creationString
externalReferenceCustom external reference linked to the payment serie during its creationString
info

Please note that if a query parameter non-existent in the list above is passed in the request it would be ignored. If the value sent on one of the query parameters is invalid it would also be ignored.

info

The request must provide the following header:

x-api-key: {merchantKey}

Request sample

Path:

GET {baseURL}/payment-series?page=0&pageSize=3&externalMerchantId=MerchantExternalPSerie01

Header:

Content-Type: application/json
Accept-Language: en-US

Response parameters

FieldDescriptionType
pageNumber of the page for which the data is to be returned.Int
pageSizeNumber of the records to display per page.Int
countNumber of total records(payment series) returned for the made search/request.Int
totalPagesNumber of pages returned for the made search/request.Int
dataList of all the payment series of the page requested For the payment serie output parameters specification, please refer to "Get Payment Serie" API outputs sectionObject

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US
{
"page": 0,
"pageSize": 3,
"count": 3,
"totalPages": 1,
"data": [
{
"id": "PaymentSeries-2399b4ad-7d69-42bd-b08e-65884391f72f",
"createdAt": "2021-06-14T17:57:24.93Z",
"updatedAt": "2021-06-14T17:57:24.93Z",
"deletedAt": null,
"customerAccountId": "NewcustomerSerie01",
"currencyIsoCode": "EUR",
"externalMerchantId": "MerchantExternalPSerie01",
"merchantMetadata": "{ \"clientId\": 453456790 }",
"externalReference": "PaymentSerie 01 Payment02",
"billingAddress": {
"addressLine1": "Leopoldstrasse",
"addressLine2": null,
"addressLine3": null,
"number": "244",
"city": "Munich",
"postCode": "80807",
"countryCode": "DE",
"state": null
},
"shippingAddress": {
"addressLine1": "Leopoldstrasse",
"addressLine2": null,
"addressLine3": null,
"number": "244",
"city": "Munich",
"postCode": "80807",
"countryCode": "DE",
"state": null
},
"consumer": {
"firstName": "FirstNameA",
"lastName": "LastNameA",
"middleName": null,
"emailAddress": "NewcustomerSerie01@email.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"billingAgreement": null
},
{
"id": "PaymentSeries-f45b5e21-5279-48f8-9b7a-b3e071363de6",
"createdAt": "2021-06-14T17:36:11.25Z",
"updatedAt": "2021-06-14T17:45:22.33Z",
"deletedAt": null,
"customerAccountId": "NewcustomerSerie01",
"currencyIsoCode": "EUR",
"externalMerchantId": "UMerchantExternalPSerie01",
"merchantMetadata": "{ \"clientId\": U453456790 }",
"externalReference": "UPaymentSerie 01 Payment",
"billingAddress": {
"addressLine1": "Leopoldstr",
"addressLine2": null,
"addressLine3": null,
"number": "245",
"city": "Munich",
"postCode": "80806",
"countryCode": "DE",
"state": null
},
"shippingAddress": {
"addressLine1": "Leopoldstr.",
"addressLine2": null,
"addressLine3": null,
"number": "245",
"city": "Munich",
"postCode": "80806",
"countryCode": "DE",
"state": null
},
"consumer": {
"firstName": "UFirstNameA",
"lastName": "ULastNameA",
"middleName": null,
"emailAddress": "UNewcustomerSerie01@email.com",
"title": "Mr",
"culture": "de-de",
"dateOfBirth": "1995-10-26",
"gender": "F",
"mobilePhone": "01234567890",
"homePhone": "01234567891",
"workPhone": "01234567892",
"taxId": null
},
"billingAgreement": null
},
{
"id": "PaymentSeries-607feab8-2b8b-4e93-a452-59d842f525e0",
"createdAt": "2021-06-11T12:39:06.20Z",
"updatedAt": "2021-06-11T12:39:06.20Z",
"deletedAt": null,
"customerAccountId": "NewcustomerSerie00",
"currencyIsoCode": "EUR",
"externalMerchantId": "MerchantExternalPSerie01",
"merchantMetadata": "{ \"clientId\": 453456790 }",
"externalReference": "11",
"billingAddress": {
"addressLine1": "Leopoldstrasse",
"addressLine2": null,
"addressLine3": null,
"number": "244",
"city": "Munich",
"postCode": "80807",
"countryCode": "DE",
"state": null
},
"shippingAddress": {
"addressLine1": "Leopoldstrasse",
"addressLine2": null,
"addressLine3": null,
"number": "244",
"city": "Munich",
"postCode": "80807",
"countryCode": "DE",
"state": null
},
"consumer": {
"firstName": "FirstNameA",
"lastName": "LastNameA",
"middleName": null,
"emailAddress": "NewcustomerSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"billingAgreement": null
}
]
}
info

For error handling, please refer to this section.