Delete Agreement

DELETE

/pay-to/agreements/{identifier}

Cancels a PayTo agreement by sending a cancellation request to the bank. The agreement status will be set to pending while the bank processes the cancellation.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "reason": "customer_requested"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request DELETE 'https://api-sandbox.squarepay.com.au/v2/pay-to/agreements/Loan1337' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "customer_requested"
}'

Responses

🟢200OK

application/json

Agreement cancellation request submitted successfully

Body

Example

{
    "reference": "Loan1337",
    "status": "pending"
}

🟠401Unauthorised

🟠404Not Found

🟠422Validation Error

🔴500Server Error

Modified at 2025-09-30 11:25:21

Show Agreement History

Cancel Agreement