v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB

Refunds

Create Refunds

Creates and queues a refund payment for approval or rejection. Refunds are always returned to the originating account of the corresponding payment. The total refund amount cannot exceed the original payment. For processing amounts greater than the original payment, please refer to payouts.

post/payouts/refunds

Headers

Content-Typestring required

Request body

payment_idstring required

Unique identifier for the corresponding intitiated payment

amountinteger required

The refund amount to be processed.

currencystring

The ISO 3 letter currency code for the account stores value in.

reason_code'FRAUDULENT_PAYMENT' | 'ORDER_CANCELLED' | 'DUPLICATED_PAYMENT' | 'CUSTOMER_REQUEST' required

Code indicating the reason for the refund

descriptionstring

Additional notes about the refund being created. Can include order references/customer-id for the refund being generated.

external_referencestring

Useful for tracking and reporting the transaction on your end. e.g You can enter transaction ID of this refund maintained in your system

status'CREATED' | 'APPROVED'

Refers to the transaction status of the refund being created.

Response

refund_idstring required

Unique identifier for the refund inititated

payment_idstring required

Unique identifier for the payment inititated

status'CREATED' | 'APPROVED' | '' required

Status of the payment. Default is INITIATED. Acceptable values: INITIATED or CONFIRMED

amountnumber required

The refund amount to be processed.

currencystring required

The ISO 3 letter currency code for the refund amount

reason_code'CUSTOMER_REQUEST' | 'DUPLICATED_PAYMENT' | 'ORDER_CANCELLED' | 'FRAUDULENT_PAYMENT' required

Code indicating the reason for the refund

descriptionstring required

Additional notes about the refund being created. Can include order references/customer-id for the refund being generated

external_referencestring required

Useful for tracking and reporting the transaction on your end. e.g You can enter transaction ID of this refund maintained in your system