Filter all payments

post

https://api.tryspeed.com/payments/filter

Filter the list of payments using this endpoint.

Body Params

ids

array of strings

Please specify the ids of the payments through which you want to filter the payments.

ids

status

array of strings

Defaults to paid

Please specify the status for which the list should be filtered.

status

amount

object

This parameter can be used to filter payments based on the amount. Please enter the amount into one of the following mutually exclusive parameters.

currency

array of strings

Please specify the currencies for which payments should be filtered. A three-lettered ISO-compliant currency name must be used.

currency

target_amount

object

This parameter can be used to filter payments based on the target_amount. Please enter the target_amount into one of the following mutually exclusive parameters.

target_currency

array of strings

Please specify the target currencies for which payments should be filtered.

target_currency

target_amount_paid

object

This parameter can be used to filter payments based on the target_amount_paid. Please enter the target_amount_paid into one of the following mutually exclusive parameters.

limit

int32

Defaults to 5

A limit specifies the number of objects to be returned, between 1 and 10. The default and maximum page size have 10 objects per page, and it is consistent across endpoints.

starting_after

string

This is one of the pagination parameters. Enter the ID of any payment object here to retrieve the next page of the list starting after the ID you specified. Starting after and ending before are mutually exclusive and can only be used once.

ending_before

string

This is one of the pagination parameters. Enter the ID of any payment object here to retrieve the previous page of the list ending before the ID you specified. Starting after and ending before are mutually exclusive and can only be used once.

created

object

This parameter can be used to filter payments based on the time they were created. Please enter the timestamp into one of the following mutually exclusive parameters.

Headers

speed-version

string

enum

Defaults to 2022-04-15

In this parameter, you can specify the version you want. As of now, there are two versions (2022-04-15 and 2022-10-15). Version 2022-10-15 supports on-chain, lightning, Ethereum, Tron and Solana payment methods. Whereas the 2022-04-15 version only supports lightning payments.

Allowed:

Response

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200