Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Refunds

Initiate a refund

The POST /refunds endpoint initiates a refund. After the refund is settled, the refund status of the original transfer will be updated. <br/> The debtor field can be optional if you're using the debtor in registration. The creditor field can be optional if the information is available in the original payment.

post/refunds

Request body

Example request

{
  "initiation": {
    "description": "refund for some reason",
    "refId": "9htio4a1sp2akdr1aa",
    "amount": {
      "value": "10.23",
      "currency": "EUR"
    },
    "originalPaymentId": "t:sdsds:sdsd",
    "registrationId": "regId",
    "localInstrument": "SEPA_INSTANT",
    "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
    "corporateApiDebtor": {
      "accountId": "a12345"
    }
  }
}

Response

Successful response

Example response

{
  "refund": {
    "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"
        }
      }
    }
  }
}