GET
/
payment
/
transactions
/
{id}

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

Transaction identifier

Response

200 - application/json
amount
integer

The original amount which was requested.

authorized
boolean

Describes if the transaction is authorized and can be captured.

captured
boolean

Describes if the transaction is sucessful processed.

chargedAmount
integer

The amount which was charged to the payment method.

createdAt
string

The date when the transaction was created.

currencyCode
object

The currency code of the transaction.

customer
object

The customer which belongs to the transaction.

description
string

The description of the transaction.

documentNumber
string

The internal reference number of the transaction.

feeAmount
integer | null

The amount of the transaction fee.

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")
id
string
invoice
object | null

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

paidAt
string | null

The date when the transaction was charged.

paymentMethod
object

The payment method which was used for this transaction.

processing
boolean

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

referenceId
string | null

The reference id of the payment provider.

refundable
boolean

Describes if the transaction is refundable.

refundedAmount
integer

The amount which was refunded.

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.
type
enum<string>
default:
payment
Available options:
payment,
refund