Refund a Charge or a PaymentIntent in-person

Changed on

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

post/v1/terminal/readers/{reader}/refund_payment

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/terminal/readers/{reader}/refund_payment
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

readerstring required

Request body application/x-www-form-urlencoded

amountinteger

A positive integer in cents representing how much of this charge to refund.

chargestring

ID of the Charge to refund.

expandstring[]

Specifies which fields in the response should be expanded.

metadataobject

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

payment_intentstring

ID of the PaymentIntent to refund.

refund_application_feeboolean

Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.

reverse_transferboolean

Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.

Response

Successful response.

device_sw_versionstring nullable

The current software version of the reader.

device_type'bbpos_chipper2x' | 'bbpos_wisepad3' | 'bbpos_wisepos_e' | 'mobile_phone_reader' | 'simulated_stripe_s700' | 'simulated_stripe_s710' | 'simulated_verifone_m425' | 'simulated_verifone_p630' | 'simulated_verifone_ux700' | 'simulated_verifone_v660p' | 'simulated_wisepos_e' | 'stripe_m2' | 'stripe_s700' | 'stripe_s710' | 'verifone_P400' | 'verifone_m425' | 'verifone_p630' | 'verifone_ux700' | 'verifone_v660p' required

Device type of the reader.

idstring required

Unique identifier for the object.

ip_addressstring nullable

The local IP address of the reader.

labelstring required

Custom label given to the reader for easier identification.

last_seen_atinteger nullable

The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds.

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'terminal.reader' required

String representing the object's type. Objects of the same type share the same value.

serial_numberstring required

Serial number of the reader.

status'offline' | 'online' nullable

The networking status of the reader. This value is null for mobile readers. We do not recommend using this field in flows that may block taking payments.

Changes

  • 5b74d8d10539Revision changes
    • warning

      added the new simulated_stripe_s710 enum value to the response property for the response status

    • warning

      added the new stripe_s710 enum value to the response property for the response status

  • c113b1939b8fRevision changes
    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status

Some revisions have not been checked yet.