v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB

Refunds (Beta)

list refunds

get/payto/refunds

Query parameters

per_pageinteger

Number of results per page

starting_afterstring

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

min_created_datestring date

Filter by minimum created_at date. ISO8601 format.

max_created_datestring date

Filter by maximum created_at date. ISO8601 format.

original_payment_uidstring

Filter refunds by original payment uid.

Response

successful

Example response

{
  "data": [
    {
      "uid": "biz_refund_20221231_G7MQWwkQZIP8vbfH",
      "original_payment_uid": "Payment_00012345",
      "refund_payment": {
        "amount": 2495,
        "description": "REFUND: 1 of 6 for Zeptinghouse Smart Fridge 300L"
      },
      "metadata": {
        "custom_key": "custom_value"
      },
      "failure": {
        "title": "The provided fund source has insufficient funds",
        "detail": "The provided fund source has insufficient funds to process this refund",
        "code": "ZPREF07"
      },
      "links": {
        "self": "https://api.zeptopayments.com/payto/refunds/biz_refund_G7MQWwkQZIP8vbfH",
        "original_payment": "https://api.zeptopayments.com/payto/payments/biz_payment_G7MQWwkQZIP8vbfH"
      }
    }
  ]
}