Retrieve a Payment Attempt Record

Changed on

Retrieves a Payment Attempt Record with the given ID

get/v1/payment_attempt_records/{id}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/payment_attempt_records/{id}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

idstring required

The ID of the Payment Attempt Record.

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

applicationstring nullable

ID of the Connect application that created the PaymentAttemptRecord.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

customer_presence'off_session' | 'on_session' nullable

Indicates whether the customer was present in your checkout flow during this payment.

descriptionstring nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'payment_attempt_record' required

String representing the object's type. Objects of the same type share the same value.

payment_recordstring nullable

ID of the Payment Record this Payment Attempt Record belongs to.

reported_by'self' | 'stripe' required

Indicates who reported the payment.

Changes

  • ae4d4352c52eRevision changes
    • info

      added to the /// response property anyOf list for the response status

    • info

      removed from the /// response property anyOf list for the response status

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

Some revisions have not been checked yet.