PayTo Payment
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 (Payment Initiation Request) to the Debtor’s bank via the NPP BI (Basic Infrastructure).
- 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)
API
Initiate Payment
- For use by Initiator only
- Trigger a Payment Initiation Request to the Payer side.
- You will receive the webhook notification of the payment with transaction event object that contain mandateId and Payment InstructionId.
AdHoc payments only – scheduled payments will be initiated automatically by Shaype
API Reference: Make Adhoc Payment
Updated 30 days ago