Get transaction

GET

payment

transactions

{id}

curl -X GET \
 /payment/transactions/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "type": "payment",
  "paymentMethod": {
    "id": "<string>",
    "gatewayName": "wallet",
    "type": "sepa_debit",
    "default": true,
    "status": "active",
    "enabled": true,
    "name": "<string>",
    "creationDate": "2023-11-07T05:31:56Z",
    "expirationDate": "2023-11-07T05:31:56Z",
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2022,
      "cardHolder": "Max Mustermann"
    },
    "sepaDebit": {
      "iban": "DE8937*********3232",
      "bic": "COBADEFFXXX",
      "mandateReference": "MNDT-2021-123456",
      "signingDate": "2021-01-01T00:00:00+00:00"
    },
    "paypal": {
      "email": "max@mustermann.de",
      "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    }
  },
  "gateway": "<any>",
  "status": "<any>",
  "description": "Payment for invoice #123",
  "documentNumber": "123456789",
  "currencyCode": "EUR",
  "amount": 500,
  "refundedAmount": 123,
  "chargedAmount": 500,
  "feeAmount": 50,
  "createdAt": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "authorized": true,
  "refundable": true,
  "processing": true,
  "captured": true,
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "customerNumber": "CUSTOMER-000",
      "timeZone": "Europe/Berlin",
      "firstName": "John",
      "lastName": "Doe",
      "currencyCode": "EUR",
      "companyName": "Acme Inc.",
      "datevId": "123456789",
      "status": "STATUS_ACTIVE"
    },
    "paymentMethod": {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "default": true,
      "status": "active",
      "enabled": true,
      "name": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "card": {
        "brand": "Visa",
        "last4": "4242",
        "expMonth": 12,
        "expYear": 2022,
        "cardHolder": "Max Mustermann"
      },
      "sepaDebit": {
        "iban": "DE8937*********3232",
        "bic": "COBADEFFXXX",
        "mandateReference": "MNDT-2021-123456",
        "signingDate": "2021-01-01T00:00:00+00:00"
      },
      "paypal": {
        "email": "max@mustermann.de",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      }
    },
    "type": "TYPE_INVOICE",
    "currencyCode": "EUR",
    "number": "RE-0000000001",
    "status": "STATUS_DRAFT",
    "finalizationDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "dunningLevel": 123,
    "dunningStatus": "none",
    "payDate": "2023-11-07T05:31:56Z",
    "invoiceAddress": "<any>",
    "internalNote": "This invoice is with a special discount.",
    "netAmount": {},
    "grossAmount": {},
    "taxAmount": {},
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    },
    "unpaidAmount": {}
  },
  "referenceId": "ch_1J3AJ2"
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Path Parameters

string

required

Transaction identifier

Response

200

application/json

Transaction resource

string

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

customer

object

The customer which belongs to the transaction.

type

enum<string>

default:payment

Available options:

payment,

refund

Example:

"payment"

paymentMethod

object

The payment method which was used for this transaction.

gateway

any

The payment gateway which was used for this transaction.

Possible values:

paypal: PayPal (supports "paypal")
stripe: Stripe (supports "card")
testing: Testing (supports all)
go_cardless: GoCardless (supports "sepa_debit")
bank_transfer: Bank Transfer (supports "bank_transfer")
sepa_debit: SEPA Credit and Debit with xml file (supports "sepa_debit")
wallet: Credit Balance from Wallet (supports "wallet")

status

any

The status of the transaction.

Possible values:

new: The transaction is new and not yet processed. A new transaction is created when a payment is initiated.
authorized: The transaction is authorized and can be captured.
authorizing: The transaction is authorizing. No actions can be performed on the transaction.
waiting: The transaction is waiting for a response from the payment provider, or a customer input. No actions can be performed on the transaction.
offsite_authorization_required: The transaction requires an offsite authorization, e.g. 3D Secure. The customer is informed about the required authorization and redirected to the payment provider.
booked: The transaction is captured and booked on the account.
captured: The transaction is captured and will be booked on the account.
dispute: The transaction is disputed.
manual: Legacy status. Do not use.
canceled: The transaction is canceled, e.g. by the customer during the payment process, or by the merchant.
pending: The transaction is pending, and will be processed soon by the payment provider.
expired: The transaction is expired, e.g. because the customer did not complete the payment process in time.
processing: The transaction is processing, e.g. because the payment provider is currently processing the payment.
failed: The transaction failed, e.g. because the payment provider could not process the payment.
unknown: The transaction status is unknown.
refunded: The transaction is fully refunded.
payedout: The transaction was a payout.
partial_refunded: The transaction is partially refunded.
refund_failed: The transaction refund failed.

description

string

The description of the transaction.

Example:

"Payment for invoice #123"

documentNumber

string

The internal reference number of the transaction.

Example:

"123456789"

currencyCode

object

The currency code of the transaction.

