Skip to main content
GET
Get Stockback Payments

Authorizations

x-api-key
string
header
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Scopes

etoro-public:real:read

Grants access to the 'etoro-public:real:read' scope.

etoro-public:demo:read

Grants access to the 'etoro-public:demo:read' scope.

etoro-public:trade.real:read

Grants access to the 'etoro-public:trade.real:read' scope.

etoro-public:trade.demo:read

Grants access to the 'etoro-public:trade.demo:read' scope.

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"3743b012-1a0e-406b-9d01-3a49f2a31cf6"

Query Parameters

page
integer<int32>
default:1

1-based page number to return.

Required range: x >= 1
pageSize
integer<int32>
default:50

Items per page. Defaults to 50, maximum 500.

Required range: 1 <= x <= 500

Response

One page of the caller's stockback payments, newest payment date first.

One page of the caller's stockback payments. The collection is a property of this object rather than a bare top-level array, so further fields can be added without a breaking change.

results
object[]
required

Payments for this page, newest payment date first.

pagination
object
required

Offset pagination metadata for a collection response.