List Payments - Squarepay API

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Query Params

status

string

optional

Filter by the agreement status.

limit

integer

optional

The number of items to display.

>= 1<= 100

Default:

Example:

page

integer

optional

Index pointing to the start of the desired set, first page is 1. Page defaults to 1.

Example:

created_after

string

optional

Date formatted as YYYY-MM-DD, inclusive.

Example:

2024-02-01

created_before

string

optional

Date formatted as YYYY-MM-DD, inclusive.

Example:

2024-02-27

Header Params

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

data

array[object (Payment) {9}]

required

uuid

string

required

UUID 36 characters

reference

string

required

This is a unique reference to prevent duplicate transactions. This is a nonce.

>= 1 characters<= 255 characters

agreement_uuid

string

required

A supplied agreement identifier.

amount

integer | null

optional

The amount to be real-time debitted based on the schedule. Displays in cents.

priority

enum<string>

required

Attended - Ecommerce style payments, Unattended - Loan style payments.

Allowed values:

attendedunattended

statement_reference

string | null

optional

Free-form text for reconciliation purposes. Typically this field will be shown to both parties on bank statements, however, the debtor can control this via the agreement. The agreement's reference takes precedence over this given field when it has been set by the debtor.

<= 35 characters

statement_description

string

required

Free-form text for the matching/reconciliation of a transaction. Similar to the reference field, this can be shown on both parties' bank statements. The difference is that this description can be a longer string and banks can show this seperately from the reference.

<= 280 characters

last_payment

boolean | null

optional

This is a required field with agreements that have a payment_terms.type of balloon. If true, it indicates that this payment is the last payment for the agreement, and should be validated against the last_payment_date and last_payment_amount. No further payments can be made with the agreement once the last payment has been made. This field should be set to false for all other payments against a balloon agreement, and must be unset for payments on non-balloon agreements.

payment_date

string | null

optional

Start date for validity of agreement, will default to todays date if not provided. Format: YYYY-MM-DD timezone assumed to be Sydney time (AEST).

Example

{
  "data": [
    {
      "uuid": "d9b76218-5c76-46f3-83d9-5e3c0113c983",
      "reference": "Loan1337-3",
      "agreement_uuid": "2e9d9df0-5c70-4bdf-b031-1caa64121602",
      "amount": 10000,
      "priority": "unattended",
      "statement_reference": "Loan #1337",
      "statement_description": "Loan Payment 3 of 10",
      "last_payment": true,
      "payment_date": "2024-02-15"
    },
    {
      "uuid": "a095c915-4f7b-449a-a11c-7240fd042818",
      "reference": "Loan1337-2",
      "agreement_uuid": "2e9d9df0-5c70-4bdf-b031-1caa64121602",
      "amount": 10000,
      "priority": "unattended",
      "statement_reference": "Loan #1337",
      "statement_description": "Loan Payment 2 of 10",
      "last_payment": true,
      "payment_date": "2024-02-08"
    },
    {
      "uuid": "55965817-1cab-43c0-bf64-e047ac5fd897",
      "reference": "Loan1337-1",
      "agreement_uuid": "2e9d9df0-5c70-4bdf-b031-1caa64121602",
      "amount": 10000,
      "priority": "unattended",
      "statement_reference": "Loan #1337",
      "statement_description": "Loan Payment 1 of 10",
      "last_payment": true,
      "payment_date": "2024-02-01"
    }
  ]
}

🟠401Unauthorised

🟠422Unprocessable Entity

🔴500Server Error