Retrieve all payments

get

https://authservices.satispay.com/g_agent/v1/pagopa/payments

📘
Choose the correct endpoint
Keep in mind the endpoint you need to call, depending on your environment:

production: https://authservices.satispay.com/

staging: https://staging.authservices.satispay.com/

Payment pagination

Payments returned by this API are paginated with a default limit of 20 items. The has_more boolean field tells you if there are more payments than the limit used and you should use the starting_after parameters filled with the id of the last payment if you want to retrieve the next page of the list.

If you want to list all Payments for specific date you should:
1 - call the Get payment list using the parameter starting_after_timestamp and using the timestamp in milliseconds of the date you want
2 - save the last payment id returned at step 1
3 - call the Get payment list using the parameter starting_after and using the payment id you saved at the step 2
4 - save the last payment id returned at step 3
5 - repeat step 4 until you reach the last payment of the date you need

📘
starting_after and starting_after_timestamp parameters are cursors within the list of payments that is ordered by creation date from the newest and this means that payments returned with this filters are sequentially after, and not temporarily after, the id or the timestamp used.

Query Params

iuv

string

Unique payment identifier, if iuv is provided, also domain_id must be provided

domain_id

string

The EC(Ente Creditore) identifier, if domain_id is provided, also iuv must be provided

status

string

Status of the payment. If not provided, only accepted payments will be returned [APPROVED, PENDING or CANCELED]

starting_after

string

Cursor to use in pagination. Starting_after is the id that defines your place in the list. If you make a list request and receive 100 objects, ending with "xyz", your subsequent call can include starting_after="xyz" in order to fetch the next page of the list

starting_after_timestamp

string

Is the timestamp (in milliseconds) that defines your place in the list when you make a payment list request.

Please keep in mind that payments are ordered in descending order based on their creation dates, and this filter operates sequentially.

Headers

Host

string

The host declared in the signature

Date

string

The date declared in the signature

Digest

string

The digest declared in the signature

Authorization

string

The signature of the request

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Choose the correct endpoint

Payment pagination

200200

400400