PayTo Service Guide
Overview
PayTo is an improvement on the existing Direct Debit function, allowing payments to be mandated and completed in real time.
NPPA background video: PayTo - Modern alternative to direct debit
For example, Person A pays for dinner then sends a mandate request with their PayID to the other 5 people. The others can accept and pay immediately. Payments can also be split out over time, allowing regular payback of debts.
Or, a gym wants to set up recurring payments with a first payment being taken on site to secure the contract. Previously this would involve a DD setup plus initial card payment. PayTo allows all this in one flow.
PayTo encompasses:
- Initiation of Payment Messages generated by third parties, to request payments from a customer’s bank account. Those payment requests are associated with a ‘mandate’ - a customer authorised payment arrangement.
- A centralised record for creating, storing and maintaining mandates. The database for this is owned and operated by NPP Australia.
- Business rules providing assurance that the payment initiation messages will be handled by the customer’s financial institution.
Key use case examples
- Instant Direct Debits. PayTo replaces the slower existing direct debits system. Batched direct debits can be subject to delays of several days – with failed payments a particular frustration. Via PayTo, money is debited, settled and cleared instantly.
- Instant payroll and disbursements. No need for large floats of cash sitting awaiting disbursement. Payroll and large supplier payment situations can benefit from instant movement of money.
- Control (where authorised) over movement of money between third parties. PayTo allows for the initiator of the transaction and the receiver of the transaction to be different entities. Unlike standard direct debits, a company could instruct funds to be taken from its customer and credit a third-party bank account without ever touching the funds themselves. For custodial services and similar, this means that you can automate transactions between accounts without third party ‘interference’.
- Alternative to expensive repeat card transactions. When confirming a regular service for customer, card has previously been the only way to secure a regular payment at the point of selling the service. PayTo allows regular payments to be set up and confirmed on the spot, meaning e.g. subscription sales can be closed reliably in person.
Shaype Capabilities – Initiator Service
The following capabilities are included in Shaype’s PayTo Initiator Services
Services
Orchestration of PayTo related notifications and messaging between our PayTo Initiator clients and the NPP Mandate Management System (MMS).
JSON APIs that provide RESTful synchronous web services that can be easily consumed by client and/or technology service provider systems, enabling Initiating Parties to:
- Create PayTo agreements (including obtaining authorisation from the Debtor),
- Amend PayTo agreements (including obtaining authorisation from the Debtor if necessary),
- Immediately Suspend, Release and Cancel PayTo agreements, and
- Execute requests for mandated payments to be made (for example an on-demand pull request triggered by the initiator application)
Operational Management Services
Shaype’s Operations Team will provide back-office support to client teams. This includes any investigations and disputes raised by clients pertaining to PayTo mandates or mandated payments.
During onboarding, Shaype works with our clients to ensure that their solution meets the rules and industry codes for Payment Initiators.
Key Roles and Terms
A PayTo agreement (mandate) is a record of payment authorisation given by a Debtor customer in favour of an NPP payment to a Creditor account.
PayTo agreements and PayTo payments involve the following key roles:
- The Debtor (the Payer account a PayTo payment is made from),
- The Creditor (the Payee account a PayTo payment is made to), and
- The Initiating Party (the party that defines the PayTo agreement payment terms e.g. a merchant).
- The Payment Initiator sends the initiation request for each PayTo Payment to the Debtor on behalf of the Initiating Party. The Payment Initiator can be a payments service provider or a financial institution.
- The Debtor and Creditor Account Servicers are the financial institutions (FIs) that maintain the NPP enabled accounts/PayIDs named in the PayTo agreement.
- MPS User is a comprehensive term used to refer to any party other than the agreement Debtor.
- The Initiating Party, Creditor, and Payment Initiators are all “MPS Users”.
- Using the term “MPS User” allows for the broad range of use cases possible via PayTo.
Key Scenarios
This section provides readers with an overview of the following key PayTo Payment Initiator and Initiating Party scenarios:
- View a PayTo agreement
- Creating an Authorised PayTo agreement
- All Payment Initiator clients can support the scenario where the Initiating Party is a third party to a PayTo agreement, and the Creditor Account Servicer is another organisation (i.e. the NPP payment is received by the other organisation, not the client).
- PayTo Payments (where the Payment Initiator is third party)
- PayTo Payments (where the Payment Initiator is also Creditor Account Servicer)
Creating a PayTo agreement
The client is responsible for enabling their customers to create PayTo agreements as the Initiating Party.
Clients may implement features to support the creation of PayTo agreements by the Initiating Party in mobile or online applications, and/or via non-digital channels (such as a form).
- The Initiating Party provides the details for a new PayTo agreement to Shaype
- Shaype validates the agreement: the service checks that the Debtor bank is NPP reachable, and supports the PayTo scheme
- Shaype’s response to the client includes whether the agreement is valid, plus
- it includes other “enrichment” data such as resolving the PayID (if one is used).
- Shaype then generates and sends a Mandate Creation Request message to the NPP PayTo Mandate Management Service.
- Mandate Creation Request messages: must have a priority (attended or unattended), must have a frequency (ad-hoc, annual, monthly etc), must have an agreement type (Fixed, Variable, Usage, Balloon, Usage+, Variable+, Fixed+), may have a business expiry date/time (an expiry date/time is not mandatory).
- The MMS creates a PayTo agreement record, and sends a notification to the Debtor Account Servicer.
- The Debtor Account Servicer receives notification that a PayTo agreement has been created where their customer’s account (or PayID) is named as the Debtor, and authorisation is required.
Sometime later...
-
The Debtor customer can view the agreement terms, and authorise (or decline) the agreement.
-
The Debtor Account Servicer sends the Debtor authorisation response to the MMS.
-
The MMS updates their PayTo agreement record with the Debtor’s response.
-
Shaype receives notification from the MMS that the agreement has been authorised (or not).
-
Shaype forwards the PayTo agreement authorisation response notification to the client.
Key PayTo Agreement Data Fields
NPPA has defined the PayTo agreement data fields as follows:
Agreement Data Fields | Usage | Guidance |
---|---|---|
Mandate ID | Mandatory | The MMS allocates each PayTo agreement a unique ID. |
Mandate Status | Mandatory | CREATED: Created ACTIVE: Active SUSPENDED: Suspended CANCELLED: Cancelled (Archived) |
Mandate Description or Mandate Short Description | Conditional | Either the Mandate Description or Short Description must be provided. |
Mandate Type | Mandatory | DDTP = Authorised Payment or Migrated DDR |
Purpose | Mandatory | May be used for screening purposes.
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. NOTE: The GOVERNMENT and TAX values are restricted to MPS Users that service government agencies. |
Mandate Establishment Scheme | Mandatory | AUPM = Authorised Payment Mandate MGPIR = Migrated DDR Mandate |
[Mandate Terms] | Mandatory | Fields include: Mandate Validity Start Date Mandate Validity End Date (optional) Automatic extension |
Additional Information | Conditional | If BECS User ID in here, do not override. Append |
[Initiating Party Details] | Mandatory | Fields include: Sponsor BIC Type Party ID Legal name = Trading name as would be recognised by the Debtor |
[Payer Customer Details] | Varies, Conditional | Fields include: Debtor Party type (ORGANISATION or PERSON) Debtor Party ID Type Code Debtor Party ID Code Debtor Account or PayID (not both) Debtor Name Ultimate Debtor Name Account Servicer BIC, etc A Debtor PayID cannot be used when creating a Migrated DDR Mandate (NOTE: Migrated DDR Mandate not currently supported by Shaype) |
[Creditor Details] | Varies, Conditional | Fields include: Creditor Party type (ORGANISATION or PERSON) Creditor Party ID Type Code Creditor Party ID Code Creditor Account or PayID (not both) Creditor Name Ultimate Creditor Name Account Servicer BIC, etc A Creditor PayID cannot be used when creating a Migrated DDR Mandate. (NOTE: Migrated DDR Mandate not currently supported by Shaype) |
PayTo Agreement Payment Terms
NPPA has defined the PayTo agreement payment terms fields as:
Mandate Data Fields | Usage | Guidance |
---|---|---|
Frequency | Mandatory | Expected frequency: ADHOC: Event takes place on request or as necessary. DAILY: Event takes place every day. FORTNIGHTLY: Event takes place every two weeks. INTRA_DAY: Event takes place several times a day. SEMI_ANNUAL: Event takes place every six months or two times a year. MONTHLY: Event takes place every month or once a month. QUARTERLY: Event takes place every three months or four times a year. WEEKLY: Event takes place once a week. ANNUAL: Event takes place every year or once a year. |
Execute Not Before Time | Optional | Time of day after which payments may be initiated e.g. 2022-07-30 |
Count per period, or Point in Time | Conditional | Only one of Count Per Period or Point In Time can be specified |
Payment Amount Type | Mandatory | BALLOON: Payment amount is fixed with large final payment amount. FIXED: Payment amount is fixed. USAGE_BASED: Payment amount is based on usage. VARIABLE: Payment amount is variable. |
Payment Amount | Conditional | Either actual amount or minimum amount |
First Payment Amount | Optional | e.g. establishment fee |
Last Payment Amount | Optional | e.g. pay-out amount |
Maximum Payment Amount | Optional | Recommended for usage or variable types |
First Payment Date | Optional | First date to expect payment request |
Last Payment Date | Optional | Date to expect for final payment request |
Notes
Payment Amount Type = VARIABLE and USAGE_BASED are currently only available with Frequency = ADHOC
Types of PayTo Agreements
NPPA has defined PayTo Agreement types as:
Agreement Type | Example usage scenarios |
---|---|
Fixed | Gym membership |
Balloon | Car loan repayment |
Variable | Online shopping account , utility bill |
Usage+ | Corporate payroll (with multiple signatory authorisation) |
Variable+ | Corporate supplier payment (with multiple signatory authorisation) |
Fixed+ | Corporate one-off purchase (with multiple signatory authorisation) |
View details of a PayTo agreement
The client is responsible for ensuring that the Initiating Party is able to view their PayTo agreements.
- NPPA does not prescribe how PayTo agreement details are presented to the Initiating Party.
- The Initiating Party could view their PayTo agreements in the client’s mobile or online app, and/or via non-digital channels (e.g. for non-digitally enabled customers).
- The Initiating Party must be able to view all their PayTo agreements.
- At any time, the Payment Initiator (client) systems must be able to request the latest details from the MMS for the Initiating Party’s agreements (by sending a query to Shaype).
- Shaype provides the client with the latest PayTo agreement records and pending requests from the MMS.
Modifying a PayTo agreement
Mandate Status Change
Shaype provides the ability to change the status of a Mandate by forwarding a change made by the Initiating Party to the MMS.
- Cancel
- Suspend
- Release (un-suspend)
NOTE: The Initiating Party can only release an agreement if they were the one that suspended the agreement.
Amend Mandate
Shaype provides clients with a Mandate Amendment API which must be used to send amendments made by the Initiating Party to the MMS. Shaype forwards the amendment to the MMS.
The change message must contain either unilateral changes or bilateral changes (not both)
- Bilateral change: Changing the payment terms is a bilateral change (requiring Debtor authorisation). If the change is declined by the Debtor (or it expires) the current agreement terms remain active and the change is archived.
- Unilateral change: Changing the Initiating Party name, agreement description and/or Creditor account/PayID are unilateral changes.
See table below for the types of operations possible as amends:
Unilateral Amendment | Bilateral Amendment | Not Allowed |
---|---|---|
Creditor's name | Payment frequency | Payer Customer's Name and ID |
Creditor's identifying details (e.g. ABN) Bank account details (including Alias) | The type of payment (Fixed, Variable) | Payer Customer Account Details Mandate Purpose |
Creditor Reference | Maximum (capped) amount permitted | |
Mandate description | Fixed amount | |
The Mandate's end date |
Character Set Encoding - To comply with industry standard it is required to use Unicode character set
encoded with UTF-8. Any messages containing non-compliant characters will result in a reject mandate.
Recall a pending Mandate Amendment Request
The Initiating Party can recall a pending Mandate Amendment Authorisation Request (i.e. if the amendment is bilateral). Shaype sends the recall request to the MMS.
Migrating a PayTo agreement
The PayTo MMS from NPP supports the ability to migrate a Direct Debit agreement to a PayTo agreement. Currently Shaype does not support this out-of-the-box, instead we recommend cancelling the Direct Debit and creating a new PayTo agreement with the same terms. This also allows a customer the opportunity to review the terms, given the faster processing of payments with PayTo, and ensure the agreement still fits their needs.
PayTo Payments (Initiator flow)
For a PayTo agreement where the client is the Payment Initiator, and either an adhoc PayTo Payment is made or a scheduled PayTo payment is due:
- The Payment Initiator (client) sends a Mandate Payment Initiation Request to Shaype
- This step is for Ad Hoc payments only – payments based on a schedule will be processed automatically by Shaype
- Shaype confirms the request is consistent with the PayTo agreement in the MMS.
- Shaype sends the Mandate PIR to the Debtor’s bank via the NPP BI.
- The Debtor bank responds to valid Mandate PIRs by sending an NPP payment to the Creditor account nominated in the Mandate PIR.
- Shaype receives notification of the response to the Mandate PIR from the NPP.
- The client receives the response to the Mandate PIR (settled, pending or rejected).
- The Creditor customer can view the PayTo payment funds in their account.
Overall flow
- Trigger payment initiation. This is either:
- automatic for fixed frequency payments, or
- through the Make Adhoc Payment endpoint for Adhoc (anytime) payments
- The message to send payment is sent to the core PayTo ecosystem (NPPA PAG)
- The Debtor party receives the request and responds with an outcome
- Shaype returns this outcome to the Initiator client in the Make Adhoc Payment endpoint response. Most of the time it is 'final'. It may also show a 'non-final' status.
- If the status is non-final, the client can call
Get Payment instruction status by Mandate ID and Payment Instruction ID
for updates to fetch an update using the payment instruction ID. This is only available for 15 days from the instruction date after which point the payment instruction will be archived by the MMS.- Client can also use Search payments instructions by Mandate ID - especially for fixed frequency payments
- Client can also wait for a Mandate Payment Event notification (see below)
Status transitions
Status detail
Payment Outcome | Outcome type | Meaning | Further action |
---|---|---|---|
UNDELIVERED | Final | Message could not be delivered to the PayTo rails (PAG). Client should retry initiation. | Retry. In case of continuing failure please contact Shaype for support |
STORE_AND_FORWARD | Non-final | Target institution is not available, but message will be relayed when they are back online | Check Get Payment instruction status by Mandate ID and Payment Instruction ID for updates |
SENT | Non-final | Message has been sent, no acknowledgement yet received | Check Get Payment instruction status by Mandate ID and Payment Instruction ID for updates |
RECEIVED | Non-final | Message has been received, no further update on status yet | Check Get Payment instruction status by Mandate ID and Payment Instruction ID for updates |
ACCEPTED_FOR_CLEARANCE | Non-final | Payment is accepted but settlement not initiated | Check Get Payment instruction status by Mandate ID and Payment Instruction ID for updates |
SETTLEMENT_ABORTED | Non-final | Settlement could not be completed | Retry. In case of continuing failure please contact Shaype for support |
PENDING | Non-final | Settlement queued for handling but not complete | Check Get Payment instruction status by Mandate ID and Payment Instruction ID for updates |
ACCEPTED_AND_SETTLED | Final | Settlement completed | No further action / check for payment / onward activities |
REJECTED | Final | Payment could not be completed | Payment not possible due to reason supplied. Request could be modified and resubmitted - or if unexpected problem then please contact Shaype team for support |
PayTo Notifications Services
Shaype receives notifications from the MMS for any action made to a PayTo agreement for which the client is the Payment Initiator. Examples of MMS notifications are:
- PayTo agreement authorisation responses (accepted, declined, expired)
- PayTo agreement status changes made by the Debtor (suspended, released, cancelled).
It is up to the client as to if/how they present PayTo Notifications to their customers, including:
- How the amended data is made available to the customer, and
- If the customer is informed of mandate suspension/unsuspension, and cancellation by the Debtor
Notifications may be presented to your customers via SMS, email or in-app push notifications.
Notifications about Payer actions
MMS Code | Notification Recipient | Notification Name |
---|---|---|
MAMC | Initiator | Mandate Amend Confirmed |
MAMD | Initiator | Mandate Amend Declined |
MAMN | Initiator | Mandate Amended |
MCRC | Initiator | Mandate Create Confirmed |
MCRD | Initiator | Mandate Create Declined |
MCRR | Initiator | Mandate Create Recalled |
MSCH | Payer & Initiator | Mandate Status Changed |
MCRT | Payer | Mandate Requires Authorisation |
MAMP | Payer | Mandate Amend Proposed |
Notifications about automatic MMS actions
MMS Trigger | Notification Recipient | Notification Name | Remarks |
---|---|---|---|
MAMX | Payer and Initiator | MandateAmendExpired | Expiry will be determined by MMS. Sent to the performer of an amend action once its expiry time has been reached and the status of the action is set to Timed Out (TIMO). For a bilateral amend action, this notification is also sent to the servicer of the Debtor Account. |
MCRX | Payer and Initiator | MandateCreateExpired | Expiry will be determined by MMS |
Notifications about payments
- The Mandate Payment Event notification includes payment instruction ID, Mandate ID and final status.
- It is sent for all payment instructions when the final status is known
- After triggering the payment initiation the client can check the Get Payment instruction status by Mandate ID and Payment Instruction ID endpoint if the final status notification is not received.
Check industry coverage
As of May 2023 PayTo is in a phase of partial roll-out across the industry. This means many institutions won't yet offer mandate authorisation capability to their customers. Shaype provides a service to check support for PayTo by BSB. It is recommended that you check this for your target debtor customer before sending a mandate creation request. See 'Check if BSB supports PayTo' endpoint below.
List of endpoints and key flows
Path | Name |
---|---|
POST/v1/payto/initiator/mandates | Create Mandate |
PUT/v1/payto/initiator/mandates/{mandateId} | Amend Mandate by Initiator |
PATCH/v1/payto/initiator/mandates/{mandateId}/cancel | Cancel Mandate by Initiator |
PATCH/v1/payto/initiator/mandates/{mandateId}/payment_terms | Amend Mandate payment terms |
PATCH/v1/payto/initiator/mandates/{mandateId}/release | Release Mandate by Initiator |
PATCH/v1/payto/initiator/mandates/{mandateId}/resolve | Resolve Mandate by Initiator |
GET/v1/payto/initiator/mandates/{mandateId}/search | Search Payments Instructions by mandateId |
PATCH/v1/payto/initiator/mandates/{mandateId}/suspend | Suspend Mandate by Initiator |
GET/v1/payto/mandates | Get Mandates by Account IDs |
GET/v1/payto/mandates/{mandateId} | Get Mandate by ID |
POST/v1/payto/payments/adhoc | Make Adhoc Payment |
GET/v1/payto/initiator/mandates/{mandateId}/instructions/{instructionId}/status | Get Payment instruction status by Mandate ID and Payment Instruction ID |
GET/v1/payto/supported-bsbs/{bsbNumber} | Check if BSB supports PayTo |
PUT/V1/payto/payer/mandates/{mandateId} | Amend Mandate by Payer |
GET/V1/payto/payer/mandates/{mandateId}/actions | Get Mandate Actions by Payer |
PATCH/V1/payto/payer/mandates/{mandateId}/cancel | Cancel Mandate by Payer |
PATCH/V1/payto/payer/mandates/{mandateId}/release | Release Mandate by Payer |
PATCH/V1/payto/payer/mandates/{mandateId}/resolve | Resolve Mandate pending action by Payer |
PATCH/V1/payto/payer/mandates/{mandateId}/suspend | Suspend Mandate by Payer |
Create Mandate and receive authorisation outcome
- Check if BSB supports PayTo (GET/v1/payto/supported-bsbs/{bsbNumber})
- Create Mandate (POST/v1/payto/initiator/mandates) >
- Receive notification: MandateCreateConfirmed
- (Receive notification: MandateCreateDeclined)
Amend mandate details (eg Account details)
- Amend Mandate by Initiator (PUT/v1/payto/initiator/mandates/{mandateId})
Amend mandate payment terms (eg frequency, amount)
- Amend Mandate payment terms (PATCH/v1/payto/initiator/mandates/{mandateId}/payment_terms)
Suspend / unsuspend (release) a mandate
- Suspend Mandate by Initiator (PATCH/v1/payto/initiator/mandates/{mandateId}/suspend)
- Release Mandate by Initiator (PATCH/v1/payto/initiator/mandates/{mandateId}/release)
Cancel a mandate
- Cancel Mandate by initiator (PATCH/v1/payto/initiator/mandates/{mandateId}/cancel)
Initiate Payment
(note – AdHoc payments only – scheduled payments will be initiated automatically by Shaype
- Make Adhoc Payment (POST/v1/payto/payments/adhoc)
- Receive notification of NPP payment (https://developer.shaype.com/reference/notifynotificationusingpost - Transaction Event object - will contain mandate ID and payment instruction ID if a mandate-related payment
- See https://developer.shaype.com/page/build-in-progress-payto-transaction-status-updates#notificationsfor details of update to Mandate Payment Event object