Complete payment

POST

/v2/payments/{payment_id}/complete

Completes (captures) a payment.

By default, payments are set to complete immediately after they are created.

You can use this endpoint to complete a payment with the APPROVED status.

Permissions:PAYMENTS_WRITE

Guide

Delayed capture

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

payment_id

string

Required

The unique ID identifying the payment to be completed.

Link to section

Request body

Link to section

version_token

string

Beta

Used for optimistic concurrency. This opaque token identifies the current Payment version that the caller expects. If the server has a different version of the Payment, the update fails and a response with a VERSION_MISMATCH error is returned.

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

payment

The successfully completed payment.

curl https://connect.squareup.com/v2/payments/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY/complete \ -X POST \ -H 'Square-Version: 2024-04-17' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{}'

{ "payment": { "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", "created_at": "2021-10-13T19:34:33.524Z", "updated_at": "2021-10-13T19:34:34.339Z", "amount_money": { "amount": 555, "currency": "USD" }, "status": "COMPLETED", "delay_duration": "PT168H", "source_type": "CARD", "card_details": { "status": "CAPTURED", "card": { "card_brand": "VISA", "last_4": "1111", "exp_month": 11, "exp_year": 2022, "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ", "card_type": "DEBIT", "prepaid_type": "NOT_PREPAID", "bin": "411111" }, "entry_method": "KEYED", "cvv_status": "CVV_ACCEPTED", "avs_status": "AVS_ACCEPTED", "auth_result_code": "2Nkw7q", "statement_description": "SQ *EXAMPLE TEST GOSQ.C", "card_payment_timeline": { "authorized_at": "2021-10-13T19:34:33.680Z", "captured_at": "2021-10-13T19:34:34.340Z" } }, "location_id": "L88917AVBK2S5", "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY", "processing_fee": [ { "effective_at": "2021-10-13T21:34:35.000Z", "type": "INITIAL", "amount_money": { "amount": 34, "currency": "USD" } } ], "note": "Test Note", "total_money": { "amount": 555, "currency": "USD" }, "approved_money": { "amount": 555, "currency": "USD" }, "employee_id": "TMoK_ogh6rH1o4dV", "receipt_number": "bP9m", "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY", "delay_action": "CANCEL", "delayed_until": "2021-10-20T19:34:33.524Z", "team_member_id": "TMoK_ogh6rH1o4dV", "application_details": { "square_product": "VIRTUAL_TERMINAL", "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA" }, "version_token": "56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o" } }