Payouts

Create a payout

Creates a new payout, moving funds from your float account to the recipient. Supply exactly one creditor channel of type npp.credit.outbound or npp.pension.outbound.

post/payments/payouts

Request

Base URL
https://api.sandbox.zeptopayments.com
URL
https://api.sandbox.zeptopayments.com/payments/payouts
Auth
HTTP bearer

Request body

amountinteger required

Amount in cents

uidstring required

A unique identifier for the payment, using RFC3986 unreserved characters.

client_idstring uuid required

Identifier of the client the payout is attributed to. Must be a client on your account.

descriptionstring required

Only visible to the initiator. ASCII-printable characters and unicode emojis are accepted.

priority'normal' | 'high' required

Processing priority. normal payouts are batched, trading a small processing delay for the best throughput; high payouts are processed individually for the lowest latency. See the Priority page for guidance on choosing.

scheduled_afterstring date-time

Hold the payout until after this time instead of processing it immediately. At most 1 week ahead. A time earlier today (Australia/Sydney) is processed immediately; anything before today is rejected. Requires normal priority.

metadataobject nullable

Use for your custom data. A place to store any miscellaneous information your system may need in regards to the record you are creating. This will be included in associated webhook payloads under the metadata key. Nested values (i.e., objects and arrays) are not allowed. The maximum size of this parameter is 2kb.

Example request

{
  "amount": 50000,
  "debtor": {
    "identity": {
      "type": "inline",
      "account_identifier": {
        "type": "bban",
        "value": "802919-12345678"
      }
    }
  },
  "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-001",
  "client_id": "019cc090-1111-7222-8333-444455556666",
  "description": "Supplier payment",
  "priority": "normal",
  "scheduled_after": "2026-03-18T00:00:00Z"
}

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.