List Agreements

GET

/pay-to/agreements

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/agreements?status&limit=20&created_after=2024-02-01&created_before=2024-02-27&page=1' \
--header 'Accept: application/json' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK

application/json

Body

Example

{
    "data": [
        {
            "uuid": "2e9d9df0-5c70-4bdf-b031-1caa64121602",
            "status": "created",
            "error_code": null,
            "reference": "Loan1337",
            "purpose": "loan",
            "description": "Loan Payout 1337",
            "last_name": "Bob",
            "first_name": "Billy",
            "customer_reference": "MEM000001337",
            "response_required_by": "2024-02-25T16:45:15",
            "start_date": "2024-02-01",
            "end_date": "2025-01-31",
            "payment_term_type": "fixed",
            "frequency": "weekly",
            "amount": "100.00",
            "count": 10,
            "first_payment_date": "2024-02-01",
            "last_payment_date": "2024-04-11",
            "max_amount": null,
            "first_payment_amount": null,
            "last_payment_amount": null,
            "account_type": "bban",
            "bsb": "062000",
            "account_number": "123456789",
            "pay_id": null
        }
    ]
}

🟠401Unauthorised

🟠422Unprocessable Entity

🔴500Server Error

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

Create Agreement

Show Agreement