show agreement
GET {{baseUrl}}/payto/agreements/:agreement_uid
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":{"uid":"biz_agreement_000123","state_reason":null,"state":"active","created_at":"2022-02-02T12:01:01+11:00","purpose":"tax","resolution_requested_before":null,"payment_terms":{"type":"usage_based","frequency":"monthly","count":null,"max_amount":8999,"amount":null,"first_payment_amount":null,"last_payment_amount":null,"first_payment_date":null,"last_payment_date":null},"debtor":{"party_name":"Janiel Smith","ultimate_party_name":"Janiel Smith","account_identifier":{"type":"bban","value":"123456-456789"}},"creditor":null,"initiator":{"name":"Jane's Flowers","legal_name":"Blossoming Flowers Pty Ltd","abn":"56192755287"},"description":"Tax payment","validity_start_date":"2023-01-01","validity_end_date":"2023-12-31","state_caused_by":"debtor","links":{"self":"https://api.split.cash/payto/agreements/biz_agreement_000123"}}}