Skip to main content
POST
Refund a Payment Transaction

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

id
string
required

The resource ID

Body

application/json
amount
object
note
null | string

An optional internal note for the refund transaction

reason
enum<string>
Available options:
duplicate,
fraudulent,
requested_by_customer,
expired_uncaptured_charge

Response

200 - application/json

OK

application_fee_amount
object

The amount which has value in cents and a currency

company_id
string
connected_account_transaction
boolean
created_at
string<date-time>
customer
object
customer_id
string
deleted_at
null | string<date-time>
disallow_partial_refund
null | boolean
id
string
initiated_by
null | string
initiated_by_type
null | string
invoice_number
string
invoice_uuid
string
is_refundable
boolean
is_voidable
boolean
net_amount
object

The amount which has value in cents and a currency

note
null | string
payment_method
object
proposal_id
null | string
provider_transaction_id
string
provider_type
string
refundable_amount
object

The amount which has value in cents and a currency

status
string
status_message
null | string
stripe_fee_amount
object

The amount which has value in cents and a currency

total_amount
object

The amount which has value in cents and a currency

total_amount_default_currency
object

The amount which has value in cents and a currency

total_fee_amount
object

The amount which has value in cents and a currency

transaction_type
string
updated_at
string<date-time>