List Payments

GET

/pay-to/payments

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

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api-sandbox.squarepay.com.au/v2/pay-to/payments?status&limit=20&page=1&created_after=2024-02-01&created_before=2024-02-27' \
--header 'Accept: application/json' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200OK

application/json

Body

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

Modified at 2024-08-24 13:08:46

Create Payment

Show Payment