Create Payment

POST

/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 *****************

Header Params

Body Params application/json

Example

{
    "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"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-sandbox.squarepay.com.au/v2/pay-to/payments' \
--header 'Accept: application/json' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
}'

Responses

🟢201OK

application/json

Body

Example

{
    "data": {
        "uuid": "94968d84-6551-446d-9ceb-bad3ca62e8b7",
        "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-21 11:12:10

Cancel Agreement

List Payments