Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
PayTo Agreements

Amend PayTo Agreement Details

Amend details of a particular agreement via its UUID. There are two types of amendments possible via this operation:

  • Unilateral amendments - which does not need debtor approval and will be effective immediately
  • Bilateral amendments - which does require debtor approval and will be effective post debtor authorisation

Optional fields can also be cleared via an amend request if needed. Passing an hyphen(-) character for any optional field would indicate its value needs to be cleared.

Either unilateral or bilateral amendments will be accepted in an amendment request. Both types of amendments cannot be provided in a single request.

At any given point of time, only a single unilateral or a single bilateral amendment will be allowed. Example - If a bilateral amendment is already in progress, another bilateral amendment request will not be accepted until the first completes.

Unilateral details that can be amended:

  • description
  • short_description
  • creditor_info
  • payment_initiator_info

Bilateral details that can be amended:

  • validity_end_date
  • transfer_arrangement
  • automatic_renewal
  • payment_terms - payment_amount_info, first_payment_info, last_payment_info, maximum_amount_info and point_in_time can be amended at any point however frequency and count_per_period can be amended only if no payments have been requested for the agreement yet.

Note - Bilateral amendments will be effective only post debtor authorization. Debtor should authorize the amendments within 5 days (default duration) or within the custom expiry duration (response_requested_by) specified in the amendment request.

patch/agreements/{agreement_uuid}/amend

Path parameters

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

Request body

priority'ATTENDED' | 'UNATTENDED' required
<p>Identifies the arrangement (attended or unattended).</p>

Priority of the agreement amendment authorisation notification to be sent to the user for approval.<table><tr><td>Code</td><td>Description</td></tr><tr><td>ATTENDED</td><td>If the marketplace wants the debtor user to be notified about the agreement amendment authorisation action immediately, the priority should be set as Attended.</td></tr><tr><td>UNATTENDED</td><td>If the marketplace wants the debtor user to be notified about the agreement amendment authorisation at an appropriate time (not immediately), the priority should be set as Unattended.</td></tr></table>

response_requested_bystring yyyy-MM-dd'T'HH:mm:ss[.SSS][.SS][.S]'Z'

A date expressed in the YYYY-MM-DD'T'HH:mm:ss[.SSS][.SS][.S]'Z' format and in Australia timezone.

This field can be used to specify a custom expiry duration for the authorisation request pending debtor’s approval. Any duration which is less than the default & max duration of 5 days will be accepted. Example - If you want the debtor to approve the changes proposed on the agreement within 15 mins post creation, mention the duration in this field accordingly. However, post the duration (after 15 mins), you would need to invoke the Recall API to expire this authorisation request.

Example request

{
  "response_requested_by": "2022-11-04T06:24:34.214Z",
  "unilateral_amendments": {
    "description": "Description",
    "short_description": "Short description",
    "creditor_info": {
      "ultimate_creditor_name": "ultimate creditor name",
      "creditor_reference": "creditor reference"
    },
    "payment_initiator_info": {
      "initiator_id": "initiator identification",
      "initiator_legal_name": "initiator legal name",
      "initiator_name": "initiator name"
    }
  },
  "bilateral_amendments": {
    "validity_end_date": "2022-03-18",
    "transfer_arrangement": "transfer arrangement",
    "payment_terms": {
      "payment_amount_info": {
        "amount": "1000",
        "currency": "AUD"
      },
      "first_payment_info": {
        "amount": "1500",
        "currency": "AUD",
        "date": "2022-04-15"
      },
      "last_payment_info": {
        "amount": "2000",
        "currency": "AUD",
        "date": "2022-04-15"
      },
      "maximum_amount_info": {
        "amount": "5000",
        "currency": "AUD"
      },
      "payment_executed_not_before_time": "02:30:19Z",
      "point_in_time": "24",
      "count_per_period": "10",
      "frequency": "ADHOC"
    }
  }
}

Response

Accepted

agreement_uuidstring

Unique agreement identifier.

agreement_idstring

Unique agreement identifier generated by NPPA.

status'SUSPENDED' | 'ACTIVE'
<p>Current status of the agreement before amendment.</p> <table><tr><td>Code</td><td>Description</td></tr><tr><td>SUSPENDED</td><td>The agreement is suspended.</td></tr><tr><td>ACTIVE</td><td>The agreement is active.</td></tr></table>
created_atstring

creation date.

updated_atstring

modification date.

Example response

{
  "agreement_uuid": "ae07556e-22ef-11eb-adc1-0242ac12000",
  "agreement_id": "ef0fcd9799431ef783204966f010603c",
  "status": "ACTIVE",
  "created_at": "2022-03-21 16:25:00.190831",
  "updated_at": "2022-03-22 16:25:00.190831"
}