Get list of payments

v1.0.0

Returns the entire list of all transactions, created with certain API key. The list of optional parameters:

limit - number of records in one page. (possible values: from 1 to 500)
page - the page number you want to get (possible values: from 0 to page count - 1)
sortBy - sort the received list by a paramenter. Set to created_at by default (possible values: payment_id, payment_status, pay_address, price_amount, price_currency, pay_amount, actually_paid, pay_currency, order_id, order_description, purchase_id, outcome_amount, outcome_currency)
orderBy - display the list in ascending or descending order. Set to asc by default (possible values: asc, desc)
dateFrom - select the displayed period start date (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ).
dateTo - select the displayed period end date (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ).

Input

{
  "type": "object",
  "properties": {
    "dateFrom": {
      "type": "string"
    },
    "dateTo": {
      "type": "string"
    },
    "limit": {
      "type": "string"
    },
    "orderBy": {
      "type": "string"
    },
    "page": {
      "type": "string"
    },
    "sortBy": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "actually_paid": {
            "type": "number"
          },
          "order_description": {
            "type": "string"
          },
          "order_id": {
            "type": "string"
          },
          "outcome_amount": {
            "type": "number"
          },
          "outcome_currency": {
            "type": "string"
          },
          "pay_address": {
            "type": "string"
          },
          "pay_amount": {
            "type": "number"
          },
          "pay_currency": {
            "type": "string"
          },
          "payment_id": {
            "type": "number"
          },
          "payment_status": {
            "type": "string"
          },
          "price_amount": {
            "type": "number"
          },
          "price_currency": {
            "type": "string"
          },
          "purchase_id": {
            "type": "string"
          }
        }
      }
    },
    "limit": {
      "type": "number"
    },
    "page": {
      "type": "number"
    },
    "pagesCount": {
      "type": "number"
    },
    "total": {
      "type": "number"
    }
  }
}