API Reference

Create Mandate

post
http://localhost:8080/v1/payto/initiator/mandates

(For use by Initiator only)   Create a mandate and send via MMS to Payer for authorisation.

Body Params
creditorDetails
object
required

Creditor account details.

debtorDetails
object
required

Debtor account details.

string
length between 0 and 140

A mandate description.

uuid
required

Idempotency key generated by the client of the API. Used for request duplication check.

paymentTerms
object
required

Defines how payments should be triggered.

string
enum
required

The purpose of this mandate.

  • MORTGAGE: Mortgage payments.
  • UTILITY: Utility payments.
  • LOAN: Loan payments.
  • DEPENDANT: Dependant support payments.
  • GAMBLING: Gambling payments.
  • RETAIL: Retail payments.
  • SALARY: Salary payments.
  • PERSONAL: Personal payments.
  • GOVERNMENT: Government payments.
  • PENSION: Pension payments.
  • TAX: Tax payments.
  • OTHER: Other service payments.
string

Date time in UTC format yyyy-MM-dd'T'hh:mm:ss.sss'Z' e.g. 2023-09-10T10:00:00.000Z (Optional).

string

Indication of future transfer date, conditions of sale and requirement to hold funds.

date

The date when the mandate stops being valid.

date
required

The date when the mandate becomes valid.

Responses

Updated 11 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 months ago