list payments

GET {{baseUrl}}/payto/payments?per_page=20&starting_after=nisi consequat mollit&state=nostrud officia sit,nostrud Ut mollit&min_created_date=2022-01-01&max_created_date=2022-01-31&agreement_uid=biz_agreement_000123

Request Params

Key	Datatype	Description
`per_page`	number	Number of results per page
`starting_after`	string	Opaque pagination cursor value. Set by following "next" links.
`state`	string	Filter payments by state. Multiple values can be separated by commas.
`min_created_date`	string	Filter by minimum created_at date. ISO8601 format.
`max_created_date`	string	Filter by maximum created_at date. ISO8601 format.
`agreement_uid`	string	Filter payments by agreement.

HEADERS

Key	Datatype	Required	Description
`Accept`	string

RESPONSES

status: OK

{&quot;links&quot;:{},&quot;data&quot;:[{&quot;uid&quot;:&quot;biz_payment_0000000000310&quot;,&quot;agreement_uid&quot;:&quot;biz_agreement_0000000000400&quot;,&quot;state&quot;:&quot;settled&quot;,&quot;amount&quot;:12345,&quot;last_payment&quot;:null,&quot;priority&quot;:&quot;unattended&quot;,&quot;reference&quot;:null,&quot;description&quot;:null,&quot;creditor&quot;:{&quot;party_name&quot;:&quot;Mr Creditor&quot;,&quot;ultimate_party_name&quot;:null,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-456789&quot;}},&quot;debtor&quot;:{&quot;ultimate_party_name&quot;:&quot;Ms Debtor&quot;,&quot;party_name&quot;:&quot;Ms Debtor&quot;,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-456789&quot;}},&quot;failure&quot;:null,&quot;created_at&quot;:&quot;2022-02-01T09:41:00+11:00&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;https://api.split.cash/payto/payments/biz_payment_0000000000310&quot;,&quot;agreement&quot;:&quot;https://api.split.cash/payto/agreements/biz_agreement_0000000000400&quot;}},{&quot;uid&quot;:&quot;biz_payment_0000000000300&quot;,&quot;agreement_uid&quot;:&quot;biz_agreement_0000000000400&quot;,&quot;state&quot;:&quot;settled&quot;,&quot;amount&quot;:12345,&quot;last_payment&quot;:null,&quot;priority&quot;:&quot;unattended&quot;,&quot;reference&quot;:null,&quot;description&quot;:null,&quot;creditor&quot;:{&quot;party_name&quot;:&quot;Mr Creditor&quot;,&quot;ultimate_party_name&quot;:null,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-456789&quot;}},&quot;debtor&quot;:{&quot;ultimate_party_name&quot;:&quot;Ms Debtor&quot;,&quot;party_name&quot;:&quot;Ms Debtor&quot;,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-456789&quot;}},&quot;failure&quot;:null,&quot;created_at&quot;:&quot;2022-02-01T09:41:00+11:00&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;https://api.split.cash/payto/payments/biz_payment_0000000000300&quot;,&quot;agreement&quot;:&quot;https://api.split.cash/payto/agreements/biz_agreement_0000000000400&quot;}},{&quot;uid&quot;:&quot;biz_payment_0000000000290&quot;,&quot;agreement_uid&quot;:&quot;biz_agreement_0000000000400&quot;,&quot;state&quot;:&quot;settled&quot;,&quot;amount&quot;:12345,&quot;last_payment&quot;:null,&quot;priority&quot;:&quot;unattended&quot;,&quot;reference&quot;:null,&quot;description&quot;:null,&quot;creditor&quot;:{&quot;party_name&quot;:&quot;Mr Creditor&quot;,&quot;ultimate_party_name&quot;:null,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-456789&quot;}},&quot;debtor&quot;:{&quot;ultimate_party_name&quot;:&quot;Ms Debtor&quot;,&quot;party_name&quot;:&quot;Ms Debtor&quot;,&quot;account_identifier&quot;:{&quot;type&quot;:&quot;bban&quot;,&quot;value&quot;:&quot;123456-456789&quot;}},&quot;failure&quot;:null,&quot;created_at&quot;:&quot;2022-02-01T09:41:00+11:00&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;https://api.split.cash/payto/payments/biz_payment_0000000000290&quot;,&quot;agreement&quot;:&quot;https://api.split.cash/payto/agreements/biz_agreement_0000000000400&quot;}}]}