In this chapter, you will learn in detail about the APIs related to Physical Mandates.
API Name | Description |
---|---|
Create Subscription API | Use this API to create a subscription by providing a custom payment experience to your customers by specifying the plan ID and the customer details. You can also specify the bank account information when you create the subscription to ensure that mandates are created via the specified bank account only. Make sure to choose the payment mode as PNACH to enable Physical NACH flow. TPV is applicable only for eNACH and UPI. |
Create an Auth API | Use this API to create an authorization request for your customer. For Physical mandates (PNACH), you must include the payment_method with “pnach” details in the request payload. Upon creation, the authorization status will be set to “DOCUMENT_PENDING”. To move the status to “INITIALIZED”, use the Upload File API to upload the required documents. |
Upload File | Use this API to upload the Physical Nach registration forms that contain your customer’s bank account details and signature. Use the paymentId you get in the response in the “Create Auth API” and set action as “SUBMIT_DOCUMENT”. |
Simulate Payment api | Use this API to update the authorisation status from INITIALIZED to either SUCCESS or FAILED. You must provide the payment_id (obtained from the upload file API) along with the desired payment status. This functionality is available only in the test environment. |