Retrieve payment

GET

/payments/:payment_id

GET

/network/v1/payments/:payment_id

curl https://api.cash.app/network/v1/payments/PWC_4nn21zy6t0v2yhqg5bvhk7xkq

{
  "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"
          }
        ]
      }
    ]
  }
}

Retrieves a payment by its ID.

This endpoint is not rate limited.

Scopes: PAYMENTS_READ

Path parameters

payment_idstringRequired

ID of the payment to retrieve.

Response

paymentobject

Errors

404

Retrieve Payment Request Not Found Error

Path parameters

Headers

Response

Errors