ZEzeptopayments
Transactions

List all transactions

Changed on
<aside class="notice">By default, Zepto will search and return all transactions created in the <strong>last 30 days</strong>. You can adjust this up to <strong>1 year</strong> by defining the <code>min_created_date</code> query string parameter defined below.</aside>
get/transactions

Request

  • Base URL
    https://api.sandbox.zeptopayments.com
  • URL
    https://api.sandbox.zeptopayments.com/transactions
  • Auth
    OAuth 2
    Authorization code: /oauth/authorize
    Token URL: /oauth/token

Query parameters

pagestring

Page of results to return, single value, exact match

per_pagestring

Number of results per page, single value, exact match

ref (debit or credit)string

Single value, exact match

parent_refstring

Single value, exact match

bank_refstring

Single value, exact match

both_partiesboolean

Single value, exact match. Will also list debits & credits applied to the other party

statusstring[]

Multiple values, exact match

categorystring[]

Multiple values, exact match

typestring[]

Multiple values, exact match

other_partystring

Single value, string search. Cannot be combine with <code>both_parties</code> query string

other_party_bank_refstring

Single value, exact match

party_contact_idstring

Single value, exact match. Cannot be combine with <code>both_parties</code> query string

descriptionstring

Single value, string search

min_amountinteger

Cents, single value, exact match

max_amountinteger

Cents, single value, exact match

min_created_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

max_created_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

min_matured_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

max_matured_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

min_cleared_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

max_cleared_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

min_status_changed_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

max_status_changed_datestring date-time

Date/time UTC ISO 8601 format, single value, exact match

Response

OK

Example response

{
  "data": [
    {
      "ref": "D.3",
      "parent_ref": null,
      "type": "debit",
      "category": "payout_refund",
      "created_at": "2021-04-07T23:15:00Z",
      "matured_at": "2021-04-07T23:15:00Z",
      "cleared_at": "2021-04-10T23:15:00Z",
      "bank_ref": "DT.9a",
      "status": "cleared",
      "status_changed_at": "2021-04-10T23:15:00Z",
      "party_contact_id": "31354923-b1e9-4d65-b03c-415ead89cbf3",
      "party_name": "Sanford-Rees",
      "party_nickname": null,
      "party_bank_ref": "CT.11",
      "description": null,
      "amount": 20000,
      "bank_account_id": "56df206a-aaff-471a-b075-11882bc8906a",
      "channels": [
        "float account"
      ],
      "current_channel": "float_account"
    },
    {
      "ref": "D.2",
      "parent_ref": "PB.2",
      "type": "debit",
      "category": "payout",
      "created_at": "2016-12-06T23:15:00Z",
      "matured_at": "2016-12-09T23:15:00Z",
      "cleared_at": null,
      "bank_ref": null,
      "status": "maturing",
      "status_changed_at": "2016-12-06T23:15:00Z",
      "party_contact_id": "3c6e31d3-1dc1-448b-9512-0320bc44fdcf",
      "party_name": "Gutmann-Schmidt",
      "party_nickname": null,
      "party_bank_ref": null,
      "description": "Batteries for hire",
      "amount": 2949299,
      "bank_account_id": "56df206a-aaff-471a-b075-11882bc8906a",
      "channels": [
        "float_account"
      ],
      "current_channel": "float_account"
    },
    {
      "ref": "C.2",
      "parent_ref": "PB.s0z",
      "type": "credit",
      "category": "payout",
      "created_at": "2016-12-05T23:15:00Z",
      "matured_at": "2016-12-06T23:15:00Z",
      "cleared_at": "2016-12-09T23:15:00Z",
      "bank_ref": "CT.1",
      "status": "cleared",
      "status_changed_at": "2016-12-09T23:15:00Z",
      "party_contact_id": "33c6e31d-1dc1-448b-9512-0320bc44fdcf",
      "party_name": "Price and Sons",
      "party_nickname": "price-and-sons-2",
      "party_bank_ref": null,
      "description": "Online purchase",
      "amount": 19999,
      "bank_account_id": "c2e329ae-606f-4311-a9ab-a751baa1915c",
      "channels": [
        "new_payments_platform",
        "direct_entry"
      ],
      "current_channel": "direct_entry",
      "metadata": {
        "customer_id": "xur4492",
        "product_ref": "TSXL392110x"
      }
    }
  ]
}

Changes