Interface CreateRefundInput

Input for creating a refund.

interface CreateRefundInput {
    amount?: number;
    idempotencyKey?: string;
    metadata?: PaymentMetadata;
    paymentId: string;
    reason?: PaymentRefundReason;
}

Index

Properties

amount? idempotencyKey? metadata? paymentId reason?

Properties

`Optional`amount

amount?: number

Amount in the provider's smallest currency unit. Omit for a full refund.

`Optional`idempotencyKey

idempotencyKey?: string

Provider idempotency key for this external call.

`Optional`metadata

metadata?: PaymentMetadata

Provider metadata.

paymentId

paymentId: string

Provider payment ID, such as a payment intent ID.

`Optional`reason

reason?: PaymentRefundReason

Reason for the refund.