Create a transfer
curl --request POST \
--url https://api-sandbox.orum.io/deliver/transfers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Orum-Version: <orum-version>' \
--data '
{
"transfer_reference_id": "<string>",
"amount": 2,
"currency": "USD",
"source": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"destination": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"account_statement_descriptor": "<string>",
"metadata": {},
"transfer_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subledger_reference_id": "<string>"
}
'import requests
url = "https://api-sandbox.orum.io/deliver/transfers"
payload = {
"transfer_reference_id": "<string>",
"amount": 2,
"currency": "USD",
"source": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"destination": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"account_statement_descriptor": "<string>",
"metadata": {},
"transfer_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subledger_reference_id": "<string>"
}
headers = {
"Orum-Version": "<orum-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Orum-Version': '<orum-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
transfer_reference_id: '<string>',
amount: 2,
currency: 'USD',
source: {
customer_reference_id: '<string>',
account_reference_id: '<string>',
statement_display_name: '<string>'
},
destination: {
customer_reference_id: '<string>',
account_reference_id: '<string>',
statement_display_name: '<string>'
},
account_statement_descriptor: '<string>',
metadata: {},
transfer_group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subledger_reference_id: '<string>'
})
};
fetch('https://api-sandbox.orum.io/deliver/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_URL => "https://api-sandbox.orum.io/deliver/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([
'transfer_reference_id' => '<string>',
'amount' => 2,
'currency' => 'USD',
'source' => [
'customer_reference_id' => '<string>',
'account_reference_id' => '<string>',
'statement_display_name' => '<string>'
],
'destination' => [
'customer_reference_id' => '<string>',
'account_reference_id' => '<string>',
'statement_display_name' => '<string>'
],
'account_statement_descriptor' => '<string>',
'metadata' => [
],
'transfer_group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subledger_reference_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Orum-Version: <orum-version>"
],
]);
$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-sandbox.orum.io/deliver/transfers"
payload := strings.NewReader("{\n \"transfer_reference_id\": \"<string>\",\n \"amount\": 2,\n \"currency\": \"USD\",\n \"source\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"destination\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"account_statement_descriptor\": \"<string>\",\n \"metadata\": {},\n \"transfer_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subledger_reference_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Orum-Version", "<orum-version>")
req.Header.Add("Authorization", "Bearer <token>")
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-sandbox.orum.io/deliver/transfers")
.header("Orum-Version", "<orum-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"transfer_reference_id\": \"<string>\",\n \"amount\": 2,\n \"currency\": \"USD\",\n \"source\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"destination\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"account_statement_descriptor\": \"<string>\",\n \"metadata\": {},\n \"transfer_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subledger_reference_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.orum.io/deliver/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transfer_reference_id\": \"<string>\",\n \"amount\": 2,\n \"currency\": \"USD\",\n \"source\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"destination\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"account_statement_descriptor\": \"<string>\",\n \"metadata\": {},\n \"transfer_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subledger_reference_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transfer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transfer_reference_id": "<string>",
"amount": 2,
"currency": "USD",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"source": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>",
"trace_number": "<string>",
"return_trace_number": "<string>"
},
"destination": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>",
"trace_number": "<string>",
"return_trace_number": "<string>"
},
"status_reasons": [
{
"source": {
"reason_code": "insufficient_funds",
"reason_code_message": "<string>",
"network_reason_code": "<string>",
"network_reason_code_message": "<string>",
"network_reason_code_rail_type": "<string>"
},
"destination": {
"reason_code": "insufficient_funds",
"reason_code_message": "<string>",
"network_reason_code": "<string>",
"network_reason_code_message": "<string>",
"network_reason_code_rail_type": "<string>"
}
}
],
"account_statement_descriptor": "<string>",
"estimated_funds_delivery_date": "2023-11-07T05:31:56Z",
"metadata": {},
"transfer_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subledger_reference_id": "<string>"
}
}{
"error_code": "<string>",
"message": "<string>",
"details": {}
}{
"error_code": "<string>",
"message": "<string>",
"details": {}
}Transfers
Create Transfer
Initiate a transfer between a source party and destination party.
POST
/
deliver
/
transfers
Create a transfer
curl --request POST \
--url https://api-sandbox.orum.io/deliver/transfers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Orum-Version: <orum-version>' \
--data '
{
"transfer_reference_id": "<string>",
"amount": 2,
"currency": "USD",
"source": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"destination": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"account_statement_descriptor": "<string>",
"metadata": {},
"transfer_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subledger_reference_id": "<string>"
}
'import requests
url = "https://api-sandbox.orum.io/deliver/transfers"
payload = {
"transfer_reference_id": "<string>",
"amount": 2,
"currency": "USD",
"source": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"destination": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>"
},
"account_statement_descriptor": "<string>",
"metadata": {},
"transfer_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subledger_reference_id": "<string>"
}
headers = {
"Orum-Version": "<orum-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Orum-Version': '<orum-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
transfer_reference_id: '<string>',
amount: 2,
currency: 'USD',
source: {
customer_reference_id: '<string>',
account_reference_id: '<string>',
statement_display_name: '<string>'
},
destination: {
customer_reference_id: '<string>',
account_reference_id: '<string>',
statement_display_name: '<string>'
},
account_statement_descriptor: '<string>',
metadata: {},
transfer_group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subledger_reference_id: '<string>'
})
};
fetch('https://api-sandbox.orum.io/deliver/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_URL => "https://api-sandbox.orum.io/deliver/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([
'transfer_reference_id' => '<string>',
'amount' => 2,
'currency' => 'USD',
'source' => [
'customer_reference_id' => '<string>',
'account_reference_id' => '<string>',
'statement_display_name' => '<string>'
],
'destination' => [
'customer_reference_id' => '<string>',
'account_reference_id' => '<string>',
'statement_display_name' => '<string>'
],
'account_statement_descriptor' => '<string>',
'metadata' => [
],
'transfer_group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subledger_reference_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Orum-Version: <orum-version>"
],
]);
$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-sandbox.orum.io/deliver/transfers"
payload := strings.NewReader("{\n \"transfer_reference_id\": \"<string>\",\n \"amount\": 2,\n \"currency\": \"USD\",\n \"source\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"destination\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"account_statement_descriptor\": \"<string>\",\n \"metadata\": {},\n \"transfer_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subledger_reference_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Orum-Version", "<orum-version>")
req.Header.Add("Authorization", "Bearer <token>")
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-sandbox.orum.io/deliver/transfers")
.header("Orum-Version", "<orum-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"transfer_reference_id\": \"<string>\",\n \"amount\": 2,\n \"currency\": \"USD\",\n \"source\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"destination\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"account_statement_descriptor\": \"<string>\",\n \"metadata\": {},\n \"transfer_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subledger_reference_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.orum.io/deliver/transfers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transfer_reference_id\": \"<string>\",\n \"amount\": 2,\n \"currency\": \"USD\",\n \"source\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"destination\": {\n \"customer_reference_id\": \"<string>\",\n \"account_reference_id\": \"<string>\",\n \"statement_display_name\": \"<string>\"\n },\n \"account_statement_descriptor\": \"<string>\",\n \"metadata\": {},\n \"transfer_group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subledger_reference_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"transfer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transfer_reference_id": "<string>",
"amount": 2,
"currency": "USD",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"source": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>",
"trace_number": "<string>",
"return_trace_number": "<string>"
},
"destination": {
"customer_reference_id": "<string>",
"account_reference_id": "<string>",
"statement_display_name": "<string>",
"trace_number": "<string>",
"return_trace_number": "<string>"
},
"status_reasons": [
{
"source": {
"reason_code": "insufficient_funds",
"reason_code_message": "<string>",
"network_reason_code": "<string>",
"network_reason_code_message": "<string>",
"network_reason_code_rail_type": "<string>"
},
"destination": {
"reason_code": "insufficient_funds",
"reason_code_message": "<string>",
"network_reason_code": "<string>",
"network_reason_code_message": "<string>",
"network_reason_code_rail_type": "<string>"
}
}
],
"account_statement_descriptor": "<string>",
"estimated_funds_delivery_date": "2023-11-07T05:31:56Z",
"metadata": {},
"transfer_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subledger_reference_id": "<string>"
}
}{
"error_code": "<string>",
"message": "<string>",
"details": {}
}{
"error_code": "<string>",
"message": "<string>",
"details": {}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version of Deliver and Verify APIs. Use v2022-09-21.
Available options:
v2022-09-21 Body
application/json
Unique reference id for the transfer. Generated by you.
Minimum string length:
1Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
Required range:
x >= 1Currency code in ISO 4217 format. Only USD is supported.
Available options:
USD Speed of transfer.
Available options:
asap, standard, same_day, wire For use cases that require a Source, information about the transfer funding source, which will be debited.
Show child attributes
Show child attributes
Information about the transfer funds destination, which will be credited.
Show child attributes
Show child attributes
Banks can display additional information to help the end user understand why they received funds. This information will appear on both the source and destination bank account statements. The field supports 10 alphanumeric characters for ACH and 140 for RTP.
Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key and 50 characters for the value. Do not include any sensitive information.
Orum generated unique id for the resource.
Unique reference id for the subledger resource. Generated by you.
Required string length:
1 - 255Response
200 response.
Show child attributes
Show child attributes
Was this page helpful?
⌘I