Create incremental authorization | Welcome to cash-app Documentation

curl -X POST https://api.cash.app/network/v1/payments/PWC_4nn21zy6t0v2yhqg5bvhk7xkq/authorizations \
     -H "Content-Type: application/json" \
     -d '{
  "idempotency_key": "e345c3fb-1caa-46fd-b0d3-aa6c7b00ab19",
  "authorization": {
    "amount": 100,
    "currency": "USD"
  }
}'

{
  "authorization": {
    "id": "id",
    "amount": 1,
    "currency": "USD",
    "status": "AUTHORIZED",
    "created_at": "2024-01-15T09:30:00Z",
    "payment_id": "payment_id",
    "previous_amount": 1,
    "reference_id": "reference_id",
    "metadata": {
      "my-meta": "meta-value"
    },
    "decline_errors": [
      {
        "category": "INVALID_REQUEST_ERROR",
        "code": "MISSING_REQUIRED_FIELD",
        "detail": "Missing required parameter.",
        "field": "field_a[2].field_b"
      }
    ]
  }
}

Creates an authorization update for a payment. The authorization amount must be greater than or equal to the current authorized amount.

Use this endpoint for incremental authorization instead of overcapturing using the Capture payment endpoint. By creating additional payment authorizations exceeding the current authorized amount, you can request additional funds without risking the original amount being declined.

This endpoint is not rate limited.

Scopes: PAYMENTS_WRITE

Creates an authorization update for a payment. The authorization amount must be greater than or equal to the current authorized amount. Use this endpoint for incremental authorization instead of overcapturing using the Capture payment endpoint. By creating additional payment authorizations exceeding the current authorized amount, you can request additional funds without risking the original amount being declined. **This endpoint is not rate limited.** Scopes: `PAYMENTS_WRITE`

Path parameters

payment_idstringRequired

ID of the payment to create an authorization for.

Request

This endpoint expects an object.

idempotency_keystringRequired1-64 characters

A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. For more information, see Idempotency.

authorizationobjectRequired

Details about the authorization to create.

Response

Created

authorizationobject

Represents an authorization update for a payment

Errors

400

Create Payment Authorization Request Bad Request Error

404

Create Payment Authorization Request Not Found Error

Path parameters

Headers

Request

Response

Errors