Payments

Get list of payments

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);
  • invoiceId - filtering payments by certain invoice ID;
  • 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);
get/v1/payment/

Request

Query parameters

limitinteger

The limit of items listed in one page of response body. Possible values: from 1 to 500

pageinteger

If amount of items is more than specified in 'limit' parameter, you can switch pages with this one. Possible values: from 0 to last existing page number digit.

sortBystring

Sorting by a certain parameter value

orderBystring

Set the order of listed items. It can be 'asc' or 'desc'

dateFromstring

Parameters for filtering items by certain dates

dateTostring

Parameters for filtering items by certain dates

invoiceIdinteger

Filtering items by certain invoice ID

Headers

x-api-keystring

(Required) Your NOWPayments API key

Response

200

object required

Changes

No recorded changes to this operation across all 1 revision of this API.