Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Refunds

Get refunds

The GET /refunds endpoint retrieves a complete or filtered list of refunds.

get/refunds

Query parameters

limitinteger required

The maximum number of records to return.

offsetstring

The offset from the previous page.

startDatestring

Lower bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or after the given date will be returned.

endDatestring

Upper bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or before the given date will be returned.

idsstring[]

Filters refunds by their ids - returns only refunds with ids listed in this parameter.

invertIdsboolean

Invert ids query - returns only refunds with ids not listed in the ids parameter.

{"stackTrail":"paths:/refunds:get:parameters:6:schema:items","oasType":"schema","type":"unknown"}

Filters refunds by their statuses - returns only refunds with statuses listed in this parameter.

invertStatusesboolean

Invert statuses query - returns only refunds with statuses not listed in the statuses parameter.

refIdsstring[]

Filters refunds by their refId values - returns only refunds with refIds listed in this parameter.

partialboolean

Returns refunds in a partial format - with only id and status fields populated.

onBehalfOfIdsstring[]

Filters payouts by their onBehalfOfId values - returns only payouts with the onBehalfOfId values specified in this parameter. This field is mandatory for unregulated TPPs.

Response

Successful response

Example response

{
  "refunds": [
    {
      "id": "rf:12345abcd:abcd",
      "bankTransactionId": "2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV",
      "memberId": "m:123456abcd:abcd",
      "createdDateTime": "2017-04-05T10:43:07.000+00:00",
      "updatedDateTime": "2017-04-05T10:45:07.000+00:00",
      "status": "INITIATION_COMPLETED",
      "bankPaymentStatus": "ACCP",
      "statusReasonInformation": "The payment is settled on debtor side.",
      "initiation": {
        "description": "refund for some reason",
        "refId": "9htio4a1sp2akdr1aa",
        "amount": {
          "value": "10.23",
          "currency": "EUR"
        },
        "originalPaymentId": "t:sdsds:sdsd",
        "registrationId": "regId",
        "localInstrument": "SEPA_INSTANT",
        "debtor": {
          "iban": "GB29NWBK60161331926819",
          "bic": "BOFIIE2D",
          "name": "John Smith",
          "ultimateDebtorName": "John Smith",
          "address": {
            "addressLine": [
              "The Coach House"
            ],
            "streetName": "221B",
            "buildingNumber": "2C",
            "postCode": "TR26 1EZ",
            "townName": "Saint Ives",
            "state": "Cornwall",
            "country": "GB"
          }
        },
        "creditor": {
          "iban": "GB29NWBK60161331926819",
          "bic": "BOFIIE2D",
          "name": "Customer Inc.",
          "ultimateCreditorName": "Customer Inc.",
          "address": {
            "addressLine": [
              "The Coach House"
            ],
            "streetName": "221B",
            "buildingNumber": "2C",
            "postCode": "TR26 1EZ",
            "townName": "Saint Ives",
            "state": "Cornwall",
            "country": "GB"
          }
        }
      }
    }
  ],
  "paging": {
    "offset": "LerV6Jmex"
  }
}