Skip to main content
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api-sandbox.superbank.co/v1/payments \
  --header 'X-Api-Key: <api-key>'

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
status
enum<string>

Filter by payment status

Available options:
AWAITING_FUNDS,
PENDING,
PROCESSING,
SENT,
COMPLETED,
CANCELED,
FAILED,
EXPIRED,
REFUNDED,
SCHEDULED,
UNDER_REVIEW
Example:

"COMPLETED"

​
page
number
default:1

Page number for pagination

Required range: x >= 1
​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100

Response

Payments retrieved successfully