WorkspaceDarkLight
Contents

API reference

Payments

Movement with a record. Open the product

GET/v1/paymentsOpen ↗

Describes this API: what it takes and what it returns.

POST/v1/payments/abaKey

A BECS direct entry file, or the reasons it was refused

Body
{header, trace, remitter, items, balance?}

POST/v1/payments/debitsKey

The debits to raise on a day

Body
{on, accounts: [{reference, terms, events, authority}]}

POST/v1/payments/returnKey

A returned debit as ledger events and conduct

Body
{payment, code, on}

POST/v1/payments/paytoKey

A PayTo agreement replayed

Body
{events: [{to, on, by}]}

POST/v1/payments/reconcileKey

Body
{expected, settled}

POST/v1/payments/payoutsKey

Body
{contracts: [{reference, state, amount, payee, nameCheck}]}