Retrieve a Payment Record

Retrieves a Payment Record with the given ID

get/v1/payment_records/{id}

Path parameters

idstring required

The ID of the Payment Record.

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

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

Changed in 4 of the 51 revisions of this API.304

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/bancontact/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/ideal/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/card/generated_from/anyOf[subschema #1: payment_method_card_generated_card]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    • removed the required property payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/sofort/generated_sepa_debit/anyOf[subschema #2: PaymentMethod]/sepa_debit/generated_from/anyOf[subschema #1: sepa_debit_generated_from]/setup_attempt/anyOf[subschema #2: PaymentFlowsSetupIntentSetupAttempt]/setup_error/anyOf[subschema #1: APIErrors]/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the 200 status

      response-required-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    • added payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store to the payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/konbini/store response property anyOf list for the response status 200

      response-property-any-of-added

    • removed payment_method_details_konbini_store from the payment_method_details/anyOf[subschema #1: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails]/konbini/store response property anyOf list for the response status 200

      response-property-any-of-removed

    • added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status

      response-optional-property-added

    • added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status

      response-optional-property-added

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.