Cancel Transfer Transaction
curl --request POST \
--url http://localhost:8080/api/v1/transfers/{transfer_id}/cancelimport requests
url = "http://localhost:8080/api/v1/transfers/{transfer_id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('http://localhost:8080/api/v1/transfers/{transfer_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/transfers/{transfer_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/transfers/{transfer_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/transfers/{transfer_id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/transfers/{transfer_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cr_bank_bic": "<string>",
"cr_iban": "<string>",
"cr_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"credit_amount": "1000.00",
"credit_currency": "<string>",
"debit_amount": "1000.00",
"debit_currency": "<string>",
"direction": "INBOUND",
"dr_bank_bic": "<string>",
"dr_iban": "<string>",
"dr_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_instant": true,
"method": "SEPA",
"purpose": "<string>",
"settlement_date": "2023-12-25",
"status": "CREATED",
"transfer_type": "FEE",
"unique_reference": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"bank_partner_id": "<string>",
"bank_partner_trx_id": 123,
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category_purpose_code": "<string>",
"cr_account_id": "<string>",
"cr_address": "<string>",
"cr_bank_name": "<string>",
"cr_city": "<string>",
"cr_country_code": "<string>",
"cr_postal_code": "<string>",
"dr_account_id": "<string>",
"dr_address": "<string>",
"dr_bank_name": "<string>",
"dr_city": "<string>",
"dr_country_code": "<string>",
"dr_postal_code": "<string>",
"exchange_rate": "1.085600",
"fx_fee_amount": "5.00",
"parent_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose_code": "<string>",
"signed_at": "2023-11-07T05:31:56Z",
"status_reason": "<string>",
"status_reason_code": "<string>",
"structured_reference": "<string>",
"structured_reference_issuer": "<string>",
"third_party_status": "<string>",
"third_party_status_code": "<string>",
"third_party_status_reason": "<string>"
}Transfers
Cancel Transfer Transaction
Cancel a transfer that is still cancellable (CREATED, TO_SIGN, SIGNED, RESERVED, or ON_HOLD). Transfers already processing or completed cannot be cancelled.
POST
/
api
/
v1
/
transfers
/
{transfer_id}
/
cancel
Cancel Transfer Transaction
curl --request POST \
--url http://localhost:8080/api/v1/transfers/{transfer_id}/cancelimport requests
url = "http://localhost:8080/api/v1/transfers/{transfer_id}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('http://localhost:8080/api/v1/transfers/{transfer_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/transfers/{transfer_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/transfers/{transfer_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v1/transfers/{transfer_id}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/transfers/{transfer_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cr_bank_bic": "<string>",
"cr_iban": "<string>",
"cr_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"credit_amount": "1000.00",
"credit_currency": "<string>",
"debit_amount": "1000.00",
"debit_currency": "<string>",
"direction": "INBOUND",
"dr_bank_bic": "<string>",
"dr_iban": "<string>",
"dr_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_instant": true,
"method": "SEPA",
"purpose": "<string>",
"settlement_date": "2023-12-25",
"status": "CREATED",
"transfer_type": "FEE",
"unique_reference": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"bank_partner_id": "<string>",
"bank_partner_trx_id": 123,
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category_purpose_code": "<string>",
"cr_account_id": "<string>",
"cr_address": "<string>",
"cr_bank_name": "<string>",
"cr_city": "<string>",
"cr_country_code": "<string>",
"cr_postal_code": "<string>",
"dr_account_id": "<string>",
"dr_address": "<string>",
"dr_bank_name": "<string>",
"dr_city": "<string>",
"dr_country_code": "<string>",
"dr_postal_code": "<string>",
"exchange_rate": "1.085600",
"fx_fee_amount": "5.00",
"parent_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose_code": "<string>",
"signed_at": "2023-11-07T05:31:56Z",
"status_reason": "<string>",
"status_reason_code": "<string>",
"structured_reference": "<string>",
"structured_reference_issuer": "<string>",
"third_party_status": "<string>",
"third_party_status_code": "<string>",
"third_party_status_reason": "<string>"
}Path Parameters
Transfer UUID
Response
Transfer cancelled successfully
Transfer Transaction - Represents a bank transfer (SEPA, SWIFT, Domestic, etc.)
Example:
"1000.00"
Example:
"1000.00"
Transfer Direction - Indicates if money is coming in or going out
Available options:
INBOUND, OUTBOUND Transfer Method - The payment method/rail used
Available options:
SEPA, INTERNAL, SDD, SDD_INTERNAL, INST, CARD, SWIFT, DOMESTIC Transfer Status - Current status of the transfer transaction
Available options:
CREATED, SIGNED, REVIEW, READY_TO_CLEAR, SENT_TO_PACK, PACKED, SENT_TO_CLEAR, COMPLETED, SOME_PROBLEMS, CANCELLED, REJECTED, INVALID, ACCEPTED, TO_SIGN, RESERVED, TO_RESERVE, RECEIVED, DROPPED, ON_HOLD, READY_FOR_SCREENING, AML_APPROVED, AML_REJECTED, MANUAL_ACTION, CREDIT_TECH_BALANCE, TO_RESEND, MANUAL_REJECTED, TO_CANCEL, BLACKLIST_SCANNING, AML_SCANNING, TO_RETURN Transfer Type - The type/nature of the transfer
Available options:
FEE, PAYMENT, PAYMENT_CANCELLATION, PAYMENT_RETURN, FEE_CANCELLATION, CCY_EXCHANGE, ADJUSTMENT, PAYMENT_TECHNICAL_REVERSAL, PAYMENT_REVERSAL, CARD_AUTH, CARD_ADVICE, CARD_REVERSAL, FX_POSITION_CLOSING, CARD_CLEARING Example:
"1.085600"
Example:
"5.00"