Our API Docs just got a new look!

Get notes

Credit and Debit Notes Endpoint

get

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

Authorizations
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
Responseall of
get
GET /v1/notes HTTP/1.1
Host: merchants-api.directa24.com
Authorization: Bearer JWT
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"
    }
  ]
}

Last updated

Was this helpful?