Return transaction

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_info": "<string>",
  "compensation_amount": 123,
  "tax_amount": 123
}
'

import requests

url = "https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return"

payload = {
    "additional_info": "<string>",
    "compensation_amount": 123,
    "tax_amount": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({additional_info: '<string>', compensation_amount: 123, tax_amount: 123})
};

fetch('https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'additional_info' => '<string>',
    'compensation_amount' => 123,
    'tax_amount' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return"

	payload := strings.NewReader("{\n  \"additional_info\": \"<string>\",\n  \"compensation_amount\": 123,\n  \"tax_amount\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return")
  .header("Content-Type", "application/json")
  .body("{\n  \"additional_info\": \"<string>\",\n  \"compensation_amount\": 123,\n  \"tax_amount\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additional_info\": \"<string>\",\n  \"compensation_amount\": 123,\n  \"tax_amount\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "cr_amount": 123,
  "cr_ccy_isocode": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "dr_amount": 123,
  "dr_ccy_isocode": "<string>",
  "id": 123,
  "metadata": [
    "<string>"
  ],
  "status": "<string>",
  "status_hardvalue": "<string>",
  "status_id": 123,
  "type": "<string>",
  "type_id": 123,
  "adjustment_display_parties": {
    "creditor": {
      "account": "<string>",
      "bic": "<string>",
      "name": "<string>"
    },
    "debtor": {
      "account": "<string>",
      "bic": "<string>",
      "name": "<string>"
    }
  },
  "compensation_amt": 123,
  "inbound": {
    "cr_amount": 123,
    "cr_ccy_isocode": "<string>",
    "id": 123,
    "sepa_msg_id": "<string>",
    "status": "<string>",
    "cr_acc": "<string>",
    "cr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "cr_address": "<string>",
    "cr_address_city": "<string>",
    "cr_address_country": "<string>",
    "cr_alt_code_company": "<string>",
    "cr_alt_code_company_issuer": "<string>",
    "cr_bank_bic": "<string>",
    "cr_bank_name": "<string>",
    "cr_building_name": "<string>",
    "cr_building_number": "<string>",
    "cr_code_company": "<string>",
    "cr_code_issuer": "<string>",
    "cr_code_person": "<string>",
    "cr_country_sub_division": "<string>",
    "cr_department": "<string>",
    "cr_district_name": "<string>",
    "cr_floor": "<string>",
    "cr_name": "<string>",
    "cr_post_box": "<string>",
    "cr_post_code": "<string>",
    "cr_room": "<string>",
    "cr_street_name": "<string>",
    "cr_sub_department": "<string>",
    "cr_town_location_name": "<string>",
    "dr_acc": "<string>",
    "dr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "dr_address": "<string>",
    "dr_address_city": "<string>",
    "dr_address_country": "<string>",
    "dr_alt_code_company": "<string>",
    "dr_alt_code_company_issuer": "<string>",
    "dr_bank_bic": "<string>",
    "dr_bank_name": "<string>",
    "dr_building_name": "<string>",
    "dr_building_number": "<string>",
    "dr_code_company": "<string>",
    "dr_code_issuer": "<string>",
    "dr_code_person": "<string>",
    "dr_country_sub_division": "<string>",
    "dr_department": "<string>",
    "dr_district_name": "<string>",
    "dr_floor": "<string>",
    "dr_name": "<string>",
    "dr_post_box": "<string>",
    "dr_post_code": "<string>",
    "dr_room": "<string>",
    "dr_street_name": "<string>",
    "dr_sub_department": "<string>",
    "dr_town_location_name": "<string>",
    "end_to_end_id": "<string>",
    "method": "SEPA",
    "settlement_bic": "<string>",
    "settlement_date": "2023-12-25",
    "settlement_iban": "<string>",
    "settlement_other_account_id": "<string>",
    "trx_purpose": "<string>",
    "trx_purpose_information": "<string>",
    "trx_purpose_structured_issuer": "<string>",
    "trx_purpose_structured_ref": "<string>",
    "ucr_address": "<string>",
    "ucr_address_city": "<string>",
    "ucr_address_country": "<string>",
    "ucr_id_type": 123,
    "ucr_identification": "<string>",
    "ucr_issuer": "<string>",
    "ucr_name": "<string>",
    "ucr_organisation_bic": "<string>",
    "ucr_private_birth": "<string>",
    "ucr_private_birth_city": "<string>",
    "ucr_private_birth_country": "<string>",
    "ucr_private_birth_province": "<string>",
    "ucr_scheme_code": "<string>",
    "ucr_scheme_proprietary": "<string>",
    "udr_address": "<string>",
    "udr_address_city": "<string>",
    "udr_address_country": "<string>",
    "udr_id_type": 123,
    "udr_identification": "<string>",
    "udr_issuer": "<string>",
    "udr_name": "<string>",
    "udr_organisation_bic": "<string>",
    "udr_private_birth": "<string>",
    "udr_private_birth_city": "<string>",
    "udr_private_birth_country": "<string>",
    "udr_private_birth_province": "<string>",
    "udr_scheme_code": "<string>",
    "udr_scheme_proprietary": "<string>",
    "uetr": "<string>"
  },
  "mandate_information": {
    "date_of_signature": "2023-12-25",
    "id": "<string>"
  },
  "origin_bic": "<string>",
  "origin_name": "<string>",
  "origin_reason_code": "<string>",
  "origin_reason_info": "<string>",
  "outbound": {
    "dr_amount": 123,
    "dr_ccy_isocode": "<string>",
    "id": 123,
    "sepa_msg_id": "<string>",
    "status": "<string>",
    "cr_acc": "<string>",
    "cr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "cr_address": "<string>",
    "cr_address_city": "<string>",
    "cr_address_country": "<string>",
    "cr_alt_code_company": "<string>",
    "cr_alt_code_company_issuer": "<string>",
    "cr_bank_bic": "<string>",
    "cr_bank_name": "<string>",
    "cr_building_name": "<string>",
    "cr_building_number": "<string>",
    "cr_code_company": "<string>",
    "cr_code_issuer": "<string>",
    "cr_code_person": "<string>",
    "cr_country_sub_division": "<string>",
    "cr_department": "<string>",
    "cr_district_name": "<string>",
    "cr_floor": "<string>",
    "cr_name": "<string>",
    "cr_post_box": "<string>",
    "cr_post_code": "<string>",
    "cr_room": "<string>",
    "cr_street_name": "<string>",
    "cr_sub_department": "<string>",
    "cr_town_location_name": "<string>",
    "dr_acc": "<string>",
    "dr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "dr_address": "<string>",
    "dr_address_city": "<string>",
    "dr_address_country": "<string>",
    "dr_alt_code_company": "<string>",
    "dr_alt_code_company_issuer": "<string>",
    "dr_bank_bic": "<string>",
    "dr_bank_name": "<string>",
    "dr_building_name": "<string>",
    "dr_building_number": "<string>",
    "dr_code_company": "<string>",
    "dr_code_issuer": "<string>",
    "dr_code_person": "<string>",
    "dr_country_sub_division": "<string>",
    "dr_department": "<string>",
    "dr_district_name": "<string>",
    "dr_floor": "<string>",
    "dr_name": "<string>",
    "dr_post_box": "<string>",
    "dr_post_code": "<string>",
    "dr_room": "<string>",
    "dr_street_name": "<string>",
    "dr_sub_department": "<string>",
    "dr_town_location_name": "<string>",
    "end_to_end_id": "<string>",
    "method": "SEPA",
    "priority": "<string>",
    "settlement_bic": "<string>",
    "settlement_currency": "<string>",
    "settlement_date": "2023-12-25",
    "settlement_iban": "<string>",
    "settlement_method": "<string>",
    "settlement_other_account_id": "<string>",
    "settlement_other_account_issuer": "<string>",
    "settlement_other_account_scheme": "<string>",
    "trx_purpose": "<string>",
    "trx_purpose_information": "<string>",
    "trx_purpose_structured_issuer": "<string>",
    "trx_purpose_structured_ref": "<string>",
    "ucr_address": "<string>",
    "ucr_address_city": "<string>",
    "ucr_address_country": "<string>",
    "ucr_id_type": 123,
    "ucr_identification": "<string>",
    "ucr_issuer": "<string>",
    "ucr_name": "<string>",
    "ucr_organisation_bic": "<string>",
    "ucr_private_birth": "<string>",
    "ucr_private_birth_city": "<string>",
    "ucr_private_birth_country": "<string>",
    "ucr_private_birth_province": "<string>",
    "ucr_scheme_code": "<string>",
    "ucr_scheme_proprietary": "<string>",
    "udr_address": "<string>",
    "udr_address_city": "<string>",
    "udr_address_country": "<string>",
    "udr_id_type": 123,
    "udr_identification": "<string>",
    "udr_issuer": "<string>",
    "udr_name": "<string>",
    "udr_organisation_bic": "<string>",
    "udr_private_birth": "<string>",
    "udr_private_birth_city": "<string>",
    "udr_private_birth_country": "<string>",
    "udr_private_birth_province": "<string>",
    "udr_scheme_code": "<string>",
    "udr_scheme_proprietary": "<string>",
    "uetr": "<string>"
  },
  "parent_trx_amt": 123,
  "parent_trx_id": 123,
  "rtrn_chrgs_amt": 123,
  "sepa_trx_id": "<string>",
  "sequence_type": "FRST",
  "status_reason": "<string>",
  "t2": {
    "priority": "HIGH",
    "uetr": "a1b2c3d4-1111-4222-8333-000000000001"
  },
  "unaccounted_tax_amt": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

POST

transactions

{id}

:return

Return transaction

curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_info": "<string>",
  "compensation_amount": 123,
  "tax_amount": 123
}
'

import requests

url = "https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return"

payload = {
    "additional_info": "<string>",
    "compensation_amount": 123,
    "tax_amount": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({additional_info: '<string>', compensation_amount: 123, tax_amount: 123})
};

fetch('https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'additional_info' => '<string>',
    'compensation_amount' => 123,
    'tax_amount' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return"

	payload := strings.NewReader("{\n  \"additional_info\": \"<string>\",\n  \"compensation_amount\": 123,\n  \"tax_amount\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return")
  .header("Content-Type", "application/json")
  .body("{\n  \"additional_info\": \"<string>\",\n  \"compensation_amount\": 123,\n  \"tax_amount\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pgw-sandbox.finventi.com/v1/transactions/{id}:return")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additional_info\": \"<string>\",\n  \"compensation_amount\": 123,\n  \"tax_amount\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "cr_amount": 123,
  "cr_ccy_isocode": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "dr_amount": 123,
  "dr_ccy_isocode": "<string>",
  "id": 123,
  "metadata": [
    "<string>"
  ],
  "status": "<string>",
  "status_hardvalue": "<string>",
  "status_id": 123,
  "type": "<string>",
  "type_id": 123,
  "adjustment_display_parties": {
    "creditor": {
      "account": "<string>",
      "bic": "<string>",
      "name": "<string>"
    },
    "debtor": {
      "account": "<string>",
      "bic": "<string>",
      "name": "<string>"
    }
  },
  "compensation_amt": 123,
  "inbound": {
    "cr_amount": 123,
    "cr_ccy_isocode": "<string>",
    "id": 123,
    "sepa_msg_id": "<string>",
    "status": "<string>",
    "cr_acc": "<string>",
    "cr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "cr_address": "<string>",
    "cr_address_city": "<string>",
    "cr_address_country": "<string>",
    "cr_alt_code_company": "<string>",
    "cr_alt_code_company_issuer": "<string>",
    "cr_bank_bic": "<string>",
    "cr_bank_name": "<string>",
    "cr_building_name": "<string>",
    "cr_building_number": "<string>",
    "cr_code_company": "<string>",
    "cr_code_issuer": "<string>",
    "cr_code_person": "<string>",
    "cr_country_sub_division": "<string>",
    "cr_department": "<string>",
    "cr_district_name": "<string>",
    "cr_floor": "<string>",
    "cr_name": "<string>",
    "cr_post_box": "<string>",
    "cr_post_code": "<string>",
    "cr_room": "<string>",
    "cr_street_name": "<string>",
    "cr_sub_department": "<string>",
    "cr_town_location_name": "<string>",
    "dr_acc": "<string>",
    "dr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "dr_address": "<string>",
    "dr_address_city": "<string>",
    "dr_address_country": "<string>",
    "dr_alt_code_company": "<string>",
    "dr_alt_code_company_issuer": "<string>",
    "dr_bank_bic": "<string>",
    "dr_bank_name": "<string>",
    "dr_building_name": "<string>",
    "dr_building_number": "<string>",
    "dr_code_company": "<string>",
    "dr_code_issuer": "<string>",
    "dr_code_person": "<string>",
    "dr_country_sub_division": "<string>",
    "dr_department": "<string>",
    "dr_district_name": "<string>",
    "dr_floor": "<string>",
    "dr_name": "<string>",
    "dr_post_box": "<string>",
    "dr_post_code": "<string>",
    "dr_room": "<string>",
    "dr_street_name": "<string>",
    "dr_sub_department": "<string>",
    "dr_town_location_name": "<string>",
    "end_to_end_id": "<string>",
    "method": "SEPA",
    "settlement_bic": "<string>",
    "settlement_date": "2023-12-25",
    "settlement_iban": "<string>",
    "settlement_other_account_id": "<string>",
    "trx_purpose": "<string>",
    "trx_purpose_information": "<string>",
    "trx_purpose_structured_issuer": "<string>",
    "trx_purpose_structured_ref": "<string>",
    "ucr_address": "<string>",
    "ucr_address_city": "<string>",
    "ucr_address_country": "<string>",
    "ucr_id_type": 123,
    "ucr_identification": "<string>",
    "ucr_issuer": "<string>",
    "ucr_name": "<string>",
    "ucr_organisation_bic": "<string>",
    "ucr_private_birth": "<string>",
    "ucr_private_birth_city": "<string>",
    "ucr_private_birth_country": "<string>",
    "ucr_private_birth_province": "<string>",
    "ucr_scheme_code": "<string>",
    "ucr_scheme_proprietary": "<string>",
    "udr_address": "<string>",
    "udr_address_city": "<string>",
    "udr_address_country": "<string>",
    "udr_id_type": 123,
    "udr_identification": "<string>",
    "udr_issuer": "<string>",
    "udr_name": "<string>",
    "udr_organisation_bic": "<string>",
    "udr_private_birth": "<string>",
    "udr_private_birth_city": "<string>",
    "udr_private_birth_country": "<string>",
    "udr_private_birth_province": "<string>",
    "udr_scheme_code": "<string>",
    "udr_scheme_proprietary": "<string>",
    "uetr": "<string>"
  },
  "mandate_information": {
    "date_of_signature": "2023-12-25",
    "id": "<string>"
  },
  "origin_bic": "<string>",
  "origin_name": "<string>",
  "origin_reason_code": "<string>",
  "origin_reason_info": "<string>",
  "outbound": {
    "dr_amount": 123,
    "dr_ccy_isocode": "<string>",
    "id": 123,
    "sepa_msg_id": "<string>",
    "status": "<string>",
    "cr_acc": "<string>",
    "cr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "cr_address": "<string>",
    "cr_address_city": "<string>",
    "cr_address_country": "<string>",
    "cr_alt_code_company": "<string>",
    "cr_alt_code_company_issuer": "<string>",
    "cr_bank_bic": "<string>",
    "cr_bank_name": "<string>",
    "cr_building_name": "<string>",
    "cr_building_number": "<string>",
    "cr_code_company": "<string>",
    "cr_code_issuer": "<string>",
    "cr_code_person": "<string>",
    "cr_country_sub_division": "<string>",
    "cr_department": "<string>",
    "cr_district_name": "<string>",
    "cr_floor": "<string>",
    "cr_name": "<string>",
    "cr_post_box": "<string>",
    "cr_post_code": "<string>",
    "cr_room": "<string>",
    "cr_street_name": "<string>",
    "cr_sub_department": "<string>",
    "cr_town_location_name": "<string>",
    "dr_acc": "<string>",
    "dr_acc_other": {
      "id": "<string>",
      "issuer": "<string>",
      "scheme_name_code": "<string>"
    },
    "dr_address": "<string>",
    "dr_address_city": "<string>",
    "dr_address_country": "<string>",
    "dr_alt_code_company": "<string>",
    "dr_alt_code_company_issuer": "<string>",
    "dr_bank_bic": "<string>",
    "dr_bank_name": "<string>",
    "dr_building_name": "<string>",
    "dr_building_number": "<string>",
    "dr_code_company": "<string>",
    "dr_code_issuer": "<string>",
    "dr_code_person": "<string>",
    "dr_country_sub_division": "<string>",
    "dr_department": "<string>",
    "dr_district_name": "<string>",
    "dr_floor": "<string>",
    "dr_name": "<string>",
    "dr_post_box": "<string>",
    "dr_post_code": "<string>",
    "dr_room": "<string>",
    "dr_street_name": "<string>",
    "dr_sub_department": "<string>",
    "dr_town_location_name": "<string>",
    "end_to_end_id": "<string>",
    "method": "SEPA",
    "priority": "<string>",
    "settlement_bic": "<string>",
    "settlement_currency": "<string>",
    "settlement_date": "2023-12-25",
    "settlement_iban": "<string>",
    "settlement_method": "<string>",
    "settlement_other_account_id": "<string>",
    "settlement_other_account_issuer": "<string>",
    "settlement_other_account_scheme": "<string>",
    "trx_purpose": "<string>",
    "trx_purpose_information": "<string>",
    "trx_purpose_structured_issuer": "<string>",
    "trx_purpose_structured_ref": "<string>",
    "ucr_address": "<string>",
    "ucr_address_city": "<string>",
    "ucr_address_country": "<string>",
    "ucr_id_type": 123,
    "ucr_identification": "<string>",
    "ucr_issuer": "<string>",
    "ucr_name": "<string>",
    "ucr_organisation_bic": "<string>",
    "ucr_private_birth": "<string>",
    "ucr_private_birth_city": "<string>",
    "ucr_private_birth_country": "<string>",
    "ucr_private_birth_province": "<string>",
    "ucr_scheme_code": "<string>",
    "ucr_scheme_proprietary": "<string>",
    "udr_address": "<string>",
    "udr_address_city": "<string>",
    "udr_address_country": "<string>",
    "udr_id_type": 123,
    "udr_identification": "<string>",
    "udr_issuer": "<string>",
    "udr_name": "<string>",
    "udr_organisation_bic": "<string>",
    "udr_private_birth": "<string>",
    "udr_private_birth_city": "<string>",
    "udr_private_birth_country": "<string>",
    "udr_private_birth_province": "<string>",
    "udr_scheme_code": "<string>",
    "udr_scheme_proprietary": "<string>",
    "uetr": "<string>"
  },
  "parent_trx_amt": 123,
  "parent_trx_id": 123,
  "rtrn_chrgs_amt": 123,
  "sepa_trx_id": "<string>",
  "sequence_type": "FRST",
  "status_reason": "<string>",
  "t2": {
    "priority": "HIGH",
    "uetr": "a1b2c3d4-1111-4222-8333-000000000001"
  },
  "unaccounted_tax_amt": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

{
  "code": "<string>",
  "data": {
    "errors": [
      {
        "code": "<string>",
        "field_name": "<string>",
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "message": "<string>"
  },
  "message": "<string>"
}

Overview

This endpoint returns a SEPA Direct Debit transaction to the originator. Use this when you cannot process the debit due to account issues or customer disputes.

Common Return Scenarios

Insufficient funds
Account closed or blocked
No valid mandate
Customer dispute

Requirements

Transaction must be in a returnable state
Valid return reason code required
Return must occur within the allowed timeframe (see Timeframes below)

Timeframes & Reason Codes

This endpoint carries both returns and refunds - the reason code decides which, and each has its own deadline (Centrolink rejects anything outside the window):

Return - technical reasons such asAC04 orAM04, up to 5 business days after settlement.
Refund of an authorised collection -MD06 (customer dispute), up to 8 weeks after the debit date.
Refund of an unauthorised collection -MD01 (no valid mandate), up to 13 months after settlement.

Return Amounts and Charges

When a return or refund arrives on a collection you initiated, the returned settlement amount can exceed the original collection amount. Under the SDD scheme the debtor’s bank may claim, on top of the returned principal, a return/refund fee and interest compensation - in practice these appear chiefly on refunds of unauthorised collections (MD01) in the period from 8 weeks to 13 months. In the transaction data (GET /getTransaction) the breakdown is:

parent_trx_amt - the original collection amount
rtrn_chrgs_amt - the fee claimed by the debtor’s bank (pacs.004 ChrgsInf)
compensation_amt - interest compensation (pacs.004 CompstnAmt)

The return transaction’s own amount already includes the fee and compensation - do not add them on top when reconciling; the bank’s total claim equals the return amount minus parent_trx_amt. Both breakdown fields are null on ordinary returns, meaning no charge was applied - a return arrives as a complete message, so null never means “pending”. Webhook notifications carry only the total return amount; use the API to read the breakdown.

SEPA SDD Return Reasons

This document lists the supported SEPA Direct Debit (SDD) return reason codes that can be used when returning an SDD transaction, because the service /v1/transactions/:return is used not only for SDD payment returns.

Validation Rules

The reason field must be one of the supported values listed below.
Using an unsupported reason code (for example FOCR) will result in a VALIDATION_ERROR.

Supported Return Reason Codes

AC01 – Incorrect Account Number
AC04 – Closed Account Number
AC06 – Blocked Account

AG01 – Transaction Forbidden
AG02 – Invalid Bank Operation Code
RC01 – Bank Identifier Incorrect

AM04 – Insufficient Funds
AM05 – Duplication

Mandate / Authorization

MD01 – Unauthorized Transaction
MD06 – Disputed authorized transaction (Only for refunds)
MD07 – End Customer Deceased

Missing information

RR01 – Missing Debtor Account or Identification
RR02 – Missing Debtor Name or Address
RR03 – Missing Creditor Name or Address

Not specified reason

MS02 – Not Specified Reason Customer Generated
MS03 – Not Specified Reason Agent Generated

Regulatory / Other

RR04 – Regulatory Reason
SL01 – Specific Service offered by Debtor Agent
BE05 – Unrecognized Initiating Party

Example Error Response

{
  "status": 400,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Unable to return SDD transaction with id ... because it is of reason: FOCR.",
    "data": {
      "errors": [
        {
          "field_name": "reason",
          "value": "Supported values are [AC01, AC04, AC06, AG01, AG02, AM04, AM05, MD01, MD06, MD07, MS02, MS03, RC01, RR01, RR02, RR03, RR04, SL01, BE05]"
        }
      ]
    }
  }
}

Path Parameters

integer<int64>

required

Transaction ID.

Body

application/json

reason

enum<string> | null

required

Return reason. All payment methods; the accepted codes differ per method — see the operation description.

Available options:

AC01,

AC04,

AC06,

AG01,

AG02,

AM04,

AM05,

BE04,

BE05,

CNOR,

ERIN,

FF05,

FOCR,

MD01,

MD06,

MD07,

MS02,

MS03,

RC01,

RR01,

RR02,

RR03,

RR04,

SL01,

AM09,

BE01,

FRAD,

UPAY,

DUPL,

NARR,

RC03,

RC04,

INDM,

LEGL,

NOAS,

AGNT,

BE08,

CUST

additional_info

string

Free-text return reason, max 105 characters. For SWIFT and T2, mandatory when reason is NARR and optional otherwise. Ignored for SEPA payments.

Maximum string length: 105

compensation_amount

number

Compensation amount. SEPA Direct Debit only; ignored for other payment methods.

tax_amount

number

Tax amount. SEPA Direct Debit only; ignored for other payment methods.

Response

Returned transaction

cr_amount

integer

required

Payment amount in minor currency units

cr_ccy_isocode

string

required

SEPA payment currency code

created_at

string<date-time>

required

Time and date when transaction was created

dr_amount

integer

required

Payment amount in minor currency units

dr_ccy_isocode

string

required

SEPA payment currency code

integer<int64>

required

Transaction ID

metadata

string[]

required

Client-defined metadata values for linking the payment to internal records

status

string

required

Name of the status

status_hardvalue

string

required

Hard value of status

status_id

integer<int32>

required

Status id, all statuses can be retrived using API getTransactionStatuses

type

string

required

Type name

type_id

integer<int32>

required

Type id, all transaction types can be retrieved using API getTransactionTypes

adjustment_display_parties

object

Display-only parties for a resolved liquidity adjustment; the authoritative parties remain in inbound or outbound

Show child attributes

compensation_amt

integer

Payment compensation amount

inbound

object | null

Information about inbound transaction

Show child attributes

mandate_information

object

Provides further details of the direct debit mandate signed between the creditor and the debtor.

Show child attributes

origin_bic

string

Payment return originator bic

origin_name

string

Payment return originator name

origin_reason_code

string

Payment return originator reason code

origin_reason_info

string

Payment return originator reason information

outbound

object | null

Information about outbound transaction

Show child attributes

parent_trx_amt

integer

Original transaction amount

parent_trx_id

integer<int64>

Transaction id for parent transaction

rtrn_chrgs_amt

integer

Payment return tax amount

sepa_trx_id

string

Sepa transaction ID

sequence_type

enum<string>

Identifies the direct debit sequence, such as first, recurrent, final or one-off.

Available options:

FRST,

RCUR,

FNAL,

OOFF

status_reason

string

If there is some error, it is displayed in status reason or processing info tags

object | null

T2-specific fields, present only for T2 payments

Show child attributes

unaccounted_tax_amt

integer

Payment unaccounted tax amount

updated_at

string<date-time>

Time and date when transaction was last updated

Last modified on August 18, 2026

Getting Started

Integration Guide

Account Management

SEPA Instant/SCT

SEPA Direct Debit

SWIFT Payments

Payment Information

Investigations (Preview)

Nostro Accounts

Bank Information

Webhooks

Return SEPA Direct Debit transaction

Overview

Common Return Scenarios

Requirements

Timeframes & Reason Codes

Return Amounts and Charges

SEPA SDD Return Reasons

Validation Rules

Supported Return Reason Codes

Mandate / Authorization

Missing information

Not specified reason

Regulatory / Other

Example Error Response

Path Parameters

Body

Response

​Overview

​Common Return Scenarios

​Requirements

​Timeframes & Reason Codes

​Return Amounts and Charges

​SEPA SDD Return Reasons

​Validation Rules

​Supported Return Reason Codes

​Account-related

​Bank / Agent-related

​Amount-related

​Mandate / Authorization

​Missing information

​Not specified reason

​Regulatory / Other

​Example Error Response

Path Parameters

Body

Response

Overview

Common Return Scenarios

Requirements

Timeframes & Reason Codes

Return Amounts and Charges

SEPA SDD Return Reasons

Validation Rules

Supported Return Reason Codes

Account-related

Bank / Agent-related

Amount-related

Mandate / Authorization

Missing information

Not specified reason

Regulatory / Other

Example Error Response