API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Get transactions
Get a list of payment transactions, which represents a payment, refund or payout.
Required permissions:transaction:readAuthorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
0 < x < 100asc, desc asc, desc asc, desc Response
The original amount which was requested.
Describes if the transaction is authorized and can be captured.
Describes if the transaction is sucessful processed.
The amount which was charged to the payment method.
The date when the transaction was created.
The currency code of the transaction.
The customer which belongs to the transaction.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 255The ID of the customer in DATEV
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED The description of the transaction.
The internal reference number of the transaction.
The reason why the transaction failed.
The amount of the transaction fee.
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")
The invoice which belongs to the transaction. Can be null if the transaction is not related to an invoice.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 255The ID of the customer in DATEV
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED 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
reminder, dunning, none The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
The bic of the sepa mandate
The iban of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING The date when the transaction was charged.
The payment method which was used for this transaction.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
The bic of the sepa mandate
The iban of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider Describes if the transaction is currently processing and cannot perform any actions.
The reference id of the payment provider.
Describes if the transaction is refundable.
The amount which was refunded.
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.
payment, refund Was this page helpful?