Skip to main content

Definition of terms

This API allows partners to access transactions from various payment providers.

PayData API

PayData API is a cloud service with a suite of interfaces to various payment providers, such as Amazon, PayPal, Klarna etc. It provides a single, uniform interface to detailed transaction data from all connected providers, so you don't need to build a separate integration for each one.

Partner

The developers of a software and/or the software development company that integrates this API.

Child-Partner

A partner created and managed by another partner, using that partner's partner token. A child-partner has its own users and accounts, separate from its parent's, but can be managed on the parent partner's behalf — see Partners and Users for how partners, child-partners, and users relate.

Partner software

A software system that uses PayData API functionality to get transactions from connected payment providers.

User

A technical representation of a company or user which groups a set of accounts in PayData. Each user must be registered by the partner and has its own set of accounts.

End User

A person using the partner software.

Payment Service Provider / PSP

A Payment Service Provider or PSP is a company or system that Users use to process payments, such as Amazon, PayPal, or Klarna.

Merchant

The business whose payments and balance a PSP account tracks — usually owned by the end user, and represented in PayData as a user. It's payments-industry terminology, used to describe transactions and payouts from the PSP's point of view (e.g. "moves the merchant's balance"), not a PayData API object.

Account

Settings and credentials, required to connect to a payment provider and authorize the user with that provider. After creating an account the user can read transactions from the payment provider. Each provider requires its own separate account to be created for each user.

Account type

Determines, to which payment provider to connect and describes settings and credentials required to make the connection.

OAuth2 redirect URL

A URL provided by the partner where the user is redirected to by the PayData API after a successful completion of the OAuth2 authentication process. Its purpose is to notify the partner software, that the OAuth2 authentication either completed successfully and account can be created or that an error has occurred.

Transaction

Information about an operation such as payment, refund or fee conducted through the payment provider.