Channels

Every payment moves funds through payment channels. Each party on a payment — the debtor (the side funds leave) and the creditor (the side funds arrive) — carries a channels array describing how funds move on that side. Each entry is identified by its type field and may carry fields specific to that channel type.

Which channels you supply and which Zepto sets depends on the payment type — each endpoint's documentation states what to send. Every payment returned by the API — including the payments show and list endpoints — carries channels on both sides. For example, a payout paid from your float account via the New Payments Platform:

{
  "debtor": {
    "channels": [
      { "type": "float", "description": "Invoice 1042" }
    ]
  },
  "creditor": {
    "channels": [
      { "type": "npp.credit.outbound", "description": "Invoice 1042" }
    ]
  }
}

New channel types will be added over time. Consumers should ignore channel entries with an unrecognised type rather than treating them as an error.

NPP credit outbound

A creditor-side channel that you supply. Moves funds to the creditor in real time via the New Payments Platform. Use this for general payments.

FieldRequiredConstraintsDescription
typeYesAlways npp.credit.outbound.Payment channel type.
descriptionYes1–280 characters. ASCII-printable characters and unicode emojis.Description that both you and the creditor can see.
end_to_end_idNo1–35 ASCII-printable characters.End-To-End ID. An optional reference carried to the creditor unchanged.

NPP pension outbound

A creditor-side channel that you supply. Moves funds to the creditor in real time via the New Payments Platform. Use this for superannuation payments, which must carry a reference the creditor can reconcile against.

FieldRequiredConstraintsDescription
typeYesAlways npp.pension.outbound.Payment channel type.
descriptionYes1–280 characters. ASCII-printable characters and unicode emojis.Description that both you and the creditor can see.
end_to_end_idYes1–35 ASCII-printable characters.End-To-End ID. Set this to the Payment Reference Number (PRN).

DE credit outbound

🚧

Coming soon

This channel type is not yet available. It is planned for an upcoming release, and its details may change before then.

A creditor-side channel that you supply. Will move funds to the creditor through the direct entry system rather than in real time via the New Payments Platform.

FieldRequiredConstraintsDescription
typeYesAlways de.credit.outbound.Payment channel type.
descriptionYesTo be confirmed before release.Description that both you and the creditor can see.

Float

A channel set by Zepto. Represents your float account on whichever side of the payment it sits — the debtor side when funds move out of it, the creditor side when funds move into it.

FieldRequiredConstraintsDescription
typeYesAlways float.Payment channel type.
descriptionYes—Description of the payment channel entry.