Network APIPayments

Capture payment

Updates a payment with the given amount and finalizes it so that it can be paid out in the next nightly settlement batch.

This endpoint is not rate limited.

Scopes: PAYMENTS_WRITE

Path parameters

payment_idstringRequired

Headers

AcceptstringRequired
X-RegionstringRequired
X-SignaturestringRequired
User-AgentstringRequired

Request

This endpoint expects an object.
idempotency_keystringRequired>=1 character<=64 characters

A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. Learn more about idempotency in the API.

amountintegerRequired>=1

The amount of money to collect from the customer, in the lowest denomination of currency for the payment.

To over-capture or under-capture the payment, set this field to a different value from the current payment amount.

Min value: 1

Response

OK
paymentobject

Errors