Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
Transactions

transactions_get

scopes:

  • admin:checkout
  • read:checkout
get/accounts/{aid}/payments/transactions

Query parameters

idstring[]

List of ids that should be included in the result. ?id=A&id=B&id=X

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

starting_afterstring checkout-id

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

statusstring[]

The status of the transaction.

payment_productstring[]

The type of payment product used

payment_product_typestring[]

The payment product type

card_brandstring[]

The card brand for the payment

merchant_referencestring

The merchant reference used

merchant_reference_2string

The second merchant reference on the transaction

session_idstring[]

The session id(s) associated with the transactions. ?session_id=A&session_id=B&session_id=X.

store_idstring[]

The store_id that the transaction belongs to. ?store_id=A&store_id=B&store_id=X.

payout_correlation_idstring[]

Filter by the payout_correlation_id. Different format between payment providers. ?payout_correlation_id=A,B

currencystring[]

The currency of the transaction. ?currency=NOK&currency=SEK.

amountinteger

Exact transaction amount, amount authorized.

amount.gteinteger

Lower limit for filtering on transaction amount, amount authorized.

amount.lteinteger

Upper limit for filtering on transaction amount, amount authorized.

created_at.gtestring isodate

Transaction created after (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

created_at.ltestring isodate

Transaction created before a date (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

captured_at.gtestring isodate

Transaction captured after date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

captured_at.ltestring isodate

Transaction captured before date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

refunded_at.gtestring isodate

Transaction refunded after date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

refunded_at.ltestring isodate

Transaction refunded before date (This param is subject to change in the future) (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

searchstring

Will try to match the search to either transaction_id, session_id or merchant_reference, merchant_reference_2, phone_number, email or the customer name using the format {first_name} {last_name}, or token_id using value of card.payment_token_id.

payment_operationstring

Filter on payment_operation

customer_idstring

Filter transactions on the customer.customer_id.

includesstring[]

Control the data that is included in the transactions

  • events.success.true Include only event where success is true
payout_destination_idstring

Filter transactions on payout_destination_id and items[].splits[].payout_destination_id.

token_idstring[]

Filter transactions on token_id(s) associated with the transactions, using card.payment_token_id. ?token_id=A&token_id=B&token_id=X.

authorization_expires_at.gtestring isodate

Transaction authorization expiry greater than or equal to filter. Compares the value to metadata.authorization_expiration in the most recent AUTHORIZE event, only present for payments via the dintero_psp and klarna gateway. (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

authorization_expires_at.ltestring isodate

Transaction authorization expiry less than or equal to filter. Compares the value to metadata.authorization_expiration in the most recent AUTHORIZE event, only present for payments via the dintero_psp and klarna gateway. (ISO 8601. We recommend using a localised ISO 8601 datetime like 2017-07-21T17:32:28Z. If a timezone is not specified we assume UTC)

terminal_idstring

Filter by terminal ID.

channelstring[]

Filter by channel.

Response

Transactions

idstring

An ID that uniquely identifies the resource

created_atstring date-time

When the transaction was created

payment_product'bambora' | 'collector' | 'dintero' | 'dintero_psp' | 'instabank' | 'klarna' | 'netaxept' | 'payex' | 'santander' | 'swish' | 'vipps' | 'kravia' | 'two' | 'seitatech' required

The payment product corresponding to this transaction

payment_product_type'bambora.applepay' | 'bambora.creditcard' | 'bambora.googlepay' | 'bambora.mobilepay' | 'bambora.vipps' | 'collector.invoice' | 'collector.invoice_b2b' | 'collector.invoice_b2b_preapproved' | 'collector.installment' | 'dintero.zero' | 'dintero.wallets' | 'dintero.external' | 'dintero_psp.creditcard' | 'dintero_psp.vipps' | 'dintero_psp.googlepay' | 'dintero_psp.applepay' | 'dintero_psp.clicktopay' | 'instabank.finance' | 'instabank.invoice' | 'instabank.installment' | 'instabank.postponement' | 'klarna.klarna' | 'klarna.billie' | 'kravia.invoice_b2b' | 'kravia.invoice_b2b_grouped' | 'kravia.invoice_b2c' | 'two.invoice_b2b' | 'netaxept.creditcard' | 'payex.creditcard' | 'payex.mobilepay' | 'payex.swish' | 'payex.vipps' | 'payex.applepay' | 'payex.clicktopay' | 'payex.googlepay' | 'santander.debit_account' | 'seitatech.in_person' | 'swish.swish' | 'vipps' required

The payment product type corresponding to this transaction

amountinteger required

Non-negative, minor units. Total amount of the transaction

currencystring iso4217-code required

ISO 4217 transaction currency

payout_destination_idstring

An id that identifies the seller, value will be included in the settlement reports

merchant_referencestring

A reference specified by the merchant to identify the transaction

channel'ecommerce' | 'in_app' | 'in_store'

The channel for the transaction

platform_type'aggregator' | 'marketplace'

Type of platform the merchant is.

merchant_reference_2string

A reference specified by the merchant to identify the transaction, can be updated after the transaction has been created

dynamic_descriptorstring

A short reference / descriptor that will show up on the customers bank statement

payment_operation'unscheduled_purchase' | 'recurring_purchase' | 'generate_payment_token'

Initiated by the merchant or used to generate a token

settlement_status'NOT_SETTLED' | 'PENDING_SETTLEMENT' | 'PARTIALLY_SETTLED' | 'SETTLED'

Overall settlement status after the events

customer_ipstring

The IP address of the customer

user_agentstring

The full user agent string of the device the customer used to submit the transaction

status'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CAPTURED' | 'PARTIALLY_CAPTURED' | 'PARTIALLY_CAPTURED_REFUNDED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'DECLINED' | 'FAILED' | 'UNKNOWN' | 'ON_HOLD'

The current status of the transaction

session_idstring

The session id for the transaction

updated_atstring date-time

When the transaction was last modified.