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>"
  }
}
'
{
  "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>"
    }
  }
}

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

Information about the ultimate source of the transfer group.

​
destination
Destination · object

Information about the ultimate destination of the transfer group.

Response

successful response.

​
transfer_group
TransferGroup · object
required