Get Transfer By ID

Get a transfer 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",
    "status": "completed",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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_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",
    "metadata": {},
    "transfer_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subledger_reference_id": "<string>"
  }
}

GET

deliver

transfers

{id}

Get a transfer 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",
    "status": "completed",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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_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",
    "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

Path Parameters

string<uuid>

required

Orum generated unique id for the transfer you are fetching. Orum generated unique id for the resource.

Response

200 response.

transfer

TransferResponseBaseObject · object

required

Show child attributes

transfer.id

string<uuid>

required

Orum generated unique id for the resource.

transfer.transfer_reference_id

string

required

Unique reference id for the transfer. Generated by you.

Minimum string 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<date-time>

required

Timestamp when the resource was created.

transfer.updated_at

string<date-time>

required

Timestamp when the resource was last updated.

transfer.source

SourceTransferPartyResponse · object

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

Show child attributes

transfer.source.customer_reference_id

string

required

Unique reference ID for the customer (person or business) associated with the external account being debited.

transfer.source.account_reference_id

string

required

Unique reference ID for the external account being debited.

transfer.source.statement_display_name

string

The name that will appear on the bank account statement of the account being debited. The field supports 16 alphanumeric characters for ACH, and 140 for RTP.

transfer.source.trace_number

string

Unique tracking number of the payment assigned by its origination FI. This number can be used to track the lifecycle of the payment at the FI.

transfer.source.return_trace_number

string

Unique tracking number assigned to a return to associate it back with its original trace number for reconciliation.

transfer.destination

DestinationTransferPartyResponse · object

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

Show child attributes

transfer.destination.customer_reference_id

string

required

Unique reference ID for the customer (person or business) associated with the external account being credited.

transfer.destination.account_reference_id

string

required

Unique reference ID for the account being credited.

transfer.destination.statement_display_name

string

The name that will appear on the bank account statement of the account being debited. The field supports 16 alphanumeric characters for ACH, and 140 for RTP.

transfer.destination.trace_number

string

Unique tracking number of the payment assigned by its origination FI. This number can be used to track the lifecycle of the payment at the FI.

transfer.destination.return_trace_number

string

Unique tracking number assigned to a return to associate it back with its original trace number for reconciliation.

transfer.status_reasons

Transfer Status Reason · object[]

Array that explains why the transfer failed.

Show child attributes

transfer.status_reasons.source

ReasonCode · object

Present if transfer failed due to an issue with the transfer source.

Show child attributes

transfer.status_reasons.source.reason_code

string

required

A word-based code created by Orum to describe the reason for the failure. Orum reason codes are rail-agnostic.

Example:

"insufficient_funds"

transfer.status_reasons.source.reason_code_message

string

required

A human-readable description of the reason code.

transfer.status_reasons.source.network_reason_code

string

The reason code sent by the network (ex R01).

transfer.status_reasons.source.network_reason_code_message

string

The message sent by the network.

transfer.status_reasons.source.network_reason_code_rail_type

string

The payment rail used in the transfer. Either RTP or ACH.

transfer.status_reasons.destination

ReasonCode · object

Present if transfer failed due to an issue with the transfer destination.

Show child attributes

transfer.status_reasons.destination.reason_code

string

required

A word-based code created by Orum to describe the reason for the failure. Orum reason codes are rail-agnostic.

Example:

"insufficient_funds"

transfer.status_reasons.destination.reason_code_message

string

required

A human-readable description of the reason code.

transfer.status_reasons.destination.network_reason_code

string

The reason code sent by the network (ex R01).

transfer.status_reasons.destination.network_reason_code_message

string

The message sent by the network.

transfer.status_reasons.destination.network_reason_code_rail_type

string

The payment rail used in the transfer. Either RTP or ACH.

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<date-time>

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<uuid>

Orum generated unique id for the resource.

transfer.schedule_id

string<uuid>

Orum generated unique id for the resource.

transfer.subledger_reference_id

string

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

Required string length: 1 - 255

Get All Transfers Update Transfer Metadata By ID

⌘I

Auth API

Deliver API

Verify API

Webhooks API

Authorizations

Headers

Path Parameters

Response