How it works

PayOut to PayID lets you pay a recipient using a PayID instead of collecting their BSB and account number. Supply the recipient details directly in the PayOut request and Zepto sends the payment from your Float Account via NPP.

Before you start

You'll need a Zepto Float Account configured for payments, a valid API access token, and the client ID that the PayOut should be attributed to.

Step 1 - Create a PayOut

Create a PayOut with your Float Account as the debtor and the PayID recipient as the creditor. For a standard PayID payment, supply exactly one creditor channel with the type npp.credit.outbound.

{
  "amount": 50000,
  "description": "Supplier payment",
  "priority": "normal",
  "debtor": {
    "identity": {
      "type": "inline",
      "account_identifier": {
        "type": "bban",
        "value": "802919-12345678"
      }
    }
  },
  "creditor": {
    "identity": {
      "type": "inline",
      "party_name": "End User",
      "account_identifier": {
        "type": "alias_email",
        "value": "[email protected]"
      }
    },
    "channels": [
      {
        "type": "npp.credit.outbound",
        "description": "Invoice 1042"
      }
    ]
  },
  "uid": "payout-uid-001",
  "client_id": "019b76da-a800-7c5e-8f3a-9d21e4b7c012"
}

{
  "data": {
    "uid": "payout-uid-001",
    "client_id": "019b76da-a800-7c5e-8f3a-9d21e4b7c012",
    "amount": 50000,
    "status": "queued",
    "initiation_type": "payout",
    "creditor": {
      "identity": {
        "type": "inline",
        "party_name": "End User",
        "account_identifier": {
          "type": "alias_email",
          "value": "[email protected]"
        }
      },
      "channels": [
        {
          "type": "npp.credit.outbound",
          "description": "Invoice 1042"
        }
      ]
    },
    "description": "Supplier payment",
    "priority": "normal",
    "errors": [],
    "scheduled_after": null,
    "timing": {
      "added_at": "2026-01-01T00:00:00Z",
      "queued_at": "2026-01-01T00:00:00Z",
      "finalised_at": null
    }
  }
}

Schedule a PayOut

If the PayOut should be processed later, include scheduled_after. You can schedule a PayOut up to one week in advance.

{
  "...": "...",
  "priority": "normal",
  "scheduled_after": "2026-01-03T00:00:00Z"
}

Step 2 – Track the PayOut Lifecycle

PayOuts are processed asynchronously. A successful create request confirms that Zepto accepted the PayOut—it does not mean the recipient has received the funds.

Step 3 – Receive the final outcome via webhook

The Payments API publishes webhooks to notify your application of asynchronous events on the payments you initiate. Each webhook is delivered as a POST request to a URL registered against your Zepto account, with a JSON body describing the event.

Payout lifecycle

Every payout ends with a single payments_payout.finalised event. Statuses on the left, the webhook on the right:

payout ─┬─► settled ───────────────────────────────► payments_payout.finalised
        │
        ├─► cancelled ─────────────────────────────► payments_payout.finalised
        │
        └─► failed ──► any debited funds returned ─► payments_payout.finalised

body.status tells you how the payout ended: settled when the funds are available to the creditor, cancelled when the payout was cancelled, or failed with the reasons in body.errors.

For a failed payout, payments_payout.finalised is only sent once any funds debited for it are back in the debtor's account, so it is always safe to retry the payout or arrange a fallback payment when it arrives. Until then, fetching the payout may already show status: failed with timing.finalised_at still null; finalised_at is set when payments_payout.finalised is sent.

{
  "data": {
    "uid": "payout-uid-123",
    "type": "payments_payout.finalised",
    "published_at": "2026-05-07T02:34:57Z",
    "metadata": { "order_id": "abc-123" },
    "body": {
      "status": "failed",
      "errors": [
        {
          "code": "ZIS99",
          "title": "Unknown Payment Error",
          "detail": "An unknown error occurred while processing the payment. Please contact Zepto for assistance."
        }
      ]
    }
  }
}

Error handling

Your integration should handle both synchronous API errors and payment failures that occur asynchronously after the PayOut has been accepted.

Sandbox Simulations

Sandbox lets you trigger deterministic payment failures by sending specific amounts. Use these simulations to test how your integration handles different PayOut outcomes.

Integration Checklist