<- Payments API

Payments API

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
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.