Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
PayTo Agreements

Get PayTo Agreement Details

Retrieve details of a PayTo agreement by UUID which uniquely identifies the agreement. This UUID is returned as part of the “Validate PayTo Agreement” operation.

It provides complete details of a particular agreement irrespective of its current status

get/agreements/{agreement_uuid}

Path parameters

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

Response

OK

agreement_uuidstring

Zai generated Universally Unique Identifier (UUID).

user_external_idstring

Specifies a character string.

statusstring
<p>Current status of the agreement:</p> <table><tr><td>Status</td><td>Description</td></tr><tr><td>PENDING_VALIDATION</td><td>Agreement validation is pending.</td></tr><tr><td>VALIDATED</td><td>Agreement is validated.</td></tr><tr><td>VALIDATION_FAILED</td><td>Agreement validation failed.</td></tr><tr><td>PENDING_CREATION</td><td>Agreement creation is pending.</td></tr><tr><td>CREATED</td><td>Agreement is created.</td></tr><tr><td>CREATION_FAILED</td><td>Agreement creation failed.</td></tr><tr><td>ACTIVE</td><td>Agreement is active.</td></tr><tr><td>SUSPENDED</td><td>Agreement is suspended.</td></tr><tr><td>CANCELLED</td><td>Agreement is cancelled.</td></tr></table>
status_descriptionstring

Description of the associated status.

status_reason_codestring
<p>Reason code of the associated status: <table><tr><td>Reason Code</td><td>Description</td></tr><tr><td>PayerAccountNumberInvalid</td><td>Payer account details or PayID provided is invalid or does not exist within NPP.</td></tr><tr><td>ClosedAccount<td>Account provided is closed.</td></tr><tr><td>PayerAccountClosed</td><td>Payer account provided is closed.</td></tr><tr><td>BlockedAccount</td><td>Account provided is temporarily blocked.</td></tr><tr><td>PayerAccountTypeInvalid</td><td>Payer account type is invalid - unable to debit funds within NPP.</td></tr><tr><td>TransactionForbiddenOnPayerAccount</td><td>Transaction forbidden on the provided Payer account - either agreement to debit this account does not exist/inactive or the account does not support debits within NPP.</td></tr><tr><td>NPPTransactionNotSupported</td><td>Transaction not supported on the provided Payer account - does not support NPP payments.</td></tr><tr><td>UnsupportedCurrency</td><td>Unable to debit funds in AUD from the provided Payer account.</td></tr><tr><td>AmountInvalidOrMissing</td><td>Amount and/or maximum amount are either invalid or not specified in the agreement.</td></tr><tr><td>AmountExceedsAgreedLimitsForPayerAccount</td><td>Amount specified in the agreement exceeds the allowed transaction amount for the Payer account.</td></tr><tr><td>PayerDeceased</td><td>Payer is deceased.</td></tr><tr><td>PayToServiceNotSupportedByPayerBank</td><td>PayTo service is not supported by the Payer institution.</td></tr><tr><td>PayToServiceNotPermittedForPayer</td><td>This agreement type is not supported for the provided Payer customer/account OR the Payer customer account no longer supports PayTo services.</td></tr><tr><td>RequestedByPayer</td><td>Suspension/Cancellation is requested by Payer.</td></tr><tr><td>RequestedByInitiatingParty</td><td>Suspension/Cancellation is requested by Creditor or by the Initiating Party.</td></tr><tr><td>ActiveAgreementValidityExpired</td><td>Validity of the agreement has expired & is no longer active.</td></tr><tr><td>UndisclosedReason</td><td>Suspended/Cancelled due to undisclosed reasons.</td></tr><tr><td>RequestedByPayer-UnspecifiedReason</td><td>Suspended/Cancelled without any reason specified by the Payer.</td></tr><tr><td>RequestedByPayerBank-UnspecifiedReason</td><td>Suspended/Cancelled without any reason specified by the Payer institution.</td></tr><tr><td>UnspecifiedReason</td><td>Suspended/Cancelled without any specified reason.</td></tr><tr><td>Prohibited</td><td>Suspended/Cancelled as it is considered prohibited.</td></tr><tr><td>PayeeNotOnAllowlistOfPayer</td><td>Payee not on the allowlist/trusted list of the Payer.</td></tr><tr><td>PayeeOnBlocklistOfPayer</td><td>Payee is blocked/blacklisted by the Payer.</td></tr><tr><td>ContractAmended</td><td>External arrangement (or contract) between the Payer and the Initiating Party has been amended.</td></tr><tr><td>ContractCancellationInitiatedByDebtor</td><td>External arrangement (or contract) cancellation has been initiated by Payer.</td></tr><tr><td>ContractExpired</td><td>External arrangement (or contract) between the Payer and the Initiating Party has expired.</td></tr><tr><td>FinalPaymentCompleted</td><td>Suspended/Cancelled as final payment has been completed successfully.</td></tr><tr><td>OneOffPaymentCompleted</td><td>Suspended/Cancelled as one-off payment has been completed successfully</td></tr><tr><td>TooManyConsecutiveUnsuccessfulPayments</td><td>Suspended/Cancelled due to multiple consecutive unsuccessful payment attempts.</td></tr><tr><td>NoResponseFromPayer</td><td>Payer did not respond within the expected timeframe.</td></tr><tr><td>UnapprovedAgreementValidityExpired</td><td>Validity of the agreement has expired before Payer authorisation.</td></tr><tr><td>UnknownReason</td><td>Suspended/Cancelled due to unknown reason.</td></tr><tr><td>UnknownPayer</td><td>The payment has been rejected by the Payer institution as the Payer is not known as per records. Please try again or contact the Payer.</td></tr><tr><td>UnrecognisedInitiatingParty</td><td>The Payer has requested the payment rejection as the Initiating party is not recognised by them. Please try again or contact the Payer.</td></tr></table>
status_reason_descriptionstring

