Create New Transfer Transaction
curl --request POST \
--url http://localhost:8080/api/v1/transfers \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cr_bank_bic": "<string>",
"cr_iban": "<string>",
"cr_name": "<string>",
"credit_amount": "1000.00",
"debit_amount": "1000.00",
"dr_bank_bic": "<string>",
"dr_iban": "<string>",
"dr_name": "<string>",
"purpose": "<string>",
"settlement_date": "2023-12-25",
"unique_reference": "<string>",
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category_purpose_code": "<string>",
"cr_address": "<string>",
"cr_bank_name": "<string>",
"cr_city": "<string>",
"cr_country_code": "<string>",
"cr_postal_code": "<string>",
"credit_currency": "<string>",
"debit_currency": "<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",
"is_instant": true,
"parent_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose_code": "<string>",
"structured_reference": "<string>",
"structured_reference_issuer": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/transfers"
payload = {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cr_bank_bic": "<string>",
"cr_iban": "<string>",
"cr_name": "<string>",
"credit_amount": "1000.00",
"debit_amount": "1000.00",
"dr_bank_bic": "<string>",
"dr_iban": "<string>",
"dr_name": "<string>",
"purpose": "<string>",
"settlement_date": "2023-12-25",
"unique_reference": "<string>",
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category_purpose_code": "<string>",
"cr_address": "<string>",
"cr_bank_name": "<string>",
"cr_city": "<string>",
"cr_country_code": "<string>",
"cr_postal_code": "<string>",
"credit_currency": "<string>",
"debit_currency": "<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",
"is_instant": True,
"parent_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose_code": "<string>",
"structured_reference": "<string>",
"structured_reference_issuer": "<string>"
}
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({
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
cr_bank_bic: '<string>',
cr_iban: '<string>',
cr_name: '<string>',
credit_amount: '1000.00',
debit_amount: '1000.00',
dr_bank_bic: '<string>',
dr_iban: '<string>',
dr_name: '<string>',
purpose: '<string>',
settlement_date: '2023-12-25',
unique_reference: '<string>',
beneficiary_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
category_purpose_code: '<string>',
cr_address: '<string>',
cr_bank_name: '<string>',
cr_city: '<string>',
cr_country_code: '<string>',
cr_postal_code: '<string>',
credit_currency: '<string>',
debit_currency: '<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',
is_instant: true,
parent_transaction_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
purpose_code: '<string>',
structured_reference: '<string>',
structured_reference_issuer: '<string>'
})
};
fetch('http://localhost:8080/api/v1/transfers', 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",
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([
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'cr_bank_bic' => '<string>',
'cr_iban' => '<string>',
'cr_name' => '<string>',
'credit_amount' => '1000.00',
'debit_amount' => '1000.00',
'dr_bank_bic' => '<string>',
'dr_iban' => '<string>',
'dr_name' => '<string>',
'purpose' => '<string>',
'settlement_date' => '2023-12-25',
'unique_reference' => '<string>',
'beneficiary_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'category_purpose_code' => '<string>',
'cr_address' => '<string>',
'cr_bank_name' => '<string>',
'cr_city' => '<string>',
'cr_country_code' => '<string>',
'cr_postal_code' => '<string>',
'credit_currency' => '<string>',
'debit_currency' => '<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',
'is_instant' => true,
'parent_transaction_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'purpose_code' => '<string>',
'structured_reference' => '<string>',
'structured_reference_issuer' => '<string>'
]),
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 := "http://localhost:8080/api/v1/transfers"
payload := strings.NewReader("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cr_bank_bic\": \"<string>\",\n \"cr_iban\": \"<string>\",\n \"cr_name\": \"<string>\",\n \"credit_amount\": \"1000.00\",\n \"debit_amount\": \"1000.00\",\n \"dr_bank_bic\": \"<string>\",\n \"dr_iban\": \"<string>\",\n \"dr_name\": \"<string>\",\n \"purpose\": \"<string>\",\n \"settlement_date\": \"2023-12-25\",\n \"unique_reference\": \"<string>\",\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"category_purpose_code\": \"<string>\",\n \"cr_address\": \"<string>\",\n \"cr_bank_name\": \"<string>\",\n \"cr_city\": \"<string>\",\n \"cr_country_code\": \"<string>\",\n \"cr_postal_code\": \"<string>\",\n \"credit_currency\": \"<string>\",\n \"debit_currency\": \"<string>\",\n \"dr_address\": \"<string>\",\n \"dr_bank_name\": \"<string>\",\n \"dr_city\": \"<string>\",\n \"dr_country_code\": \"<string>\",\n \"dr_postal_code\": \"<string>\",\n \"exchange_rate\": \"1.085600\",\n \"fx_fee_amount\": \"5.00\",\n \"is_instant\": true,\n \"parent_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purpose_code\": \"<string>\",\n \"structured_reference\": \"<string>\",\n \"structured_reference_issuer\": \"<string>\"\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("http://localhost:8080/api/v1/transfers")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cr_bank_bic\": \"<string>\",\n \"cr_iban\": \"<string>\",\n \"cr_name\": \"<string>\",\n \"credit_amount\": \"1000.00\",\n \"debit_amount\": \"1000.00\",\n \"dr_bank_bic\": \"<string>\",\n \"dr_iban\": \"<string>\",\n \"dr_name\": \"<string>\",\n \"purpose\": \"<string>\",\n \"settlement_date\": \"2023-12-25\",\n \"unique_reference\": \"<string>\",\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"category_purpose_code\": \"<string>\",\n \"cr_address\": \"<string>\",\n \"cr_bank_name\": \"<string>\",\n \"cr_city\": \"<string>\",\n \"cr_country_code\": \"<string>\",\n \"cr_postal_code\": \"<string>\",\n \"credit_currency\": \"<string>\",\n \"debit_currency\": \"<string>\",\n \"dr_address\": \"<string>\",\n \"dr_bank_name\": \"<string>\",\n \"dr_city\": \"<string>\",\n \"dr_country_code\": \"<string>\",\n \"dr_postal_code\": \"<string>\",\n \"exchange_rate\": \"1.085600\",\n \"fx_fee_amount\": \"5.00\",\n \"is_instant\": true,\n \"parent_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purpose_code\": \"<string>\",\n \"structured_reference\": \"<string>\",\n \"structured_reference_issuer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/transfers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cr_bank_bic\": \"<string>\",\n \"cr_iban\": \"<string>\",\n \"cr_name\": \"<string>\",\n \"credit_amount\": \"1000.00\",\n \"debit_amount\": \"1000.00\",\n \"dr_bank_bic\": \"<string>\",\n \"dr_iban\": \"<string>\",\n \"dr_name\": \"<string>\",\n \"purpose\": \"<string>\",\n \"settlement_date\": \"2023-12-25\",\n \"unique_reference\": \"<string>\",\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"category_purpose_code\": \"<string>\",\n \"cr_address\": \"<string>\",\n \"cr_bank_name\": \"<string>\",\n \"cr_city\": \"<string>\",\n \"cr_country_code\": \"<string>\",\n \"cr_postal_code\": \"<string>\",\n \"credit_currency\": \"<string>\",\n \"debit_currency\": \"<string>\",\n \"dr_address\": \"<string>\",\n \"dr_bank_name\": \"<string>\",\n \"dr_city\": \"<string>\",\n \"dr_country_code\": \"<string>\",\n \"dr_postal_code\": \"<string>\",\n \"exchange_rate\": \"1.085600\",\n \"fx_fee_amount\": \"5.00\",\n \"is_instant\": true,\n \"parent_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purpose_code\": \"<string>\",\n \"structured_reference\": \"<string>\",\n \"structured_reference_issuer\": \"<string>\"\n}"
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
Create New Transfer Transaction
Create a transfer (SEPA, INST, SWIFT, INTERNAL, DOMESTIC, SDD, or CARD). The account must be ACTIVE, outbound transfers require a valid beneficiary, and unique_reference must be globally unique (idempotency key). Starts in CREATED.
POST
/
api
/
v1
/
transfers
Create New Transfer Transaction
curl --request POST \
--url http://localhost:8080/api/v1/transfers \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cr_bank_bic": "<string>",
"cr_iban": "<string>",
"cr_name": "<string>",
"credit_amount": "1000.00",
"debit_amount": "1000.00",
"dr_bank_bic": "<string>",
"dr_iban": "<string>",
"dr_name": "<string>",
"purpose": "<string>",
"settlement_date": "2023-12-25",
"unique_reference": "<string>",
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category_purpose_code": "<string>",
"cr_address": "<string>",
"cr_bank_name": "<string>",
"cr_city": "<string>",
"cr_country_code": "<string>",
"cr_postal_code": "<string>",
"credit_currency": "<string>",
"debit_currency": "<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",
"is_instant": true,
"parent_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose_code": "<string>",
"structured_reference": "<string>",
"structured_reference_issuer": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/transfers"
payload = {
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cr_bank_bic": "<string>",
"cr_iban": "<string>",
"cr_name": "<string>",
"credit_amount": "1000.00",
"debit_amount": "1000.00",
"dr_bank_bic": "<string>",
"dr_iban": "<string>",
"dr_name": "<string>",
"purpose": "<string>",
"settlement_date": "2023-12-25",
"unique_reference": "<string>",
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category_purpose_code": "<string>",
"cr_address": "<string>",
"cr_bank_name": "<string>",
"cr_city": "<string>",
"cr_country_code": "<string>",
"cr_postal_code": "<string>",
"credit_currency": "<string>",
"debit_currency": "<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",
"is_instant": True,
"parent_transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose_code": "<string>",
"structured_reference": "<string>",
"structured_reference_issuer": "<string>"
}
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({
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
cr_bank_bic: '<string>',
cr_iban: '<string>',
cr_name: '<string>',
credit_amount: '1000.00',
debit_amount: '1000.00',
dr_bank_bic: '<string>',
dr_iban: '<string>',
dr_name: '<string>',
purpose: '<string>',
settlement_date: '2023-12-25',
unique_reference: '<string>',
beneficiary_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
category_purpose_code: '<string>',
cr_address: '<string>',
cr_bank_name: '<string>',
cr_city: '<string>',
cr_country_code: '<string>',
cr_postal_code: '<string>',
credit_currency: '<string>',
debit_currency: '<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',
is_instant: true,
parent_transaction_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
purpose_code: '<string>',
structured_reference: '<string>',
structured_reference_issuer: '<string>'
})
};
fetch('http://localhost:8080/api/v1/transfers', 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",
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([
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'cr_bank_bic' => '<string>',
'cr_iban' => '<string>',
'cr_name' => '<string>',
'credit_amount' => '1000.00',
'debit_amount' => '1000.00',
'dr_bank_bic' => '<string>',
'dr_iban' => '<string>',
'dr_name' => '<string>',
'purpose' => '<string>',
'settlement_date' => '2023-12-25',
'unique_reference' => '<string>',
'beneficiary_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'category_purpose_code' => '<string>',
'cr_address' => '<string>',
'cr_bank_name' => '<string>',
'cr_city' => '<string>',
'cr_country_code' => '<string>',
'cr_postal_code' => '<string>',
'credit_currency' => '<string>',
'debit_currency' => '<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',
'is_instant' => true,
'parent_transaction_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'purpose_code' => '<string>',
'structured_reference' => '<string>',
'structured_reference_issuer' => '<string>'
]),
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 := "http://localhost:8080/api/v1/transfers"
payload := strings.NewReader("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cr_bank_bic\": \"<string>\",\n \"cr_iban\": \"<string>\",\n \"cr_name\": \"<string>\",\n \"credit_amount\": \"1000.00\",\n \"debit_amount\": \"1000.00\",\n \"dr_bank_bic\": \"<string>\",\n \"dr_iban\": \"<string>\",\n \"dr_name\": \"<string>\",\n \"purpose\": \"<string>\",\n \"settlement_date\": \"2023-12-25\",\n \"unique_reference\": \"<string>\",\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"category_purpose_code\": \"<string>\",\n \"cr_address\": \"<string>\",\n \"cr_bank_name\": \"<string>\",\n \"cr_city\": \"<string>\",\n \"cr_country_code\": \"<string>\",\n \"cr_postal_code\": \"<string>\",\n \"credit_currency\": \"<string>\",\n \"debit_currency\": \"<string>\",\n \"dr_address\": \"<string>\",\n \"dr_bank_name\": \"<string>\",\n \"dr_city\": \"<string>\",\n \"dr_country_code\": \"<string>\",\n \"dr_postal_code\": \"<string>\",\n \"exchange_rate\": \"1.085600\",\n \"fx_fee_amount\": \"5.00\",\n \"is_instant\": true,\n \"parent_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purpose_code\": \"<string>\",\n \"structured_reference\": \"<string>\",\n \"structured_reference_issuer\": \"<string>\"\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("http://localhost:8080/api/v1/transfers")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cr_bank_bic\": \"<string>\",\n \"cr_iban\": \"<string>\",\n \"cr_name\": \"<string>\",\n \"credit_amount\": \"1000.00\",\n \"debit_amount\": \"1000.00\",\n \"dr_bank_bic\": \"<string>\",\n \"dr_iban\": \"<string>\",\n \"dr_name\": \"<string>\",\n \"purpose\": \"<string>\",\n \"settlement_date\": \"2023-12-25\",\n \"unique_reference\": \"<string>\",\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"category_purpose_code\": \"<string>\",\n \"cr_address\": \"<string>\",\n \"cr_bank_name\": \"<string>\",\n \"cr_city\": \"<string>\",\n \"cr_country_code\": \"<string>\",\n \"cr_postal_code\": \"<string>\",\n \"credit_currency\": \"<string>\",\n \"debit_currency\": \"<string>\",\n \"dr_address\": \"<string>\",\n \"dr_bank_name\": \"<string>\",\n \"dr_city\": \"<string>\",\n \"dr_country_code\": \"<string>\",\n \"dr_postal_code\": \"<string>\",\n \"exchange_rate\": \"1.085600\",\n \"fx_fee_amount\": \"5.00\",\n \"is_instant\": true,\n \"parent_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purpose_code\": \"<string>\",\n \"structured_reference\": \"<string>\",\n \"structured_reference_issuer\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/transfers")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cr_bank_bic\": \"<string>\",\n \"cr_iban\": \"<string>\",\n \"cr_name\": \"<string>\",\n \"credit_amount\": \"1000.00\",\n \"debit_amount\": \"1000.00\",\n \"dr_bank_bic\": \"<string>\",\n \"dr_iban\": \"<string>\",\n \"dr_name\": \"<string>\",\n \"purpose\": \"<string>\",\n \"settlement_date\": \"2023-12-25\",\n \"unique_reference\": \"<string>\",\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"category_purpose_code\": \"<string>\",\n \"cr_address\": \"<string>\",\n \"cr_bank_name\": \"<string>\",\n \"cr_city\": \"<string>\",\n \"cr_country_code\": \"<string>\",\n \"cr_postal_code\": \"<string>\",\n \"credit_currency\": \"<string>\",\n \"debit_currency\": \"<string>\",\n \"dr_address\": \"<string>\",\n \"dr_bank_name\": \"<string>\",\n \"dr_city\": \"<string>\",\n \"dr_country_code\": \"<string>\",\n \"dr_postal_code\": \"<string>\",\n \"exchange_rate\": \"1.085600\",\n \"fx_fee_amount\": \"5.00\",\n \"is_instant\": true,\n \"parent_transaction_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"purpose_code\": \"<string>\",\n \"structured_reference\": \"<string>\",\n \"structured_reference_issuer\": \"<string>\"\n}"
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>"
}Body
application/json
Request to create a new transfer transaction
Account UUID initiating the transfer
Credit amount
Example:
"1000.00"
Debit amount
Example:
"1000.00"
Transfer direction
Available options:
INBOUND, OUTBOUND Transfer method/rail
Available options:
SEPA, INTERNAL, SDD, SDD_INTERNAL, INST, CARD, SWIFT, DOMESTIC Settlement date (YYYY-MM-DD)
Transfer type
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 Unique reference for idempotency
Beneficiary UUID (required for outbound transfers)
ISO 3166-1 alpha-3 country code
Credit currency (ISO 4217)
Debit currency (ISO 4217)
ISO 3166-1 alpha-3 country code
Exchange rate (if currency conversion)
Example:
"1.085600"
FX fee amount
Example:
"5.00"
Is this an instant transfer
Parent transaction ID (for related transactions)
Response
Transfer created 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"