create agreement

POST {{baseUrl}}/payto/agreements

Request Body

{"uid"=>"biz_agreement_G7MQWwkQZIP8vbfH", "purpose"=>"loan", "description"=>"Payment plan for loan #1234", "payment_terms"=>{"type"=>"fixed", "frequency"=>"monthly", "amount"=>10000, "count"=>1}, "debtor"=>{"party_name"=>"Billie Jean Junior", "account_identifier"=>{"type"=>"bban", "value"=>"123456-98765432"}, "ultimate_party_name"=>"Billie Jean Senior"}, "creditor"=>{"party_name"=>"Billie Jean Junior", "account_identifier"=>{"type"=>"bban", "value"=>"123456-98765432"}, "ultimate_party_name"=>"Billie Jean Senior"}, "initiator"=>{"name"=>"Jane's Flowers", "legal_name"=>"Blossoming Flowers Pty Ltd", "abn"=>"56192755287"}, "resolution_requested_before"=>"2022-01-20T12:34:56Z", "validity_start_date"=>"2023-01-01", "validity_end_date"=>"2023-12-31", "sandbox"=>{"simulate"=>"debtor_decline", "delay"=>21769872}}

HEADERS

Key	Datatype	Description
`Idempotency-Key`	string	Idempotency-Key
`Content-Type`	string
`Accept`	string

RESPONSES

status: Created

{&quot;data&quot;:{&quot;uid&quot;:&quot;biz_agreement_G7MQWwkQZIP8vbfH&quot;,&quot;state&quot;:&quot;cancelled&quot;,&quot;purpose&quot;:&quot;loan&quot;,&quot;created_at&quot;:&quot;2022-01-20T12:34:56+11:00&quot;,&quot;payment_terms&quot;:{&quot;type&quot;:&quot;fixed&quot;,&quot;frequency&quot;:&quot;monthly&quot;,&quot;amount&quot;:10000,&quot;max_amount&quot;:100000,&quot;count&quot;:1,&quot;first_payment_amount&quot;:100000,&quot;last_payment_amount&quot;:100000,&quot;first_payment_date&quot;:&quot;2023-12-31&quot;,&quot;last_payment_date&quot;:&quot;2024-12-31&quot;},&quot;debtor&quot;:{&quot;party_name&quot;:&quot;Billie Jean Junior&quot;,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-98765432&quot;},&quot;ultimate_party_name&quot;:&quot;Billie Jean Senior&quot;},&quot;initiator&quot;:{&quot;name&quot;:&quot;Jane&#39;s Flowers&quot;,&quot;legal_name&quot;:&quot;Blossoming Flowers Pty Ltd&quot;,&quot;abn&quot;:&quot;56192755287&quot;},&quot;validity_start_date&quot;:&quot;2023-01-01&quot;,&quot;validity_end_date&quot;:&quot;2023-12-31&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;https://api.split.cash/payto/agreements/biz_agreement_G7MQWwkQZIP8vbfH&quot;},&quot;state_caused_by&quot;:&quot;zepto_system&quot;,&quot;description&quot;:&quot;Payment plan for loan #1234&quot;,&quot;resolution_requested_before&quot;:&quot;2022-01-20T12:34:56Z&quot;,&quot;creditor&quot;:{&quot;party_name&quot;:&quot;Billie Jean Junior&quot;,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-98765432&quot;},&quot;ultimate_party_name&quot;:&quot;Billie Jean Senior&quot;},&quot;state_reason&quot;:{&quot;title&quot;:&quot;Invalid BSB Number&quot;,&quot;detail&quot;:&quot;The BSB is not valid or is no longer active.&quot;,&quot;code&quot;:&quot;MD08&quot;}}}