List of transactions

Field name

Description

Type

Requirement status

Additional remarks

page

Page. Default:0

integer($int32)

N

per_page

Number of items per page

integer($int32)

N

sort_by

Name of the field which specifies the sorting criteria.

Available values: created_date, amount, status, payment_method, order_id

string

N

sort_direction

Specifies ascending or descending sorting process.

Available values: ASC, DESC

Default value: ASC

string

N

order_id

An order's ID consists of "order ID by merchant "& "| "& "order ID by InPost Pay". The same value may be shared between multiple transactions. Refers to a physical order.

Example: "12345678|d30ef4c8-3e3e-3456-bb76-67y543ed66"

string

N

transaction_id

Unique transaction ID assigned by the payment services provider.

string

N

merchant_pos_id

Sales outlet ID assigned by the payment services provider.

string

N

amount_from

Transaction amount criterion, which returns transactions with an amount greater than or equal to the amount specified.

number

N

amount_to

Transaction amount criterion, which returns transactions with an amount lower than or equal to the amount specified.

number

N

currency

Currency code in the format  ISO 4217.

string

N

date_from

Transaction creation date criterion, which returns transactions created on the given day or later.

string($date)

N

date_to

Transaction creation date criterion, which returns transactions created on the given day or earlier.

string($date)

N

paymentMethod

The payment method used for finalize transactions

Available values: CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, PIS

array[string]

N

status

Transaction's current status

Available values: PENDING, AUTHORIZED, CARD_VERIFIED, CAPTURED, REFUNDED, PARTIALLY_REFUNDED, CANCELLED, DECLINED

array[string]

N

Field name

Description

Type

Requirement status

Additional remarks

items

List of returned transactions which match the required criteria

object

Y

items.transaction_id

Unique transaction ID assigned by the payment services provider.

string

Y

items.merchant_pos_id

Sales outlet ID assigned by the payment services provider.

string

Y

items.external_transaction_id

Unique transaction ID assigned by the vendor.

string

Y

items.description

Message describing the transaction

string

Y

items.status

Transaction's current status

Enum:
 [ PENDING, AUTHORIZED, CARD_VERIFIED, CAPTURED, REFUNDED, PARTIALLY_REFUNDED, CANCELLED, DECLINED ]

string

Y

items.created_date

Date of creating the transaction

string($date-time)

Y

items.amount

Transaction's initia amount

number

Y

items.currency

Currency code in the format  ISO 4217.

string

Y

items.payment_method

The payment method used for finalize transactions

Enum:
 [ CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, PIS ]

string

Y

items.order_id

Order's ID assigned by the vendor. The same value may be shared between multiple transactions. Refers to a physical order.

string

Y

items.operations

List of operations related to the given transaction

object

Y

items.operations.external_operation_id

Operation ID provided by the Merchnat.

string

Y

items.operations.type

Type of operation

Enum:

[ CAPTURE, REFUND, REVERSAL, AUTHORIZATION, AUTHENTICATION, CARD_VERIFICATION ]

string

Y

items.operations.status

Operation's current status

Enum:

[ PENDING, SUCCESS, FAILED ]

string

Y

items.operations.amount

Operation's amount

number

Y

items.operations.currency

Operation's currency code in the format  ISO 4217.

string

Y

items.operations.operation_date

Time stamp which specifies when the given operation took place

string($date-time)

Y

page

Page number returned

integer($int32)

Y

per_page

Number of elements returned

integer($int32)

Y

count

Number of all the elements which match the required criteria

integer($int32)

Y