amount

integer

The original amount which was requested.

Example:

500

refundedAmount

integer

The amount which was refunded.

chargedAmount

integer

The amount which was charged to the payment method.

Example:

500

feeAmount

integer | null

The amount of the transaction fee.

Example:

50

createdAt

string

The date when the transaction was created.

paidAt

string | null

The date when the transaction was charged.

authorized

boolean

Describes if the transaction is authorized and can be captured.

Example:

true

refundable

boolean

Describes if the transaction is refundable.

Example:

true

processing

boolean

Describes if the transaction is currently processing and cannot perform any actions.

Example:

true

captured

boolean

Describes if the transaction is sucessful processed.

Example:

true

invoice

object | null

The invoice which belongs to the transaction. Can be null if the transaction is not related to an invoice.

invoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

invoice.customer

object

The customer of the invoice.

invoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

invoice.paymentMethod.id

string

invoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

invoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

invoice.paymentMethod.default

boolean

invoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

invoice.paymentMethod.enabled

boolean

invoice.paymentMethod.name

string | null

invoice.paymentMethod.creationDate

string

invoice.paymentMethod.expirationDate

string | null

invoice.paymentMethod.card

object

The card data of the payment method, if the type is "card"

invoice.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

invoice.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

invoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

invoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

invoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

invoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

invoice.finalizationDate

string | null

invoice.dueDate

string | null

invoice.dunningLevel

integer

invoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

invoice.payDate

string | null

invoice.invoiceAddress

any | null

The invoice address of the invoice.

invoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

invoice.netAmount

object

The net amount of the invoice.

invoice.grossAmount

object

invoice.taxAmount

object

invoice.customFields

object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Example:

{ "field1": "value1", "field2": "value2" }

invoice.unpaidAmount

object

referenceId

string | null

The reference id of the payment provider.

Example:

"ch_1J3AJ2"

Get transactions Get a list of SEPA XML files

curl -X GET \
 /payment/transactions/{id} \
 --header "Authorization: Bearer <token>"

{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "type": "payment",
  "paymentMethod": {
    "id": "<string>",
    "gatewayName": "wallet",
    "type": "sepa_debit",
    "default": true,
    "status": "active",
    "enabled": true,
    "name": "<string>",
    "creationDate": "2023-11-07T05:31:56Z",
    "expirationDate": "2023-11-07T05:31:56Z",
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2022,
      "cardHolder": "Max Mustermann"
    },
    "sepaDebit": {
      "iban": "DE8937*********3232",
      "bic": "COBADEFFXXX",
      "mandateReference": "MNDT-2021-123456",
      "signingDate": "2021-01-01T00:00:00+00:00"
    },
    "paypal": {
      "email": "max@mustermann.de",
      "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    }
  },
  "gateway": "<any>",
  "status": "<any>",
  "description": "Payment for invoice #123",
  "documentNumber": "123456789",
  "currencyCode": "EUR",
  "amount": 500,
  "refundedAmount": 123,
  "chargedAmount": 500,
  "feeAmount": 50,
  "createdAt": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "authorized": true,
  "refundable": true,
  "processing": true,
  "captured": true,
  "invoice": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customer": {
      "id": "00000000-0000-0000-0000-000000000000",
      "customerNumber": "CUSTOMER-000",
      "timeZone": "Europe/Berlin",
      "firstName": "John",
      "lastName": "Doe",
      "currencyCode": "EUR",
      "companyName": "Acme Inc.",
      "datevId": "123456789",
      "status": "STATUS_ACTIVE"
    },
    "paymentMethod": {
      "id": "<string>",
      "gatewayName": "wallet",
      "type": "sepa_debit",
      "default": true,
      "status": "active",
      "enabled": true,
      "name": "<string>",
      "creationDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z",
      "card": {
        "brand": "Visa",
        "last4": "4242",
        "expMonth": 12,
        "expYear": 2022,
        "cardHolder": "Max Mustermann"
      },
      "sepaDebit": {
        "iban": "DE8937*********3232",
        "bic": "COBADEFFXXX",
        "mandateReference": "MNDT-2021-123456",
        "signingDate": "2021-01-01T00:00:00+00:00"
      },
      "paypal": {
        "email": "max@mustermann.de",
        "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
      }
    },
    "type": "TYPE_INVOICE",
    "currencyCode": "EUR",
    "number": "RE-0000000001",
    "status": "STATUS_DRAFT",
    "finalizationDate": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "dunningLevel": 123,
    "dunningStatus": "none",
    "payDate": "2023-11-07T05:31:56Z",
    "invoiceAddress": "<any>",
    "internalNote": "This invoice is with a special discount.",
    "netAmount": {},
    "grossAmount": {},
    "taxAmount": {},
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    },
    "unpaidAmount": {}
  },
  "referenceId": "ch_1J3AJ2"
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Authorizations

Path Parameters

Response