v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB

Payments

list payments

get/payto/payments

Query parameters

per_pageinteger

Number of results per page

starting_afterstring

Opaque pagination cursor value. Set by following "next" links.

statestring[]

Filter payments by state. Multiple values can be separated by commas.

min_created_datestring date

Filter by minimum created_at date. ISO8601 format.

max_created_datestring date

Filter by maximum created_at date. ISO8601 format.

agreement_uidstring

Filter payments by agreement.

agreement_initiator_namestring

Filter payments by initiator name. The filtering is case sensitive and must be an exact match.

refunds'included' | 'excluded' | 'only'

Filter payments by whether or not they are facilitating a refund.

Response

successful

Example response

{
  "data": [
    {
      "uid": "biz_20221231_G7MQWwkQZIP8vbfH",
      "agreement_uid": "Agreement_00012345",
      "source_payto_refund_uid": "Refund_00012345",
      "reference": "INVOICE #1003",
      "description": "Payment 1 of 6 for Zeptinghouse Smart Fridge 300L",
      "creditor": {
        "party_name": "Jane Smith",
        "ultimate_party_name": "Jane Smith",
        "account_identifier": {
          "value": "123456-98765432"
        }
      },
      "creditor_reference": "PYMNT-1003",
      "debtor": {
        "ultimate_party_name": "Bob Jane",
        "party_name": "Bob Jean",
        "account_identifier": {
          "value": "123456-98765432"
        }
      },
      "amount": 2495,
      "metadata": {
        "custom_key": "custom_value"
      },
      "failure": {
        "title": "Agreement Status Invalid",
        "detail": "Contact Zepto for more information - The requested operation cannot be performed for the current status of the agreement",
        "code": "MMS.API.9104"
      },
      "links": {
        "self": "https://api.zeptopayments.com/payto/payments/biz_payment_G7MQWwkQZIP8vbfH",
        "agreement": "https://api.zeptopayments.com/payto/agreements/biz_agreement_G7MQWwkQZIP8vbfH",
        "source_refund": "https://api.zeptopayments.com/payto/refunds/biz_refund_G7MQWwkQZIP8vbfH"
      }
    }
  ]
}