Get notes

Credit and Debit Notes Endpoint

get

https://merchants-api.onekeypayments.com/v1https://merchants-api-stg.onekeypayments.com/v1

/notes

Access comprehensive details pertaining to all Credit and Debit Notes within a specified time frame.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fromintegerOptional

Transaction creation date interval in Unix TimeStamp format.

tointegerOptional

Transaction creation date interval in UnixTimeStamp format, max difference with 'from' value 60 days.

pageintegerOptional

The page number.

Default: 0

typestring · enumOptional

Credit/debit note types.

Possible values:

Responses

200

A paginated list of credit and debit notes.

application/json

get

/notes

HTTPcURLJavaScriptPython

GET /v1/notes HTTP/1.1
Host: merchants-api.onekeypayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A paginated list of credit and debit notes.

{
  "page": 0,
  "rows": 2,
  "maxRows": 50,
  "data": [
    {
      "id": 989851,
      "externalId": "",
      "idMerchant": 4,
      "merchantName": "Merchant Test",
      "date": "2020-02-13T14:04:53Z",
      "amount": 1000000,
      "currency": "USD",
      "type": "GENERIC_CREDIT_NOTE",
      "description": "test note",
      "category": "CREDIT"
    }
  ]
}