Skip to main content

Get Transaction

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

Returns the details of a specific transaction linked to the provided subscription ID, billing cycle ID, and transaction ID.

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-4903f0f3-d718-404b-a675-167eacfabe12
    billingCycleId stringrequired

    Unique Identifier of the created Billing Cycle. Format: BillingCycle + - + <UUID>

    Example: BillingCycle-44401c1b-c762-42dd-81bc-fd1fbad54af2
    transactionId stringrequired

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

    Example: Transaction-5f391daa-80a8-4292-96d9-3fdc1a12192b

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​

Successful response

Schema

    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

Loading...
 Imprint
|
Data protection and privacy
© 2025 J.P. Morgan Mobility Payments Systems GmbH. All rights reserved.