RefundResponse

Refund objects allow you to refund a previously created payment that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged.

  • id
    Type: string
    required

    Unique identifier for the refund.

  • created
    Type: stringFormat: date-time
    required

    Unix timestamp when refund was created.

  • updated
    Type: stringFormat: date-time

    When the transaction was last updated.

  • currency
    Type: Currency
    required

    Three-letter ISO currency code

    Properties: 2
  • payment

    ID of the payment that's refunded.

    • Type: PaymentId
      max length:  
      100

      ID of the payment that's refunded.

  • payment_intent

    ID of the PaymentIntent that's refunded.

    • Type: IntentId
      max length:  
      100

      ID of the PaymentIntent that's refunded.

  • status
    Type: string | null
    max length:  
    100

    Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled. Learn more about failed refunds.

  • amount
    Type: amountWithCurrencyPrecisionFormat: int64
    required

    Integer amount in minor units (e.g. cents) specific to the currency. Example: 100 for €1.00

  • destination_details
    Type: RefundDestinationDetails

    Details about the destination account to which the refund was credited.

    Properties: 2
  • failure_reason
    Type: string
    max length:  
    5000

    Provides the reason for the refund failure. Possible values are: lost_or_stolen_card, expired_or_canceled_card, charge_for_pending_refund_disputed, insufficient_funds, declined, merchant_request, or unknown.

  • pending_reason
    Type: "charge_pending" or "insufficient_funds" or "processing"enum

    Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.

  • reason
    Type: string | nullenum

    Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Paypercut internally (expired_uncaptured_charge).

    values
    • duplicate
    • expired_uncaptured_charge
    • fraudulent
    • requested_by_customer