Skip to main content

💳 Payment API Documentation

🔐 Authorization​

All API requests must include the following body:

public_key: <Website Public Key>
Base Url
https://api.listopays.com

🧾 Create a Payment​

POST payments

Request​

{
  "customer": "9e4d09cb-2913-4020-a0b5-a905dcc9f35c",
  "order": "Something about order",
  "amount": 128,
  "currency": "EUR",
  "public_key": <Website Public Key>
}

The currency field is optional. When provided, it must be one of the following supported currencies:

  • EUR
  • USD
  • GBP
  • ISL

Response​

{
    "success": true,
    "error": null,
    "data": {
        "url": "https://pay.listopays.com/payment/0MvVe7YnAEnoXJIaboADpF4rocb2AknJ"
    }
}

↩️ Refund a Payment​

POST payment/{payment_token}/refund

Request​

{
  "public_key": <Website Public Key>
}

Response​

{
    "success": true
}

👤 Create a Customer​

POST customers

Request​

{
    "name": "John",
    "email": "[email protected]",
    "public_key": <Website Public Key>
}

Response​

{
    "success": true,
    "data": {
        "uuid": "2dcace1d-2846-4242-8596-0ebfbd1a8379"
    }
}

👥 Get All Customers​

GET customers

Request​

{
  "public_key": <Website Public Key>
}

Response​

{
    "success": true,
    "data": [
        {
            "uuid": "2dcace1d-2846-4242-8596-0ebfbd1a8379",
            "name": "John",
            "email": "[email protected]"
        }
    ]
}

Customer Charge​

POST charge

Request​

{
  "customer": "9e4d09cb-2913-4020-a0b5-a905dcc9f35c",
  "order": "Something about order",
  "amount": 128,
  "public_key": <Website Public Key>
}

Response​

{
    "success": true,
    "error": null,
    "data": null
}

🏷️ Get the Payment Descriptor​

Use this endpoint to get the payment descriptor for the latest successful transaction.

GET descriptor

Request​

Pass the website public key as a query parameter:

GET https://api.listopays.com/descriptor?public_key=<Website Public Key>

Response​

{
  "success": true,
  "descriptors": ["MY SHOP"]
}

ℹ️ Notes​

  • All responses contain a success field indicating operation result.
  • On error, an error field may be included with the description.
  • All requests require a valid X-PUBLIC-KEY header.