Square API
You are viewing an old version of the API
Payments
Square API
The Payments API lets developers take and manage payments.
Applications need the following input to take a payment:
The amount to charge.
The payment recipient. The payment goes to the account identified by the Authorization header in the API request.
The payment source. The source can be a payment token or card on file.
You can generate a payment token using the Web Payments SDK and the In-App Payments SDK. For working code examples, see Square Connect API Examples.
A card on file is a credit card, debit card, or gift card that is associated with a customer. You can create a customer and add a card on file using Square APIs, the Square Seller Dashboard, or the Square Point of Sale application.
-
List payments
GET /v2/payments - Retrieves a list of payments taken by the account making the request.
-
Create payment
POST /v2/payments - Creates a payment using the provided source.
-
Cancel payment by idempotency key
POST /v2/payments/cancel - Cancels voids a payment identified by the idempotency key that is specified in the request.
-
Get payment
GET /v2/payments/{payment_id} - Retrieves details for a specific payment.
-
Update payment
PUT /v2/payments/{payment_id} - Updates a payment with the APPROVED status.
-
Cancel payment
POST /v2/payments/{payment_id}/cancel - Cancels voids a payment.
-
Complete payment
POST /v2/payments/{payment_id}/complete - Completes captures a payment.