Refund a Payment

The Authorization needs to be in the following format:

Authorization: Token <YOUR_API_KEY>

Use this endpoint to refund a payment, either partially or in full.

Path Parameters

business

string

required

The unique identifier of the business.

transaction_reference

string

required

The unique reference of the transaction to be refunded.

Body

application/json

amount

number

required

The monetary value to be refunded.

Response

200 - application/json

integer

The unique identifier of the refund transaction.

provider

string

The payment service provider for the transaction.

country

string

The country associated with the refund.

currency_code

string

The currency code used for the transaction.

created

string

The timestamp when the refund was created.

modified

string

The timestamp when the refund was last modified.

operation_date

string

The date and time when the refund operation was performed.

transaction_reference

string

The reference identifier of the original transaction.

response

object

The response details of the refund operation.

transaction_type

string

The type of transaction (e.g., REFUND).

status

string

The status of the transaction.

amount

string

The amount refunded.

The reference identifier of the related transaction.

reason

string | null

The reason for the refund, if provided.

is_refunded

boolean | null

Indicates if the transaction has been refunded.

is_disputed

boolean | null

Indicates if the transaction is disputed.

number_of_payment_attempts

integer | null

The number of payment attempts made for the transaction.

payment_method_old

string | null

The previous payment method, if applicable.

is_card_international

boolean

Indicates if the card used is international.

card_brand

string | null

The brand of the card used.

number_of_installments

integer

The number of installments for the transaction.

incoming_request

string | null

Details of the incoming request, if any.

metadata

string | null

Additional metadata associated with the transaction.

tonder_intra_transaction_rate

number | null

The intra-transaction rate for Tonder.

tonder_inter_transaction_rate

number | null

The inter-transaction rate for Tonder.

tonder_transaction_fee

number | null

The transaction fee charged by Tonder.

is_fees_computed

boolean

Indicates if the fees have been computed.

fee_amount

number | null

The fee amount charged.

net_amount

number | null

The net amount after fees.

rolling_reserve_amount

number | null

The rolling reserve amount, if any.

has_balance_transaction

boolean

Indicates if there is a balance transaction.

business

object

Details about the business associated with the transaction.

business.id

integer

The unique identifier of the business.

business.created

string

The timestamp when the business was created.

business.modified

string

The timestamp when the business was last modified.

business.name

string

The name of the business.

business.web

string

The website URL of the business.

business.logo

string

The logo URL of the business.

business.checkout_logo

string

The checkout logo URL of the business.

business.background_color

string

The background color used by the business.

business.primary_color

string

The primary color used by the business.

business.textCheckoutColor

string

The text color used for checkout by the business.

business.textDetailsColor

string

The text color used for details by the business.

business.checkout_mode

boolean

Indicates if the business is in checkout mode.

business.total_annual_sales

string

The total annual sales of the business.

business.average_order_sale

string

The average order sale amount of the business.

business.comission

string

The commission percentage charged by the business.

business.status

string

The status of the business.

business.first_time_filled

boolean

Indicates if the business information was filled for the first time.

business.business_info

boolean

Indicates if the business information is provided.

business.business_legal_representation

boolean

Indicates if the legal representation details of the business are provided.

business.business_bank_details

boolean

Indicates if the bank details of the business are provided.

business.show_presentation_data

boolean

Indicates if the presentation data is shown.

business.enabled_smart_routing

boolean

Indicates if smart routing is enabled for the business.

business.enabled_finances

boolean

Indicates if finances are enabled for the business.

business.risk_level

string

The risk level of the business.

business.timezone

string

The timezone of the business.

business.can_change_tonder_psp

boolean

Indicates if the business can change the Tonder payment service provider (PSP).

business.enabled_orchestration

boolean

Indicates if orchestration is enabled for the business.

business.user

integer

The unique identifier of the user associated with the business.

business.e_commerce_platform

string | null

The e-commerce platform used by the business, if any.

business.country

integer

The country ID associated with the business.

business.currency

integer

The currency ID associated with the business.

business.categories

integer[]

The categories associated with the business.

payment

object

Details about the payment.

currency

object

Details about the currency used.

payment_method

string | null

The payment method used.

issuing_country

string | null

The issuing country of the payment method.

Tonder API

API Reference

Refund a Payment

Path Parameters

Body

Response