Page Comparison

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

page

Strona. Default:0

integer($int32)

N

per_page

Ilość pozycji na stronie

integer($int32)

N

sort_by

Nazwa pola określającego kryteria sortowania.

Dostępne wartości: created_date, amount, status, payment_method, order_id

string

N

sort_direction

Określa sortowanie rosnące lub malejące.

Dostępne wartości : ASC, DESC

Wartość domyślna : ASC

string

N

order_id

Identyfikator zamówienia nadany przez merchantaskłada się z "order ID by merchant"&"|"&"order ID by InPost Pay". Ta sama wartość może być współdzielona między wieloma transakcjami. Odnosi się do fizycznego zamówienia.

Przykład: "12345678|d30ef4c8-3e3e-3456-bb76-67y543ed66"

string

N

transaction_id

Unikalny identyfikator transakcji przypisany przez dostawcę usług płatniczych.

string

N

merchant_pos_id

Identyfikator punktu sprzedaży przypisany przez dostawcę usług płatniczych.

string

N

amount_from

Kryterium kwoty transakcji, które zwróci transakcje o kwocie większej lub równej określonej kwocie.

number

N

amount_to

Kryterium kwoty transakcji, które zwróci transakcje z kwotą mniejszą lub równą określonej kwocie.

number

N

currency

Kod waluty w formacie ISO 4217.

string

N

date_from

Kryterium daty utworzenia transakcji, które zwróci transakcje utworzone w określonym dniu lub po nim.

string($date)

N

date_to

Kryterium daty utworzenia transakcji, które zwróci transakcje utworzone w określonym dniu lub przed nim.

string($date)

N

paymentMethod

Metoda płatności użyta do sfinalizowania transakcji

Dostępne wartości : CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, PIS

array[string]

N

status

Bieżący status transakcji

Dostępne wartości : PENDING, AUTHORIZED, CARD_VERIFIED, CAPTURED, REFUNDED, PARTIALLY_REFUNDED, CANCELLED, DECLINED

array[string]

N

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

items

Lista zwróconych transakcji spełniających żądane kryteria

object

Y

items.transaction_id

Unikalny identyfikator transakcji przypisany przez dostawcę usług płatniczych.

string

Y

items.merchant_pos_id

Identyfikator punktu sprzedaży przypisany przez dostawcę usług płatniczych.

string

Y

items.external_transaction_id

Unikalny identyfikator transakcji przypisany przez sprzedawcę.

string

Y

items.description

Wiadomość opisująca transakcję

string

Y

items.status

Bieżący status transakcji

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

string

Y

items.created_date

Data utworzenia transakcji

string($date-time)

Y

items.amount

Oryginalna kwota transakcji

number

Y

items.currency

Kod waluty w formacie ISO 4217.

string

Y

items.payment_method

Metoda płatności użyta do sfinalizowania transakcji

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

Identyfikator zamówienia przypisany przez sprzedawcę. Ta sama wartość może być współdzielona między wieloma transakcjami. Odnosi się do fizycznego zamówienia.

string

Y

items.operations

Lista operacji związanych z daną transakcją

object

Y

items.operations.external_operation_id

Identyfikator operacji dostarczony przez merchnata.

string

Y

items.operations.type

Typ operacji

Enum:

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

string

Y

items.operations.status

Bieżący status operacji

Enum:

[ PENDING, SUCCESS, FAILED ]

string

Y

items.operations.amount

Kwota operacji

number

Y

items.operations.currency

Kod waluty operacji w formacie ISO 4217.

string

Y

items.operations.operation_date

Znacznik czasu określający, kiedy dana operacja miała miejsce

string($date-time)

Y

page

Zwracany numer strony

integer($int32)

Y

per_page

Liczba zwróconych elementów

integer($int32)

Y

count

Liczba wszystkich elementów spełniających żądane kryteria

integer($int32)

Y