Get All Transactions

GET 
/subscriptions/:subscriptionId/billing-cycles/:billingCycleId/transactions

Returns a list of all transactions linked to a specific subscription and 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

Path Parameters

subscriptionId stringrequired
Unique Identifier of the created Subscription. Format: Subscription + - + <UUID>
Example: Subscription-c111d61c-54c8-45a8-86e5-71b461d54b9a
billingCycleId stringrequired
Unique Identifier of the created Billing Cycle. Format: BillingCycle + - + <UUID>
Example: BillingCycle-44401c1b-c762-42dd-81bc-fd1fbad54af2

Query Parameters

page integer

Number of the page for which the data is to be returned.

pageSize integer

Number of the records to display per page.

count integer

Number of total records (Transactions) returned for the made search/request.

totalPages integer

Number of pages returned for the made search/request.

data array

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.

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

x-api-key stringrequired

x-api-key: {merchantKey}

Responses

200

Successful response

application/json

Schema

Schema

page integer

Number of the page for which the data is returned.

pageSize integer

Number of the records displayed per page.

count integer

Number of total records (Transactions) returned for the made search/request.

totalPages integer

Number of pages returned for the made search/request.

data

object[]

Array [

id stringrequired

Unique Identifier of the Transaction. Format: Transaction + - + <UUID>

customerAccountId stringrequired

Possible values: <= 125 characters

Customer Account ID - A unique identifier provided by the integrating merchant.

storedPaymentOptionReference stringrequired

Possible values: <= 255 characters

The stored payment instrument reference.

modificationId stringrequired

Possible values: <= 255 characters

Your unique reference for the requested transaction.

transactionReferenceId stringrequired

Possible values: <= 255 characters

SmartPay transaction Id, could be used to call SmartPay modification APIs (e.g., refund).

reconciliationReferenceId stringrequired

Possible values: <= 255 characters

External payment provider unique transaction identifier.

paymentStatus string

Status of the transaction.

payment

object

required

Payment details of the Subscription created inherited from the provided plan. Please refer to Data Model for details.

description string

Possible values: <= 60 characters

Description of the payment or plan.

recurrentAmount decimalrequired

Possible values: <= 60 characters

Recurrent amount to charge the customer.

currencyIsoCode stringrequired

Possible values: >= 3 characters and <= 3 characters

Currency of the charges. Format ISO 4217.

billingAddress

object

required

Billing or shipping address of the consumer. Please refer to Data Model for details.

addressLine1 stringrequired

Possible values: <= 60 characters

Address line 1.

addressLine2 stringnullable

Possible values: <= 60 characters

Address line 2.

addressLine3 stringnullable

Possible values: <= 60 characters

Address line 3.

number stringrequired

Possible values: <= 10 characters

House number/building number.

city stringrequired

Possible values: <= 50 characters

City name of the address.

postCode stringrequired

Possible values: <= 10 characters

Postal code of the address.

countryCode stringrequired

Possible values: >= 2 characters and <= 3 characters

Country code. Could be 2 or 3 characters depending on the format used. Format ISO 3166 ALPHA-2 or ISO 3166 ALPHA-3.

state stringnullable

Possible values: <= 3 characters

State. Could be 2 or 3 characters depending on the state. This field is mandatory when the countryCode is US, USA, CA or CAN.

shippingAddress

object

Billing or shipping address of the consumer. Please refer to Data Model for details.

addressLine1 stringrequired

Possible values: <= 60 characters

Address line 1.

addressLine2 stringnullable

Possible values: <= 60 characters

Address line 2.

addressLine3 stringnullable

Possible values: <= 60 characters

Address line 3.

number stringrequired

Possible values: <= 10 characters

House number/building number.

city stringrequired

Possible values: <= 50 characters

City name of the address.

postCode stringrequired

Possible values: <= 10 characters

Postal code of the address.

countryCode stringrequired

Possible values: >= 2 characters and <= 3 characters

Country code. Could be 2 or 3 characters depending on the format used. Format ISO 3166 ALPHA-2 or ISO 3166 ALPHA-3.

state stringnullable

Possible values: <= 3 characters

State. Could be 2 or 3 characters depending on the state. This field is mandatory when the countryCode is US, USA, CA or CAN.

consumer

object

nullable

required

Consumer's personal data, in case the consumer is a physical person. See consumer in Data model.
Conditional. Can be present if businessConsumer is missing from the request.

firstName stringrequired

Possible values: <= 60 characters

First name of the consumer.

lastName stringrequired

Possible values: <= 60 characters

Last name of the consumer.

middleName stringnullable

Possible values: <= 60 characters

Middle name of the consumer.

emailAddress emailrequired

Possible values: <= 255 characters

Email address of the customer.

title stringrequired

Possible values: <= 3 characters, [Mr, Mrs, Ms]

Title of the consumer.

culture string

Possible values: <= 5 characters

Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g.,, en-de). This field is not case sensitive.

