Get Transfer By ID

GET

deliver

transfers

{id}

curl --request GET \
  --url https://api-sandbox.orum.io/deliver/transfers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

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

Authorizations

Authorization

string

header

required

The auth token received from Authentication endpoints.

Headers

Orum-Version

enum<string>

required

Version of Deliver API. Use v2022-09-21.

Available options:

v2022-09-21

Path Parameters

string

required

Orum generated unique id for the transfer you are fetching.

Response

200

application/json

200 response.

transfer

object

required

transfer.id

string

required

Orum generated unique id for the resource.

transfer.transfer_reference_id

string

required

Unique reference id for the transfer. Generated by you.

Minimum length: 1

transfer.amount

integer

required

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

Required range: x >= 1

transfer.currency

enum<string>

required

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

Available options:

USD

transfer.speed

enum<string>

required

Speed of transfer.

Available options:

asap,

standard,

same_day,

wire

transfer.status

enum<string>

required

Describes the current status of the transfer.

Available options:

completed,

created,

failed,

pending,

settled

transfer.created_at

string

required

Timestamp when the resource was created.

transfer.updated_at

string

required

Timestamp when the resource was last updated.

transfer.source

object

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

transfer.destination

object

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

transfer.status_reasons

object[]

Array that explains why the transfer failed.

For failed transfers - details on why the transfer is in a failed state.

transfer.account_statement_descriptor

string

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.

transfer.estimated_funds_delivery_date

string

Estimated date that funds will arrive in destination account. Time will always be midnight and should be ignored.

transfer.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.transfer_group_id

string

Orum generated unique id for the resource.

Was this page helpful?

Get All Transfers Update Transfer Metadata By ID

curl --request GET \
  --url https://api-sandbox.orum.io/deliver/transfers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'

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

Auth API

Deliver API

Verify API

Webhooks API

Authorizations

Headers

Path Parameters

Response