Skip to main content
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api.plexospay.com/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pi_abc123",
      "externalId": "<string>",
      "amount": "10000",
      "currency": "CVE",
      "feeAmount": "200",
      "netAmount": "9800",
      "operator": "CVMOVEL",
      "operatorPhone": "+2389001234",
      "operatorTxId": "<string>",
      "status": "CREATED",
      "failureCode": "<string>",
      "failureMessage": "<string>",
      "description": "<string>",
      "statementDescriptor": "<string>",
      "customerId": "<string>",
      "metadata": {},
      "expiresAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true
}

Authorizations

Authorization
string
header
required

API key starting with sk_live_ or sk_test_

Query Parameters

limit
integer
default:20

Max items per page (1-100)

Required range: 1 <= x <= 100
starting_after
string

Cursor — ID of the last item from previous page

status
enum<string>
Available options:
CREATED,
OPERATOR_PENDING,
USER_CONFIRMING,
DEBITED,
SETTLED,
FAILED,
EXPIRED,
REFUNDED,
PARTIALLY_REFUNDED,
CANCELLED

Response

200 - application/json

Paginated list of payments

data
object[]
hasMore
boolean