Query Invoice Refunds

get https://sandbox-api.unipayment.io/v1.0/invoices/refunds

Retrieves a paginated list of invoice refunds based on the specified search criteria.

test

Query Params

status

string

Filters the refunds by their current status. Possible values include "NEW", "CLAIMED", "APPROVED", "REJECTED", "CANCELED", "COMPLETED", "FAILED". This parameter is used to filter invoices by their status.

invoice_id

string

The unique identifier of the invoice. This parameter is used to filter refunds associated with a specific invoice.

start

date

The start date for the invoice query. This parameter is used to filter invoices created after the specified start date.

end

date

The end date for the invoice query. This parameter is used to filter invoices created before the specified end date.

page_size

int32

Defaults to 10

The number of records to return per page. Used for pagination purposes.

page_no

int32

Defaults to 1

The page number to retrieve. Used for pagination purposes.

is_asc

boolean

Defaults to false

Indicates whether the results should be sorted in ascending order. Used to sort the query results.

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox-api.unipayment.io/v1.0/invoices/refunds?page_size=10&page_no=1&is_asc=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400