Transfer Groups
Get Transfer Group By ID
Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- Cards
- Transfers
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Transfer Groups
Get Transfer Group By ID
Get a Transfer Group object by ID
GET
/
deliver
/
transfer-groups
/
{id}
curl --request GET \
--url https://api-sandbox.orum.io/deliver/transfer-groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'
{
"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
The auth token received from Authentication endpoints.
Headers
Version of Deliver API. Use v2022-09-21.
Available options:
v2022-09-21
Path Parameters
Transfer Group ID
Response
200
application/json
successful response.
Orum generated unique id for the resource.
Timestamp when the resource was created.
Timestamp when the resource was last updated.
Unique reference id for the transfer group
Minimum length:
1
Information about the ultimate source of the transfer group.
Information about the ultimate destination of the transfer group.
Was this page helpful?
curl --request GET \
--url https://api-sandbox.orum.io/deliver/transfer-groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Orum-Version: <orum-version>'
{
"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>"
}
}
}