Payment.Settlement Accounts
List refunds
Lists the refunds for a specific settlement account and merchant.
get/payment/v1/merchants/{merchantId}/accounts/{accountId}/refunds
Path parameters
merchantIdstring required
The id of the merchant.
accountIdstring required
The id of the account.
Query parameters
pageSizeinteger
The maximum number of items to return.
pageTokenstring
Token to the requested page.
createdTimeLtestring date-time
Date less than or equal operator.
createdTimeGtestring date-time
Date greater than or equal operator.
referenceEqstring
Reference to filter the refunds by.
transactionIdEqstring
Transaction id to filter the refunds by.
Response
A successful response.
Example response
{
"nextPageToken": "MA=",
"prevPageToken": "MA==",
"refunds": [
{
"accountId": "161ec210-721f-4df5-b21c-f78a9d4c1545",
"amount": {
"currencyCode": "EUR",
"value": {
"scale": "2",
"unscaledValue": "5000"
}
},
"createdTime": "2022-07-14T14:01:53Z",
"id": "b58d313a-b778-4639-8e31-c9ffc35e2d01",
"merchantId": "e06e47f1-8c88-47ee-9415-a4cde72ae598",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"reference": "Refund7ad0feabb4ab",
"scheme": "SEPA_INSTANT_CREDIT_TRANSFER",
"status": "COMPLETED",
"transactionId": "7ad0feab-bd55-449d-aa7e-b3d3b9c62550",
"updatedTime": "2022-07-14T14:08:53Z"
}
],
"totalSize": "1"
}