Skip to main content
GET
/
payments
List payments
curl --request GET \
  --url https://api.shoppex.io/dev/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "uniqid": "<string>",
      "type": "<string>",
      "shop_id": "<string>",
      "customer_id": "<string>",
      "currency": "<string>",
      "gateway": "<string>",
      "crypto_address": "<string>",
      "crypto_amount": 123,
      "crypto_received": 123,
      "crypto_uri": "<string>",
      "crypto_confirmations_needed": 123,
      "quantity": 123,
      "total": 123,
      "total_display": 123,
      "exchange_rate": 123,
      "crypto_exchange_rate": 123,
      "customer_email": "<string>",
      "custom_fields": [
        "<unknown>"
      ],
      "is_developer_invoice": true,
      "developer_title": "<string>",
      "developer_webhook": "<string>",
      "developer_return_url": "<string>",
      "developer_cancel_url": "<string>",
      "status": "<string>",
      "created_at": 123,
      "updated_at": 123,
      "gateways": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Use your API key with the Bearer scheme. Get your key from Dashboard → Settings → API Keys. Format: Authorization: Bearer shx_...

Query Parameters

cursor
string

Pagination cursor

limit
integer
default:50
Required range: 1 <= x <= 100
status
enum<string>
Available options:
PENDING,
COMPLETED,
VOIDED,
WAITING_FOR_CONFIRMATIONS,
PARTIAL,
CUSTOMER_DISPUTE_ONGOING,
REVERSED,
REFUNDED

Response

Default Response

data
object[]
required
pagination
object
required