dateOfBirth daterequired

Date of birth. Dummy data acceptable. Format “YYYY-MM-DD”.

gender string

Possible values: [M, F, D]

Gender of the consumer.

mobilePhone string

Possible values: <= 30 characters

Mobile phone of the customer.

homePhone string

Possible values: <= 30 characters

Home phone of the customer.

workPhone string

Possible values: <= 30 characters

Work phone of the customer.

taxId stringnullable

Possible values: <= 30 characters

Tax ID of the consumer.

transactionLogs

object[]

Array [

id stringrequired

Unique Identifier of the Transaction Log. Format: TransactionLog + - + <UUID>

createdAt date-timerequired

Timestamp of when the transaction log was created.

updatedAt date-timerequired

Timestamp of when the transaction log was last updated.

status stringrequired

Status of the transaction or retried transaction.

description stringrequired

Possible values: <= 255 characters

Description of the transaction result or retry result.

]

customReferences

object

Custom references for external party usage

custom1 stringnullable

Possible values: <= 255 characters

Custom reference 1 for external party usage

custom2 stringnullable

Possible values: <= 255 characters

Custom reference 2 for external party usage

custom3 stringnullable

Possible values: <= 255 characters

Custom reference 3 for external party usage

]

Example (from schema)

{
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "totalPages": 0,
  "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,
        "currencyIsoCode": "EUR"
      },
      "billingAddress": {
        "addressLine1": "Leopoldstrasse",
        "number": "244",
        "city": "Munich",
        "postCode": "80807",
        "countryCode": "DE"
      },
      "shippingAddress": {
        "addressLine1": "Leopoldstrasse",
        "number": "244",
        "city": "Munich",
        "postCode": "80807",
        "countryCode": "DE"
      },
      "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"
      },
      "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"
        }
      ],
      "customReferences": {
        "custom1": "custom1 test1",
        "custom2": "custom1 test2",
        "custom3": null
      }
    }
  ]
}

Example

{
  "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,
        "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"
        }
      ]
    }
  ]
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceId string

Internally generated trace_id for this error message so it can be found easily in the logs.

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

The property from the request object which the error is linked to.

context

object

A json object containing a list of predefined properties which are filled based on the error.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceId string

Internally generated trace_id for this error message so it can be found easily in the logs.

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

The property from the request object which the error is linked to.

context

object

A json object containing a list of predefined properties which are filled based on the error.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceId string

Internally generated trace_id for this error message so it can be found easily in the logs.

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

The property from the request object which the error is linked to.

context

object

A json object containing a list of predefined properties which are filled based on the error.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceId string

Internally generated trace_id for this error message so it can be found easily in the logs.

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

The property from the request object which the error is linked to.

context

object

A json object containing a list of predefined properties which are filled based on the error.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceId string

Internally generated trace_id for this error message so it can be found easily in the logs.

errors

object[]

Array [

message string

A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.

code string

A pre-defined code from the list of error codes.

property string

The property from the request object which the error is linked to.

context

object

A json object containing a list of predefined properties which are filled based on the error.

type string

minimum number

maximum number

maxLength integer

allowedValues string[]

]

Example (from schema)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}

Loading...