Get All Transactions

Returns a list of all transactions linked to a subscription and a billing cycle with pagination. It shows the transactions executions linked to the specific cycle including the retries.

info

The request must provide the following header:

x-api-key: {merchantKey}

Request sample

Path:

GET {{BaseUrl}}/subscriptions/Subscription-c111d61c-54c8-45a8-86e5-71b461d54b9a/billing-cycles/BillingCycle-44401c1b-c762-42dd-81bc-fd1fbad54af2/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(Subscriptions) returned for the made search/request.	Int
totalPages	Number of pages returned for the made search/request.	Int
data	List of all the Transactions linked to the specified subscription and billing cycle. For the Transaction output parameters specification, please refer to "transaction" in the page Data Model.	Object

Response sample

Status Code:

200 (OK)

Header:

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

{
    "page": 0,
    "pageSize": 1,
    "count": 1,
    "totalPages": 1,
    "data": [
        {
            "id": "Transaction-5f391daa-80a8-4292-96d9-3fdc1a12192b",
            "customerAccountId": "NewcustomerTestPy14",
            "storedPaymentOptionReference": "8ac7a49f790baf4001790eb90ee26064",
            "modificationId": "4d875985-f9a2-4eb5-8dff-73b64c8915a7",
            "transactionReferenceId": "aeaabe56-3c05-44fb-9f19-9f27074ef5a4",
            "reconciliationReferenceId": "pzFdwq0ImRFYGYuq41xCH",
            "paymentStatus": "captured",
            "payment": {
                "description": "MerchantExternal",
                "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": "FirstName1",
                "lastName": "LastName1",
                "middleName": ".",
                "emailAddress": "NewcustomerTestPy14@mail.com",
                "title": "Mr",
                "culture": "en-en",
                "dateOfBirth": "1995-01-26",
                "gender": "M",
                "mobilePhone": "1234567890",
                "homePhone": "1234567891",
                "workPhone": "1234567892",
                "taxId": null
            },
            "transactionLogs": [
                {
                    "id": "TransactionLog-bf55539a-fc69-410a-a684-99b2fb06bfb2",
                    "createdAt": "2021-06-17T12:46:33.99Z",
                    "updatedAt": "2021-06-17T12:46:33.99Z",
                    "status": "captured",
                    "description": "Transaction with modificationId: 4d875985-f9a2-4eb5-8dff-73b64c8915a7 is updated with status captured and description: MerchantExternal"
                }
            ]
        }
    ]
}

info

For error handling, please refer to this section.