Report a payment

Changed on

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

post/v1/payment_records/report_payment

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/payment_records/report_payment
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

customer_presence'off_session' | 'on_session'

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

descriptionstring

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

expandstring[]

Specifies which fields in the response should be expanded.

initiated_atinteger required

When the reported payment was initiated. Measured in seconds since the Unix epoch.

outcome'canceled' | 'failed' | 'guaranteed'

The outcome of the reported payment.

Response

Successful response.

applicationstring nullable

ID of the Connect application that created the PaymentRecord.

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.

latest_payment_attempt_recordstring nullable

ID of the latest Payment Attempt Record attached to this Payment Record.

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_record' required

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

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.