Version: 1.2.0-preview

PayData API

Guide

This API allows PayData partners to set up webhooks.

Definition of terms

PayData API

PayData API is a cloud service with a suite of interfaces to various payment providers, such as Amazon, PayPal, Klarna etc. The interface portfolio of PayData offers a uniform access to detailed transactions data from all the connected providers without the need to implement a separate interface for each provider.

Partner

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

Partner software

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

Webhooks

Webhooks allow partners to subscribe to events in PayData. When an events occurs, PayData sends an HTTP POST notification to the callback URL configured for the webhook.

Changelog

Version 1.1.1 (preview) (05.02.2025)

• Breaking changes:
  • POST /webhooks/test-account-type-events endpoint removed, use POST /testevents/accounttypeupdated entpoint instead.
  • POST /webhooks/test-account-events endpoint removed, use POST /testevents/accountcreated, POST /testevents/accountupdated and POST /testevents/accountdeleted entpoints instead.
  • POST /webhooks/test-import-events endpoint removed, use POST /testevents/transactionsimported entpoint instead.
  • POST /webhooks/test-events endpoint removed, use TestEvents controller instead.
• Add TestEvents controller with the following endpoints:
  • POST /testevents/accounttypeupdated - to send a test AccountTypeUpdated notification to test the AccountTypeUpdated event
  • POST /testevents/accountcreated - to send a test AccountCreated notification to test the AccountCreated event
  • POST /testevents/accountupdated - to send a test AccountUpdated notification to test the AccountUpdated event
  • POST /testevents/accountdeleted - to send a test AccountDeleted notification to test the AccountDeleted event
  • POST /testevents/transactionsimported - to send a test TransactionsImported notification to test the TransactionsImported event

Version 1.1.0 (preview) (11.12.2024)

• Add Notifications for these event types:
  • AccountTypeUpdated - account type updated (provides information about the current state of the corresponding PSP)
• Add Webhooks controller endpoints (preview):
  • POST /webhooks/test-account-type-events - to send a test AccountTypeUpdated notification
  • POST /webhooks/test-account-events - to send a test AccountCreated, AccountUpdated or AccountDeleted notification
  • POST /webhooks/test-import-events - to send a test TransactionsImported notification

Version 1.0.4 (preview) (05.11.2024)

• Breaking change: TransactionsImportError event is not triggered any more, TransactionsImported event is trigered instead.
• Breaking change: AccountError event is not triggered any more, AccountUpdated event is trigered instead.
• Add Notifications for these event types:
  • AccountUpdated - account updated
  • AccountDeleted - account deleted
• Add errors and warnings to the account, report and data import objects.

Version 1.0.3 (preview) (26.08.2024)

• Add Notifications for these event types:
  • TransactionsImportError - an error occurred while importing transactions
  • AccountError - a problem with the account is detected, i.e. credentials validation error

Version 1.0.2 (preview) (13.08.2024)

• Breaking change: ReportImported event is not triggered any more, TransactionsImported event is trigered instead.
• Add report info to notifications of the TransactionsImported event type. This event is triggered when transactions are successfully imported with or without a report.
• Add Notifications for these event types:
  • AccountCreated - account successfully created

Version 1.0.1 (preview) (26.07.2024)

• Add Notifications for these event types:
  • TransactionsImported - transactions successfully imported
• Add support for TransactionsImported event to the test webhook CreateTestEvent endpoint

Version 1.0.0 (preview) (01.07.2024)

• Add Webhooks controller with endpoints (preview):
  • POST /webhooks - to create a webhook
  • GET /webhooks - to get a list of webhooks
  • GET /webhooks/{id} - to get a single webhook
  • PUT /webhooks/{id} - to update a webhook
  • PATCH /webhooks/{id} - to patch a webhook
  • DELETE /webhooks/{id} - to delete a webhook
  • POST /webhooks/test-events - to test a webhook
• Add Notifications for these event types:
  • ReportImported - a new report with transactions successfully received and imported

Rate limiting

The following global rate limiting policies apply to all requests, sent to the API from a partner or from a user:

Period (seconds)	Maximum number of requests
60	100

Additional rate limiting policies may apply to some methods and are described for each particular method.

Authentication

HTTP: Bearer Auth

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT

HTTP: Bearer Auth

Partners are authenticated by the PayData API with JWT bearer tokens. JWT tokens allow partners to change their settings, create and manage other "child" partners and manage users. Initially a partner gets a JWT token from the support. After that the partner can manage their tokens depending on permissions.

Partner tokens with a lifetime of more than one hour get an ID, that can be used later to revoke the tokens if necessary.

All calls to the PayData API from the partner should contain a JWT bearer token in the HTTP header Authorization.

JWT tokens, used by partners, should not be shared with users.

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT

HTTP: Bearer Auth

Users similar to partners are authenticated by the PayData API with JWT bearer tokens. JWT tokens allow users to manage accounts and read transactions. When a partner creates a user in with the CreateUser method, the HTTP response contains a JWT bearer token generated for the user. Subsequent calls from that user should contain that token in the HTTP header Authorization. The value of the header should be Bearer plus whitespace character plus the token. The validity time of the token in seconds is specified in the userTokenExpirySeconds setting of the partner. After that time the partner should use the CreateUserToken method to obtain a new valid token for the user.

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT