Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- Cards
- Transfers
- Schedules
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Update Transfer Metadata By ID
Update the metadata on a transfer.
curl --request PATCH \
--url https://api-sandbox.orum.io/deliver/transfers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Orum-Version: <orum-version>' \
--data '{
"metadata": {}
}'{
"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"
}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version of Deliver API. Use v2022-09-21.
v2022-09-21 Path Parameters
Orum generated unique id for the transfer you are fetching.
Body
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.
Response
Orum generated unique id for the resource.
Unique reference id for the transfer. Generated by you.
1Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
x >= 1Currency code in ISO 4217 format. Only USD is supported.
USD Speed of transfer.
asap, standard, same_day, wire Describes the current status of the transfer.
completed, created, failed, pending, settled Timestamp when the resource was created.
Timestamp when the resource was last updated.
For use cases that require a Source, information about the transfer funding source, which will be debited.
Unique reference ID for the customer (person or business) associated with the external account being debited.
Unique reference ID for the external account being debited.
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.
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.
Unique tracking number assigned to a return to associate it back with its original trace number for reconciliation.
Information about the transfer funds destination, which will be credited.
Unique reference ID for the customer (person or business) associated with the external account being credited.
Unique reference ID for the account being credited.
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.
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.
Unique tracking number assigned to a return to associate it back with its original trace number for reconciliation.
Array that explains why the transfer failed.
For failed transfers - details on why the transfer is in a failed state.
Present if transfer failed due to an issue with the transfer source.
A word-based code created by Orum to describe the reason for the failure. Orum reason codes are rail-agnostic.
"insufficient_funds"
A human-readable description of the reason code.
The reason code sent by the network (ex R01).
The message sent by the network.
The payment rail used in the transfer. Either RTP or ACH.
Present if transfer failed due to an issue with the transfer destination.
A word-based code created by Orum to describe the reason for the failure. Orum reason codes are rail-agnostic.
"insufficient_funds"
A human-readable description of the reason code.
The reason code sent by the network (ex R01).
The message sent by the network.
The payment rail used in the transfer. Either RTP or ACH.
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.
Estimated date that funds will arrive in destination account. Time will always be midnight and should be ignored.
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.
Orum generated unique id for the resource.
Orum generated unique id for the resource.
Was this page helpful?
curl --request PATCH \
--url https://api-sandbox.orum.io/deliver/transfers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Orum-Version: <orum-version>' \
--data '{
"metadata": {}
}'{
"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"
}
}