Description of the reason code of the associated status.

created_atstring

creation date.

updated_atstring

modification date.

Example response

{
  "agreement_uuid": "d0c40d95-95b7-449b-9835-3c97c0386700",
  "user_external_id": "buyer-147043828",
  "status": "ACTIVE",
  "status_reason_code": "RequestedByPayer",
  "created_at": "2022-03-21 16:25:00.190831",
  "updated_at": "2022-03-22 16:25:00.190831",
  "agreement_info": {
    "agreement_id": "00000000000010008000000000000000",
    "description": "agreement desc",
    "short_description": "short desc",
    "validity_start_date": "2022-04-05",
    "validity_end_date": "2022-04-25",
    "transfer_arrangement": "transfer arrangement",
    "debtor_info": {
      "debtor_account_details": {
        "account_id": "123456789",
        "account_id_type": "PAYID",
        "payid_details": {
          "payid": "payid",
          "payid_name": "payidname"
        }
      },
      "debtor_details": {
        "debtor_name": "debtor name",
        "ultimate_debtor_name": "ultimate name",
        "debtor_id": "debtor identification",
        "debtor_reference": "debtor reference"
      }
    },
    "creditor_info": {
      "creditor_account_details": {
        "account_id": "123456789"
      },
      "creditor_details": {
        "creditor_id": "creditor identification",
        "creditor_name": "creditor name",
        "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"
    },
    "payment_terms": {
      "payment_amount_info": {
        "amount": "1000",
        "currency": "AUD"
      },
      "first_payment_info": {
        "amount": "1000",
        "currency": "AUD",
        "date": "2022-04-15"
      },
      "last_payment_info": {
        "amount": "1000",
        "currency": "AUD",
        "date": "2022-04-15"
      },
      "maximum_amount_info": {
        "amount": "1000",
        "currency": "AUD"
      },
      "payment_executed_not_before_time": "02:30:19Z",
      "point_in_time": "24",
      "count_per_period": "10",
      "frequency": "ADHOC"
    }
  }
}