Refund List

Transactions

Returns List refunds for a transaction.

GEThttps://api.efundpay.com/v4/transactions/{transaction_id}/refunds

This endpoint requires the transactions.read scope.

Authorizations

Authorizationstringheaderrequired

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

Headers

x-merchant-account-idstringrequired

The ID of the merchant account to use for this request.

Examples:""default""

Path Parameters

transaction_idstringrequired

The unique identifier of the transaction to retrieve.

Examples:"7099948d-7286-47e4-aad8-b68f7eb44591"

cursorstring

A pointer to the page of results to return.

Examples:"0"

limitinteger

The maximum number of items that are at returned.

Examples:"20"

Response

application/json

Successful Response

itemsRefund · object[]required

A list of refund objects returned for a transaction.

limitinteger

The number of items for this page.

Default:20

Required range:1 <= x <= 100

Examples:"20"

next_cursorstring | null

The cursor pointing at the next page of items.

Required string length:1 - 1000

Examples:"2"

previous_cursorstring | null

The cursor pointing at the previous page of items.

Required string length:1 - 1000

Examples:"1"

curl --request GET \
  --url https://api.efundpay.com/v4/transactions/{transaction_id}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'x-merchant-account-id: <x-merchant-account-id>'

{
  "items": [
    {
      "type": "refund",
      "id": "7099948d-7286-47e4-aad8-b68f7eb44591",
      "transaction_id": "45455948d-7286-47e4-aad8-b68f7eb22391",
      "currency": "EUR",
      "amount": 1299,
      "status": "authorization_succeeded",
      "external_identifier": "refund-12345",
      "transaction_external_identifier": "transaction-12345",
      "reason": "Refund due to user request.",
      "created_at": "2013-07-16T19:23:00.000+00:00"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}