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",
  "speed": "asap",
  "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>"
}'
{
  "transfer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transfer_reference_id": "<string>",
    "amount": 2,
    "currency": "USD",
    "speed": "asap",
    "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": "completed",
    "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",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "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>"
  }
}

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_reference_id
string
required

Unique reference id for the transfer. Generated by you.

Minimum length: 1
​
amount
integer
required

Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.

Required range: x >= 1
​
currency
enum<string>
required

Currency code in ISO 4217 format. Only USD is supported.

Available options:
USD
​
speed
enum<string>
required

Speed of transfer.

Available options:
asap,
standard,
same_day,
wire
​
source
object

For use cases that require a Source, information about the transfer funding source, which will be debited.

​
destination
object

Information about the transfer funds destination, which will be credited.

​
account_statement_descriptor
string | null

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.

​
metadata
object

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.

​
transfer_group_id
string<uuid>

Orum generated unique id for the resource.

​
subledger_reference_id
string

Unique reference id for the subledger resource. Generated by you.

Required string length: 1 - 255

Response

200 response.

​
transfer
object
required