Skip to main content
POST
/
deliver
/
transfer-groups
Create a Transfer Group
curl --request POST \
  --url https://api-sandbox.orum.io/deliver/transfer-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '
{
  "transfer_group_reference_id": "<string>",
  "source": {
    "account_reference_id": "<string>",
    "customer_reference_id": "<string>"
  },
  "destination": {
    "account_reference_id": "<string>",
    "customer_reference_id": "<string>"
  }
}
'
import requests

url = "https://api-sandbox.orum.io/deliver/transfer-groups"

payload = {
"transfer_group_reference_id": "<string>",
"source": {
"account_reference_id": "<string>",
"customer_reference_id": "<string>"
},
"destination": {
"account_reference_id": "<string>",
"customer_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_group_reference_id: '<string>',
source: {account_reference_id: '<string>', customer_reference_id: '<string>'},
destination: {account_reference_id: '<string>', customer_reference_id: '<string>'}
})
};

fetch('https://api-sandbox.orum.io/deliver/transfer-groups', 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/transfer-groups",
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_group_reference_id' => '<string>',
'source' => [
'account_reference_id' => '<string>',
'customer_reference_id' => '<string>'
],
'destination' => [
'account_reference_id' => '<string>',
'customer_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/transfer-groups"

payload := strings.NewReader("{\n \"transfer_group_reference_id\": \"<string>\",\n \"source\": {\n \"account_reference_id\": \"<string>\",\n \"customer_reference_id\": \"<string>\"\n },\n \"destination\": {\n \"account_reference_id\": \"<string>\",\n \"customer_reference_id\": \"<string>\"\n }\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/transfer-groups")
.header("Orum-Version", "<orum-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"transfer_group_reference_id\": \"<string>\",\n \"source\": {\n \"account_reference_id\": \"<string>\",\n \"customer_reference_id\": \"<string>\"\n },\n \"destination\": {\n \"account_reference_id\": \"<string>\",\n \"customer_reference_id\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.orum.io/deliver/transfer-groups")

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_group_reference_id\": \"<string>\",\n \"source\": {\n \"account_reference_id\": \"<string>\",\n \"customer_reference_id\": \"<string>\"\n },\n \"destination\": {\n \"account_reference_id\": \"<string>\",\n \"customer_reference_id\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "transfer_group": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "transfer_group_reference_id": "<string>",
    "source": {
      "account_reference_id": "<string>",
      "customer_reference_id": "<string>"
    },
    "destination": {
      "account_reference_id": "<string>",
      "customer_reference_id": "<string>"
    }
  }
}
{
"error_code": "<string>",
"message": "<string>",
"details": {}
}
{
"error_code": "<string>",
"message": "<string>",
"details": {}
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Body

application/json
transfer_group_reference_id
string
required

Unique reference id for the transfer group

Minimum string length: 1
source
Source · object | null

Information about the ultimate source of the transfer group.

destination
Destination · object | null

Information about the ultimate destination of the transfer group.

Response

successful response.

transfer_group
TransferGroup · object
required