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
Webhooks

The Payment Attempt Record object 

Attributes

  • idstring

    Unique identifier for the object.

  • amountobject

    The amount you intend to collect for this payment.

  • amount_authorizedobject

    The portion of the requested amount that has been authorized to be guaranteed by the payment provider.

  • amount_canceledobject

    The portion of the requested amount that has been canceled by the user, or that you no longer intend to collect.

  • amount_failedobject

    The portion of the requested amount that failed to be collected.

  • amount_guaranteedobject

    The portion of the requested amount that has been guaranteed by the payment provider.

  • amount_refundedobject

    The amount that has been refunded to the customer on this payment.

  • amount_requestedobject

    The amount you initially requested for this payment.

  • customer_detailsnullable object

    Customer information for this payment.

  • descriptionnullable string

    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.

  • payment_method_detailsnullable object

    Information about the Payment Method debited for this payment.

  • processor_detailsobject

    Processor information for this payment.

  • shipping_detailsnullable object

    Shipping information for this payment.

More attributes

  • objectstring

  • applicationnullable string

  • createdtimestamp

  • customer_presencenullable enum

  • livemodeboolean

  • payment_recordnullable string

  • reported_byenum

The Payment Attempt Record object
{
  "id": "par_4sdDKj23235s",
  "object": "payment_attempt_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": null,
  "customer_presence": "on_session",
  "description": "computer software",
  "livemode": true,
  "metadata": {},
  "payment_method_details": {
    "billing_details": null,
    "custom": {
      "display_name": "newpay",
      "type": "cpmt_125kjj3hn3sdf"
    },
    "payment_method": "pm_5j23kjksibjlks",
    "type": "custom"
  },
  "payment_record": "pr_5RV730PrHyAEi",
  "processor_details": {
    "type": "custom",
    "custom": {
      "payment_reference": "npp2358872734k"
    }
  },
  "shipping_details": null
}

Retrieve a Payment Attempt Record 

Retrieves a Payment Attempt Record with the given ID

Parameters

  • idstringRequired

    The ID of the Payment Attempt Record.

Returns

Returns a Payment Attempt Record object if a valid ID was provided. Otherwise, this call raises an error.

GET /v1/payment_attempt_records/:id
cURL
curl https://api.stripe.com/v1/payment_attempt_records/par_4sdDKj23235s \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "par_4sdDKj23235s",
  "object": "payment_attempt_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": null,
  "customer_presence": "on_session",
  "description": "computer software",
  "livemode": true,
  "metadata": {},
  "payment_method_details": {
    "billing_details": null,
    "custom": {
      "display_name": "newpay",
      "type": "cpmt_125kjj3hn3sdf"
    },
    "payment_method": "pm_5j23kjksibjlks",
    "type": "custom"
  },
  "payment_record": "pr_5RV730PrHyAEi",
  "processor_details": {
    "type": "custom",
    "custom": {
      "payment_reference": "npp2358872734k"
    }
  },
  "shipping_details": null
}

List Payment Attempt Records 

List all the Payment Attempt Records attached to the specified Payment Record.

Parameters

  • payment_recordstringRequired

    The ID of the Payment Record.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A dictionary with a data property that contains an array of Payment Attempt Records.

GET /v1/payment_attempt_records
curl -G https://api.stripe.com/v1/payment_attempt_records \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d payment_record=pr_5RV730PrHyAEi
Response
{
  "object": "list",
  "url": "/v1/payment_attempt_records",
  "has_more": false,
  "data": [
    {
      "id": "par_4sdDKj23235s",
      "object": "payment_attempt_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": null,
      "customer_presence": "on_session",
      "description": "computer software",
      "livemode": true,
      "metadata": {},
      "payment_method_details": {
        "billing_details": null,
        "custom": {
          "display_name": "newpay",
          "type": "cpmt_125kjj3hn3sdf"
        },
        "payment_method": "pm_5j23kjksibjlks",
        "type": "custom"
      },
      "payment_record": "pr_5RV730PrHyAEi",
      "processor_details": {
        "type": "custom",
        "custom": {
          "payment_reference": "npp2358872734k"
        }
      },
      "shipping_details": null
    }
  ]
}