ChargeList

GEThttps://api.twisto.cz/psp/v4/charges
GEThttps://api.twisto.pl/psp/v4/charges

Get list of charges.

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123

Query Parameters

Param nameTypeDescriptionRequiredDefault valuesMin/Max values
dateFromstringDate limit from when charge was createdfalse
dateTostringDate limit to when charge was createdfalse
limitintegerRecords limitfalse20011000
skipintegerSkip number of recordsfalse0
statestringfalse

Responses

Body

  • count: integer
    Example 123
  • next: string<uri> or null
    Example http://api.example.org/accounts/?skip=400&limit=100
  • previous: string<uri> or null
    Example http://api.example.org/accounts/?skip=200&limit=100
  • items: array[object]
    • id: string
      required

      External ID of the charge

    • reference: string

      Order payment reference

    • amount: string<decimal>
      required

      Total amount

      Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
    • currency: string
      required

      ISO-4217 currency code

      >= 3 characters <= 3 characters
    • captured_amount: string<decimal>
      required

      Captured amount

      Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
    • refunded_amount: string<decimal>
      required

      Refunded amount

      Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
    • created_date: string<date-time>
      required

      Date when the order was created

    • receipt_number: string
      required

      Invoice external ID

    • product: string
      required

      Type of service

      Allowed values: Twisto Pay in three 
    • state: string
      required
      Allowed values: rejected authorised captured cancelled refunded error 

Response example

{ "count": 123, "next": "http://api.example.org/accounts/?skip=400&limit=100", "previous": "http://api.example.org/accounts/?skip=200&limit=100", "items": [ { "id": "string", "reference": "string", "amount": "812.00", "currency": "str", "captured_amount": "646.00", "refunded_amount": "299.00", "created_date": "string", "receipt_number": "string", "product": "Pay in three", "state": "captured" } ] }