Get All PS Transactions

Last changes: 11-29-2021

Returns a list of all the transactions linked to a specific payment serie with pagination, based on the filters passed on as query parameters.

The request must provide the followng header:

x-api-key: {merchantKey}

Request sample

Path:: GET {BaseUrl}/payment-series/PaymentSeries-5fb19b1b-8990-4c79-b45c-775f3140dcbb/transactions
Header:: Content-Type: application/json
Accept-Language: en-US

Response parameters

Field	Description	Type
page	Number of the page for which the data is to be returned.	Int
pageSize	Number of the records to display per page.	Int
count	Number of total records(payment series) returned for the made search/request.	Int
totalPages	Number of pages returned for the made search/request.	Int
data	List of all the transaction linked to the specified payment serie of the page requested For the transaction output parameters specification, please refer to "Data Model"	Object

Response sample

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
"page": 0,
"pageSize": 7,
"count": 7,
"totalPages": 1,
"data": [
{
"id": "Transaction-60b8fe39-1c71-40e8-b2b8-d2ae4b5d9c20",
"customerAccountId": "NewcustomerTestPSerie00",
"storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
"modificationId": "e6b98627-e7eb-4a41-ae32-540f2e22d309",
"transactionReferenceId": "aeaabe56-3c05-44fb-9f19-9f27074ef5a4",
"reconciliationReferenceId": "pzFdwq0ImRFYGYuq41xCH",
"paymentStatus": "captured",
"payment": {
"description": "OrderId0010",
"amount": 7.30,
"currencyIsoCode": "EUR"
},
"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": "NewcustomerTestPSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"transactionLogs": [
{
"id": "TransactionLog-00601b47-1322-48b3-9772-c70cad35d086",
"createdAt": "2021-06-22T16:32:42.39Z",
"updatedAt": "2021-06-22T16:32:42.39Z",
"status": "captured",
"description": "Transaction with modificationId: e6b98627-e7eb-4a41-ae32-540f2e22d309 is updated with status captured and description: OrderId0010"
}
]
},
{
"id": "Transaction-e7fd8a51-eb8b-4f6a-8391-742959aad853",
"customerAccountId": "NewcustomerTestPSerie00",
"storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
"modificationId": "3ec7880e-224e-4428-83ae-13d005e78622",
"transactionReferenceId": "aebbbe56-3c05-44fb-9f19-9f27074ef5a4",
"reconciliationReferenceId": "pzFdwq97mRFYGYHy71xCH",
"paymentStatus": "captured",
"payment": {
"description": "OrderId0011",
"amount": 10.00,
"currencyIsoCode": "EUR"
},
"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": "NewcustomerTestPSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"transactionLogs": [
{
"id": "TransactionLog-377a2d48-cc65-429a-b7e5-213b1768ee81",
"createdAt": "2021-06-22T16:30:32.97Z",
"updatedAt": "2021-06-22T16:30:32.97Z",
"status": "captured",
"description": "Transaction with modificationId: 3ec7880e-224e-4428-83ae-13d005e78622 is updated with status captured and description: OrderId0011"
}
]
},
{
"id": "Transaction-3e448ade-17ce-4b9f-82f9-a14867ddc1a6",
"customerAccountId": "NewcustomerTestPSerie00",
"storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
"transactionReferenceId": "cfccbe56-3c05-44fb-9f19-9f27078ef5a9",
"modificationId": "154613fe-5b41-4ad2-bddf-d71fd87f39b4",
"reconciliationReferenceId": "pzFdos0ImRFYGYjq46xPI",
"paymentStatus": "captured",
"payment": {
"description": "OrderId0012",
"amount": 8.00,
"currencyIsoCode": "EUR"
},
"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": "NewcustomerTestPSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"transactionLogs": [
{
"id": "TransactionLog-c4c31c16-0635-4a1c-b53f-fbadb8096889",
"createdAt": "2021-06-08T09:35:53.49Z",
"updatedAt": "2021-06-08T09:35:53.49Z",
"status": "captured",
"description": "Transaction with modificationId: 154613fe-5b41-4ad2-bddf-d71fd87f39b4 is updated with status captured and description: OrderId0012"
}
]
},
{
"id": "Transaction-94681130-494c-43ec-ba3e-707fd7e0d6e2",
"customerAccountId": "NewcustomerTestPSerie00",
"storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
"modificationId": "769bdbe6-b80e-40dd-970b-b9cb3829dca1",
"transactionReferenceId": "ffghbe56-3c05-44fb-9n19-9e27078ef5a9",
"reconciliationReferenceId": "qaFdlc0ImRFYGYuq00xQN",
"paymentStatus": "captured",
"payment": {
"description": "OrderId0013",
"amount": 8.00,
"currencyIsoCode": "EUR"
},
"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": "NewcustomerTestPSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"transactionLogs": [
{
"id": "TransactionLog-a29b3616-bb96-4efd-bded-e8d9f0663b15",
"createdAt": "2021-06-08T09:35:22.94Z",
"updatedAt": "2021-06-08T09:35:22.94Z",
"status": "captured",
"description": "Transaction with modificationId: 769bdbe6-b80e-40dd-970b-b9cb3829dca1 is updated with status captured and description: OrderId0013"
}
]
},
{
"id": "Transaction-1a0c870d-3c83-4ce0-93b4-feac74770733",
"customerAccountId": "NewcustomerTestPSerie00",
"storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
"modificationId": "1cff5aa6-c1c2-4802-9257-65538ef34b5a",
"transactionReferenceId": "erccje56-3c05-99fb-9f19-9f27078ef5a9",
"reconciliationReferenceId": "mnFdwa0ImRFYQLuq65xXN",
"paymentStatus": "captured",
"payment": {
"description": "OrderId0014",
"amount": 7.00,
"currencyIsoCode": "EUR"
},
"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": "NewcustomerTestPSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"transactionLogs": [
{
"id": "TransactionLog-555e8863-24b6-4898-bf1e-422fade9b6db",
"createdAt": "2021-06-08T08:43:17.95Z",
"updatedAt": "2021-06-08T08:43:17.95Z",
"status": "captured",
"description": "Transaction with modificationId: 1cff5aa6-c1c2-4802-9257-65538ef34b5a is updated with status captured and description: OrderId0014"
}
]
},
{
"id": "Transaction-c5b3adaa-f04d-48d9-9497-c2845a368ad2",
"customerAccountId": "NewcustomerTestPSerie00",
"storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
"modificationId": "f429d595-96a4-4974-9ee4-b8c721482691",
"transactionReferenceId": "cfppbe56-3c05-44fb-8h18-9f33078ef5a9",
"reconciliationReferenceId": "ayFdwq0PmLFYGYuq11xAY",
"paymentStatus": "captured",
"payment": {
"description": "OrderId0015",
"amount": 7.00,
"currencyIsoCode": "EUR"
},
"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": "NewcustomerTestPSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"transactionLogs": [
{
"id": "TransactionLog-06fdf2c2-0bda-42ae-9c9b-2ebfbc50301b",
"createdAt": "2021-06-08T08:37:35.06Z",
"updatedAt": "2021-06-08T08:37:35.06Z",
"status": "captured",
"description": "Transaction with modificationId: f429d595-96a4-4974-9ee4-b8c721482691 is updated with status captured and description: OrderId0015"
}
]
},
{
"id": "Transaction-cc9b3585-c7bf-4ae0-9be7-545778593299",
"customerAccountId": "NewcustomerTestPSerie00",
"storedPaymentOptionReference": "8ac7a49f79ea7b760179eaae946a4ff7",
"modificationId": "783ad3b1-69a6-4fe1-9c3e-1742dd81e4a6",
"transactionReferenceId": "tznlbe87-3c05-31fb-9f19-9f25078ef5a9",
"reconciliationReferenceId": "akFdwk0ImRFYGYuq34ySZ",
"paymentStatus": "captured",
"payment": {
"description": "OrderId0016",
"amount": 6.00,
"currencyIsoCode": "EUR"
},
"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": "NewcustomerTestPSerie00@mail.com",
"title": "Mr",
"culture": "en-en",
"dateOfBirth": "1995-01-26",
"gender": "M",
"mobilePhone": "1234567890",
"homePhone": "1234567891",
"workPhone": "1234567892",
"taxId": null
},
"transactionLogs": [
{
"id": "TransactionLog-c15bba85-bedc-456f-ad19-df14670360b9",
"createdAt": "2021-06-08T08:37:10.10Z",
"updatedAt": "2021-06-08T08:37:10.10Z",
"status": "captured",
"description": "Transaction with modificationId: 783ad3b1-69a6-4fe1-9c3e-1742dd81e4a6 is updated with status captured and description: OrderId0016"
}
]
}
]
}

Document version 1.1 - 2021-07-15 (Minor correction to response sample and adding reconciliationReferenceID)

Document version 1.1 - 2021-07-21 (adding transactionReferenceId to the response sample)

For error handling, please refer to this section.

Previous

Next