Payment Delegate Interface
Payment delegate interface acts as a bridge between Bill Pay Accelerator and payment service that PI will implement for a given payment instrument. Whenever PI changes the payment service, Bill Pay Accelerator does not have to make any changes to fulfil the payments as it relies on Payment delegate to initiate payment for a transaction.
Bill Pay Accelerator Presentment Service is one of the internal core components of Bill Pay Accelerator that calls Payment scheduler to fulfil scheduled (aka future) payments using the payment instrument setup by consumer during payment-link creation process.
Bill Pay Accelerator processes a bill whenever payment request is submitted by Mastercard Bill Pay Exchange. Depending on the payment preferences, either the bill will be scheduled, paid immediately or just notify payee that new bill is generated for linked account. Presentment service is invoked for any Bill presentment to consumer. The payer can set payment preferences while linking a biller. He/She can choose to enable payment preferences as autopay ON or OFF. Please refer to payment preferences for more details.
If the payer has set his/her preference as Auto Pay ON or immediate pay, payment scheduler (backend job scheduler) picks up the job based on the preferred date and amount and schedules it for payment. Payment delegate interface is invoked by payment scheduler.
If the payer has set his / her payment preferences as Autopay OFF, payer has to initiate payment manually from the mobile app. Mobile app has to call payment delegator to initiate payment. From here, the flow to call pay API is the same as in case of Autopay ON and immediate pay.
Depending on the payment gateway API that PI chooses to implement, PI should write an action handler for that payment services. For Example, if PI supports PayPal, PI should write an action handler to invoke PayPal APIs. The action handler should implement below or more steps:
1. Establish secured connection to the payment service
2. Create and update session
3. Update payment instrument
4. Make a payment transaction
The advantage of having Payment delegate interface is that the core Bill Pay Accelerator services and Presentment service need not be changed irrespective of the Payment Gateway API chosen by PI.
Payment delegate interface discovers the URI mapping to the payment gateway solution that the PI has implemented through the API gateway mappings.
PI should call Pay API and Retrieve API to fulfil payments by integrating with payment gateway.
The Payment scheduler will invoke these APIs for payment transaction or retrieve payment transaction details. PI should write custom code in these two below APIs to make payment transaction calls to PI payment service.
| Purpose | API | Description |
|---|---|---|
| Initiate pay | /transaction/v1.0/pay | Used by presentment service and payment scheduler to initiate payment. |
| Purpose | SDK/API | Description |
|---|---|---|
| Manual Pay | SDK/API provided by the payment gateway service provider | Called by mobile app to initiate payment |
In case auto pay is not enabled, the consumer is expected to make payment for the bill whenever it is presented. If the bill payment is captured at the consumer side, the app makes call to Payment Confirmation Advice API to notify the payment has happened by mentioning the settlement details.
Notification Token