Payouts

Get a payout

Returns a single payout by its UID.

get/payments/payouts/{uid}

Request

  • Base URL
    https://api.sandbox.zeptopayments.com
  • URL
    https://api.sandbox.zeptopayments.com/payments/payouts/{uid}
  • Auth
    HTTP bearer

Path parameters

uidstring required

The UID of the payout

Response

successful

Example response

{
  "data": {
    "amount": 50000,
    "status": "queued",
    "initiation_type": "payout",
    "debtor": {
      "identity": {
        "type": "inline",
        "party_name": "Zepto Merchant",
        "account_identifier": {
          "type": "bban",
          "value": "062000-12345678"
        }
      },
      "channels": [
        {
          "type": "float",
          "description": "Invoice 1042"
        }
      ]
    },
    "creditor": {
      "identity": {
        "type": "inline",
        "party_name": "End User",
        "account_identifier": {
          "type": "bban",
          "value": "802919-12345678"
        }
      },
      "channels": [
        {
          "type": "npp.credit.outbound",
          "description": "Invoice 1042",
          "end_to_end_id": "e2e-001"
        }
      ]
    },
    "uid": "payout-uid-123",
    "client_id": "019cc090-1111-7222-8333-444455556666",
    "description": "Supplier payment",
    "priority": "normal",
    "errors": [
      {
        "code": "ZIS01",
        "title": "Bad Request",
        "detail": "The request parameters are invalid.",
        "links": {
          "about": "https://docs.zeptopayments.com/docs/zepto-api#authentication-and-authorisation"
        }
      }
    ],
    "scheduled_after": "2026-03-18T00:00:00Z",
    "timing": {
      "added_at": "2026-03-17T00:00:00Z",
      "queued_at": "2026-03-17T00:00:01Z",
      "finalised_at": "2026-03-17T00:00:05Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.