v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

PayTo Agreements

Create PayTo Agreement

This operation creates the agreement with NPPA and hence must be invoked only after validating the agreement via the “Validate PayTo Agreement” operation.

It should be invoked immediately once the agreement has been validated successfully and resolved PayID details are confirmed with the user.

Agreement Creation will be successful only if it is performed within 5 minutes post successful validation.

Post successful creation, agreement id (generated by NPPA) which uniquely identifies the agreement will be notified.

Note - AUPM agreements will be ACTIVE only post debtor authorization. By default (if custom expiry duration is not provided via response_requested_by field), debtor will have 5 days to authorise the agreement, post which the authorization request will expire automatically. The agreement will be marked as CANCELLED after the 6th day if not CANCELLED automatically by the payer institution after the 5th day. MGCR agreements will be ACTIVE immediately post creation however, payments can be initiated only after 5 calendar days.

post/agreements/{agreement_uuid}/create

Path parameters

agreement_uuidstring required

Example:d0c40d95-95b7-449b-9835-3c97c0386585

Response

Accepted

agreement_uuidstring

Agreement uuid

statusstring

Status of the create agreement request.

created_atstring

creation date.

updated_atstring

modification date.

Example response

{
  "agreement_uuid": "b2dd5934-478c-45ce-9528-b63c869e6f28",
  "status": "PENDING_CREATION",
  "created_at": "2022-03-21 16:25:00.190831",
  "updated_at": "2022-03-22 16:25:00.190831"
}