Complete payment

POST

/v2/payments/{payment_id}/complete

Completes (captures) a payment.

By default, payments are set to complete immediately after they are created. If you set autocomplete to false when creating a payment, you can complete (capture) the payment using this endpoint.

Permissions:PAYMENTS_WRITE

Guide

Delayed capture

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

payment_id

string

Required

Unique ID identifying the payment to be completed.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request

Link to section

payment

The successfully completed Payment.

curl https://connect.squareup.com/v2/payments/GQTFp1ZlXdpoW4o6eGiZhbjosiDFf/complete \ -X POST \ -H 'Square-Version: 2020-09-23' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json'

{ "payment": { "id": "GQTFp1ZlXdpoW4o6eGiZhbjosiDFf", "created_at": "2019-07-10T13:39:55.317Z", "updated_at": "2019-07-10T13:40:05.982Z", "amount_money": { "amount": 200, "currency": "USD" }, "app_fee_money": { "amount": 10, "currency": "USD" }, "total_money": { "amount": 200, "currency": "USD" }, "status": "COMPLETED", "source_type": "CARD", "card_details": { "status": "CAPTURED", "card": { "card_brand": "VISA", "last_4": "2796", "exp_month": 7, "exp_year": 2026, "fingerprint": "sq-1-TpmjbNBMFdibiIjpQI5LiRgNUBC7u1689i0TgHjnlyHEWYB7tnn-K4QbW4ttvtaqXw", "card_type": "DEBIT", "prepaid_type": "PREPAID", "bin": "411111" }, "entry_method": "ON_FILE", "cvv_status": "CVV_ACCEPTED", "avs_status": "AVS_ACCEPTED", "auth_result_code": "MhIjEN", "statement_description": "SQ *MY MERCHANT" }, "location_id": "XTI0H92143A39", "order_id": "m2Hr8Hk8A3CTyQQ1k4ynExg92tO3", "reference_id": "123456", "note": "Brief description", "customer_id": "RDX9Z4XTIZR7MRZJUXNY9HUK6I", "receipt_number": "GQTF", "receipt_url": "https://squareup.com/receipt/preview/GQTFp1ZlXdpoW4o6eGiZhbjosiDFf" } }