API Documentation

Get shop payments

get
https://authservices.satispay.com/g_business/v1/payments

API to retrieve the list of payments for a specific shop.
The payments will be shop scoped based on the KeyID used in the authorisation header.

This api is useful when implementing the One-off - Check In payment flow.
It can be used to retrieve a list of PENDING payments that will need to be accepted.

Payment Pagination

Payments returned by this API are paginated with a default limit of 20 items per page. The has_more boolean field indicates if there are additional payments beyond the current limit. To retrieve the next page of payments, use the starting_after parameter, providing the ID of the last payment from the current page.

Listing All Payments for a Specific Date

To list all payments for a specific date, follow these steps:

  1. Call the "Get shop payments" endpoint with the starting_after_timestamp parameter, using the timestamp in milliseconds for the desired date.
  2. Save the ID of the last payment returned in this step.
  3. Call the "Get shop payments" endpoint again, this time using the starting_after parameter with the payment ID saved from step 2.
  4. Save the ID of the last payment returned in this step.
  5. Repeat step 4 until you have retrieved all payments for the specified date.
📘

The starting_after and starting_after_timestamp parameters act as cursors within the ordered list of payments, which is sorted by creation date from newest to oldest.
This means that the payments returned using these parameters will be sequentially after (not temporally after) the specified ID or timestamp.

REQUEST

Query Params
string
enum
Defaults to ACCEPTED

Filter by the payment status.

ACCEPTED
Shows all the payments in ACCEPTED status.

PENDING
Shows all the payments in PENDING status.

CANCELED
Shows all the payments in CANCELED status.

Defaults to ACCEPTED if not specified.

Allowed:
integer
1 to 100
Defaults to 20

Set a limit on the number of returned payments in the response.

string

The ID of the last payment from the previous page.
Used to retrieve the next set of payments in the list.

string

The timestamp in milliseconds from which to start listing payments.
Used to retrieve payments created after the specified timestamp.

Headers
string
required

The host declared in the signature.

string
required

The date declared in the signature.

string
required

The digest declared in the signature.

string
required

The request signature.

string

The device information (e.g., hostname).

string
enum

The device type.

Allowed:
string

The Operating System name (e.g., Windows).

string

The Operating System version (e.g., 10).

string

The software house name (e.g., Satispay).

string

The software name (e.g., My awesome app).

string

The software version (e.g., v2.0.0).

string

The tracking code used by Satispay commercial partners.

Use this code only if explicitly required by Satispay.

Responses

Updated 10 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago