Payments

Payment operations history

Use this endpoint to get the list of the seller payment operations. Read more: <a href="../../tutorials/jak-sprawdzic-oplaty-nn9DOL5PASX#historia-operacji-platniczych" target="_blank">PL</a> / <a href="../../tutorials/how-to-check-the-fees-3An6Wame3Um#payment-operations" target="_blank">EN</a>.

get/payments/payment-operations

Request

  • Base URL: https://api.allegro.pl
  • URL: https://api.allegro.pl/payments/payment-operations
  • Auth: OAuth 2 (authorization code, authorization URL https://allegro.pl/auth/oauth/authorize, token URL https://allegro.pl/auth/oauth/token, scopes: allegro:api:payments:read)

Query parameters

wallet.type'AVAILABLE' | 'WAITING'

Type of the wallet: * AVAILABLE - operations available for payout. * WAITING - operations temporarily suspended for payout.

wallet.paymentOperator'PAYU' | 'P24' | 'AF' | 'AF_P24' | 'AF_PAYU'

Payment operator: * PAYU - operations processed by PAYU operator. * P24 - operations processed by PRZELEWY24 operator. * AF - operations processed by Allegro Finance operator. * AF_P24 - operations processed by Allegro Finance with PRZELEWY24. * AF_PAYU - operations processed by Allegro Finance with PAYU.

payment.idstring uuid

The payment ID.

participant.loginstring

Login of the participant. In case of REFUND_INCREASE operation this is the login of the seller, in other cases, of the buyer.

occurredAt.gtestring date-time

The minimum date and time of operation occurrence in ISO 8601 format.

occurredAt.ltestring date-time

The maximum date and time of operation occurrence in ISO 8601 format.

groupstring[]

Group of operation types: * INCOME - CONTRIBUTION, SURCHARGE, CORRECTION, DEDUCTION_INCREASE, LOAN_DEDUCTION_INCREASE, COMPENSATION, COMPENSATION_COD_INCREASE, TOP_UP, PAYOUT_SWEEP_INCREASE, PAYOUT_SWEEP_CANCEL_INCREASE. * OUTCOME - PAYOUT, PAYOUT_CANCEL, DEDUCTION_CHARGE, LOAN_DEDUCTION_CHARGE, COMPENSATION_COD_CHARGE, PAYOUT_SWEEP_CHARGE, PAYOUT_SWEEP_CANCEL_CHARGE. * REFUND - REFUND_CHARGE, REFUND_CANCEL, REFUND_INCREASE, CORRECTION, PROVIDER_REFUND_TRANSFER_CHARGE, PROVIDER_REFUND_TRANSFER_INCREASE. * BLOCKADES - BLOCKADE, BLOCKADE_RELEASE.

marketplaceId'allegro-pl' | 'allegro-cz'
Example:allegro-pl

The marketplace ID where operation was made. When the parameter is omitted, searches for operations with all marketplaces. Note, that there are operations not assigned to any marketplace.

currencystring

Currency of the operations.

limitinteger

Number of returned operations.

offsetinteger

Index of the first returned payment operation from all search results.

Headers

Accept-Language'en-US' | 'pl-PL' | 'uk-UA' | 'sk-SK' | 'cs-CZ' | 'hu-HU' BCP-47 language code

Expected language of messages.

Response

The payment operations history for given search criteria returned successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.