Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Refunds

List Refunds

Returns a list of all refunds intitated . You can filter the transactions based on status of the refund transaction by passing it in the query parameter. This API allows pagination with the default size of 50 refunds per page.

get/payouts/refunds

Query parameters

status'CREATED' | 'REJECTED' | 'APPROVED' | 'FAILED' | 'ACCEPTED_BY_BANK' | 'PENDING_WITH_BANK'

Fetch all refund transactions based on the entered refund payment status.

sizeinteger

Defines the number of transactions per page hence manages payload size

pageinteger

Specifies the page number to retreive. e.g if page=2 and size=50, the API will return records from 101 to 150

Response

refund_idstring required

Unique identifier for the refund transaction.

deposit_amountnumber required

The deposit amount associated with the refund request.

deposit_currencystring required

The ISO 3 letter currency code for the deposit amount

payment_idstring required

Identifier of the payment transaction linked to this refund.

status'CREATED' | 'APPROVED' | 'REJECTED' | 'ACCEPTED_BY_BANK' | 'PENDING_WITH_BANK' | 'FAILED' required

Current status of the refund process.

amountnumber required

The amount that will be refunded

currencystring required

The ISO 3 letter currency code for the refund amount

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

Reason for the refund request

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

created_atstring date-time required

Timestamp when the refund was created

created_bystring required

Identifier of the user that initiated the refund

actioned_bystring

Identifier of the user that confirmed or rejected the refund