Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Report payment attempt informational

Report informational updates on the specified Payment Record.

Parameters

  • idstringRequired

    The ID of the Payment Record.

  • customer_detailsobject

    Customer information for this payment.

  • descriptionstring

    An arbitrary string attached to the object. Often useful for displaying to users.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • shipping_detailsobject

    Shipping information for this payment.

Returns

The updated Payment Record object.

POST /v1/payment_records/:id/report_payment_attempt_informational
curl https://api.stripe.com/v1/payment_records/pr_5RV730PrHyAEi/report_payment_attempt_informational \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d description="Updated payment description with additional context" \
  -d "metadata[order_id]"=order_12345 \
  -d "metadata[updated_by]"=customer_service \
  -d "metadata[update_reason]"=customer_inquiry \
  -d "customer_details[name]"="Jenny Rosen" \
  --data-urlencode "customer_details[email]"="jenny.rosen@example.com" \
  --data-urlencode "customer_details[phone]"="+15551234567" \
  -d "shipping_details[name]"="Jenny Rosen" \
  -d "shipping_details[address][line1]"="123 Main Street" \
  -d "shipping_details[address][line2]"="Apt 4B" \
  -d "shipping_details[address][city]"="San Francisco" \
  -d "shipping_details[address][state]"=CA \
  -d "shipping_details[address][postal_code]"=94111 \
  -d "shipping_details[address][country]"=US
Response
{
  "id": "pr_5RV730PrHyAEi",
  "object": "payment_record",
  "amount_canceled": {
    "currency": "usd",
    "value": 0
  },
  "amount_failed": {
    "currency": "usd",
    "value": 0
  },
  "amount_guaranteed": {
    "currency": "usd",
    "value": 0
  },
  "amount_refunded": {
    "currency": "usd",
    "value": 0
  },
  "amount_requested": {
    "currency": "usd",
    "value": 1000
  },
  "created": 1730211363,
  "customer_details": {
    "name": "Jenny Rosen",
    "email": "jenny.rosen@example.com",
    "phone": "+15551234567"
  },
  "customer_presence": "on_session",
  "description": "Updated payment description with additional context",
  "latest_payment_attempt_record": "par_1ArV730PrHyQuG",
  "livemode": true,
  "metadata": {
    "order_id": "order_12345",
    "updated_by": "customer_service",
    "update_reason": "customer_inquiry"
  },
  "payment_method_details": {
    "billing_details": null,
    "custom": {
      "display_name": "newpay",
      "type": "cpmt_125kjj3hn3sdf"
    },
    "payment_method": "pm_5j23kjksibjlks",
    "type": "custom"
  },
  "processor_details": {
    "type": "custom",
    "custom": {
      "payment_reference": "npp2358872734k"
    }
  },
  "shipping_details": {
    "name": "Jenny Rosen",
    "address": {
      "line1": "123 Main Street",
      "line2": "Apt 4B",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94111",
      "country": "US"
    }
  }
}