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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≤ 1000000000

Amount in cents

debtor
object
required
creditor
object
required
string
required
length between 1 and 64
^[A-Za-z0-9\-._~]+$

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

uuid
required

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

string
required
length between 1 and 280

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

string
enum
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.

Allowed:
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.

metadata
object | null

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.

Headers
string
^\d{8}$
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

403

forbidden

500

Internal Server Error

Callback
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json