v1
latestOpenAPI 3.0.02026-07-24126202516.7 KBPayTo Agreements
Get All PayTo Agreements for a User
This operation is to retrieve all PayTo agreements associated with a particular user in the provided period (date range). Agreements can be retrieved for a maximum period of one year or less at a time i.e. the period between start and end date cannot exceed more than one year.
By default, all agreements will be returned irrespective of status and type (AUPM/MGCR).
However, if required, results can be filtered for a particular status or agreement type. Example - Retrieve all suspended and cancelled migrated agreements.
Request parameter descriptions:
- user_external_id - Unique identifier of the user that is associated with the agreement.
- status - List of valid agreement statuses. Example - Retrieve active and suspended agreements only.
- Valid values - PENDING_VALIDATION, VALIDATED, PENDING_CREATION, CREATED, ACTIVE, SUSPENDED, CANCELLED
- agreement_type - List of valid agreement types. Example - Retrieve only migrated agreements.
- Valid values - AUPM, MGCR
- start_date - Date range start, example - fetch all agreements created between June to December 2022.
- end_date - Date range end, example - fetch all agreements created between June to December 2022.
- size - Number of agreements per page. Default value is 20.
- page - Page number. Default value is 0.
get/agreements
Query parameters
user_external_idstring required
Example:buyer-147043828
statusstring[]
agreement_typestring
Example:AUPM
start_datestring required
Example:2022-10-15
end_datestring required
Example:2023-10-15
sizeinteger
pageinteger
Response
OK
Example response
{
"totalCount": 1,
"agreements": [
{
"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"
}
}
}
]
}