Class PaymentRecordsResource

Index

Constructors

Methods

retrieve reportPayment reportPaymentAttempt reportPaymentAttemptCanceled reportPaymentAttemptFailed reportPaymentAttemptGuaranteed reportPaymentAttemptInformational reportRefund

Constructors

constructor

new PaymentRecordsResource(): PaymentRecordsResource
Returns PaymentRecordsResource

Methods

retrieve

retrieve(
    id: string,
    params?: PaymentRecordRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Retrieves a Payment Record with the given ID
Parameters
- id: string
- Optionalparams: PaymentRecordRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:564
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Retrieves a Payment Record with the given ID
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:569

reportPayment

reportPayment(
params: Stripe.PaymentRecordReportPaymentParams,
options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
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.
Parameters
- params: Stripe.PaymentRecordReportPaymentParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:579

reportPaymentAttempt

reportPaymentAttempt(
    id: string,
    params: Stripe.PaymentRecordReportPaymentAttemptParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.
Parameters
- id: string
- params: Stripe.PaymentRecordReportPaymentAttemptParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:588

reportPaymentAttemptCanceled

reportPaymentAttemptCanceled(
    id: string,
    params: PaymentRecordReportPaymentAttemptCanceledParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Report that the most recent payment attempt on the specified Payment Record was canceled.
Parameters
- id: string
- params: PaymentRecordReportPaymentAttemptCanceledParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:598

reportPaymentAttemptFailed

reportPaymentAttemptFailed(
    id: string,
    params: PaymentRecordReportPaymentAttemptFailedParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Report that the most recent payment attempt on the specified Payment Record failed or errored.
Parameters
- id: string
- params: PaymentRecordReportPaymentAttemptFailedParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:608

reportPaymentAttemptGuaranteed

reportPaymentAttemptGuaranteed(
    id: string,
    params: PaymentRecordReportPaymentAttemptGuaranteedParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Report that the most recent payment attempt on the specified Payment Record was guaranteed.
Parameters
- id: string
- params: PaymentRecordReportPaymentAttemptGuaranteedParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:618

reportPaymentAttemptInformational

reportPaymentAttemptInformational(
    id: string,
    params?: Stripe.PaymentRecordReportPaymentAttemptInformationalParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Report informational updates on the specified Payment Record.
Parameters
- id: string
- Optionalparams: Stripe.PaymentRecordReportPaymentAttemptInformationalParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:627
reportPaymentAttemptInformational(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Report informational updates on the specified Payment Record.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:632

reportRefund

reportRefund(
    id: string,
    params: Stripe.PaymentRecordReportRefundParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentRecord>>
Report that the most recent payment attempt on the specified Payment Record was refunded.
Parameters
- id: string
- params: Stripe.PaymentRecordReportRefundParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentRecord>>
- Defined in node_modules/stripe/types/PaymentRecordsResource.d.ts:641

Class PaymentRecordsResource

Index

Constructors

Methods

Constructors

constructor

Returns PaymentRecordsResource

Methods

retrieve

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

reportPayment

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

reportPaymentAttempt

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

reportPaymentAttemptCanceled

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

reportPaymentAttemptFailed

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

reportPaymentAttemptGuaranteed

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

reportPaymentAttemptInformational

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

reportRefund

Parameters

Returns Promise<Response<Stripe.PaymentRecord>>

Settings

On This Page