Interface Refund

Export

Refund

Hierarchy

  • Refund

Properties

amount balance_transaction charge_id created_at failure_code? failure_message? id metadata? payment_intent_id payment_method_id? reason? status updated_at

Properties

amount

amount: number

Amount (in the smallest currency unit) refunded.

Memberof

Refund

balance_transaction

balance_transaction: BalanceTransaction

The balance transaction that describes the impact of this refund on your account balance. Note: Multiple balance transactions may be associated with this resource and you can fetch them all with /balance-transactions?source_id={id}.

Memberof

Refund

Deprecated

charge_id

charge_id: string

ID of the Charge that was refunded.

Memberof

Refund

created_at

created_at: string

Time at which the object was created.

Memberof

Refund

Optional failure_code

failure_code?: RefundFailureCode

Error code explaining reason for refund failure.

Memberof

Refund

Optional failure_message

failure_message?: string

Message to user further explaining the reason for the refund failure.

Memberof

Refund

id

id: string

Unique identifier for the object.

Memberof

Refund

Optional metadata

metadata?: {
    [key: string]: string;
}

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.

Memberof

Refund

Type declaration

  • [key: string]: string

payment_intent_id

payment_intent_id: string

ID of the PaymentIntent that was refunded.

Memberof

Refund

Optional payment_method_id

payment_method_id?: string

ID of the payment method that was refunded.

Memberof

Refund

Optional reason

reason?: RefundReason

Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Tilled (expired_uncaptured_charge, partial_capture, or reversal)

Memberof

Refund

status

status: RefundStatus

Status of the refund, one of pending, succeeded, failed, canceled or requires_action.

Memberof

Refund

updated_at

updated_at: string

Time at which the object was last updated.

Memberof

Refund

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc