API Documentation

You need to authenticate each requests using your unique access token. If you are logged in, your access token is inserted in the below URLs.

Payments

Get a payment status

GET https://eliopay.com/api/payments/{paymentId}?token={Access Token}

Example result:

{
    "id": "2d857dcc0f4ab1956e050971e4f1", // Unique ID of the payment
    "source": "stripe", // Either "stripe", "paypal" or "shapeshift"
    "status": "complete", // Can be complete, partial (if crypto) or imcomplete
    "coupons": [], // Coupons used (for future)
    "parentAccount": "a2cze6d3181ga4fsb73ddb80", // Your account id
    "parentForm": "29bba6d5488bb4f0b7ed0381", // The id of the origin form
    "testMode": false, // If running in test mode
    "amount": 39, // Amount of payment
    "quantity": 1, // Quantity of the sold product, if you asked for it (1 by default)
    "convertedAmount": null, // If paid in crypto or other currency, the converted amount
    "confirmations": null, // If crypto, the numbers of confirmations of the payment
    "currency": "USD", // Currency of the original payment
    "proof": "se5162HE78S9ujhgf", // Payment id @ the service (shapeshift/stripe or paypal)
    "buyer": {
        "email": "[email protected]", // Email address of the buyer
        "name": null, // Name of the buyer, if you asked for it
        "shipping": null // Shipping address of the buyer, if you asked for it (for future)
    }
}

Get payments made by a specific email

GET https://eliopay.com/api/payments/email/{email}?token={Access Token}

It will return an array of payments objects (see above).

Get all payments

GET https://eliopay.com/api/payments?token={Access Token}

It will return an array of payments objects (see above).