Create payment | Welcome to cash-app Documentation

curl -X POST https://api.cash.app/network/v1/payments \
     -H "Content-Type: application/json" \
     -d '{
  "idempotency_key": "e345c3fb-1caa-46fd-b0d3-aa6c7b00ab19",
  "payment": {
    "amount": 100,
    "currency": "USD",
    "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
    "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
    "reference_id": "external-id",
    "capture": true,
    "metadata": {
      "key": "value"
    },
    "enrichments": {
      "recurring_series_id": "string"
    }
  }
}'

{
  "payment": {
    "id": "PWC_4nn21zy6t0v2yhqg5bvhk7xkq",
    "amount": 1500,
    "net_amount": 1000,
    "captured_amount": 1000,
    "voided_amount": 0,
    "refunded_amount": 100,
    "currency": "USD",
    "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
    "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
    "grant_id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
    "status": "AUTHORIZED",
    "created_at": "2022-01-01T12:00:00Z",
    "updated_at": "2022-01-05T12:00:00Z",
    "capture_before": "2022-01-08T12:00:00Z",
    "refund_ids": [
      "PWCR_da1v3j4p3z15y47adpzzq0whj"
    ],
    "reference_id": "external-id",
    "metadata": {
      "key": "value"
    },
    "enrichments": {
      "initiation": {
        "actor": "CUSTOMER"
      },
      "recurring_series_id": "string",
      "statement_descriptor": "statement_descriptor",
      "restricted_categories": [
        "ALCOHOL"
      ]
    },
    "decline_errors": [
      {
        "category": "INVALID_REQUEST_ERROR",
        "code": "MISSING_REQUIRED_FIELD",
        "detail": "Missing required parameter.",
        "field": "field_a[2].field_b"
      }
    ],
    "fee_amount": 1.1,
    "fee_rate": {
      "basis_points": 160,
      "fixed_amount": 20
    },
    "authorization_updates": [
      {
        "id": "id",
        "amount": 1,
        "currency": "USD",
        "status": "AUTHORIZED",
        "created_at": "2024-01-15T09:30:00Z",
        "payment_id": "payment_id",
        "previous_amount": 1,
        "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 a payment from a customer to a merchant.

Creating a payment requires a grant that is associated with the ON_FILE_PAYMENT or ONE_TIME_PAYMENT actions. To generate a grant, use the Customer Request API.

This endpoint is not rate limited.

Scopes: PAYMENTS_WRITE

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.

paymentobjectRequired

Data about the payment to create.

Response

Created

paymentobjectOptional

Errors

400

Create Payment Request Bad Request Error

Headers

Request

Response

Errors