Orum Trigger webhooks API is one of 17 APIs that Orum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Trigger webhooks. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
1 operation
across 1 path,
and defines 86 schemas.
It is described by OpenAPI 3.2.0, at version v2022-09-21.
Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.
The identity and technical contract details declared by the specification.
ClosedAt
string
Timestamp when the status of the resource was set to "closed".
Zip5
string
5-digit ZIP Code. Numeric values (0-9) only.
BookTransferDestinationObject
object
Information about the ultimate destination of the book transfer.
1 property
1 required
UpdatedAt
string
Timestamp when the resource was last updated.
DestinationTransferPartyResponse
object
Information about the transfer funds destination, which will be credited.
5 properties
2 required
EstimatedVerificationDate
string
Estimated date that the account verification will be complete. Time will always be midnight and should be ignored.
SubledgerStatus
string
Status of subledger in Orum system.
ReasonCode
string
A word-based code that describes the verification failure.
BookTransferTestRequest
object
2 properties
2 required
AccountReferenceId
string
Unique reference id for the external account. Generated by you.
BookTransferSourceObject
object
Information about the ultimate source of the book transfer
1 property
1 required
Country
string
2-character ISO country code.
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
PersonStatus
string
Status of person in Orum system.
BusinessTestRequest
object
2 properties
2 required
SubledgerResponseBase
object
8 properties
7 required
TransferEventType
string
The type of event you want to invoke a webhook for.
SubledgerReferenceId
string
Unique reference id for the subledger resource. Generated by you.
DebitStatus
string
Status of account debit.
ControlStatus
string
Status of account control.
State
string
Uppercase two-character state code of the address.
SenderName
string
Name of sender initiating the verification request. This name will appear on the statement and should be recognizable to the account holder. Accepts alphanumer…
VerifyAccountResponseBase
object
17 properties
7 required
TransferReferenceId
string
Unique reference id for the transfer. Generated by you.
EndCustomerResourceType
string
Type of customer resource - business, person, or enterprise.
ContactResponseBusiness
object
Contact information.
5 properties
5 required
VerificationStatusReason
string
Status reason for failed, invalid, and closed accounts.
OwnershipResult
string
Result of Ownership match
BookTransferReferenceId
string
Unique reference id for the book tranfer
ExternalAccountEventType
string
The type of event you want to invoke a webhook for.
AccountHolderName
string
Name of account holder. Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
BusinessStatus
string
Status of Business.
BookTransferStatus
string
Describes the current status of the book transfer.
PostalAddressResponse
object
Address.
10 properties
9 required
ExternalAccountTestRequest
object
2 properties
2 required
BookTransferReasonCode
object
2 properties
2 required
AccountType
string
Type of bank account - checking or savings.
BookTransfer
object
11 properties
7 required
BusinessEventType
string
The type of event you want to invoke a webhook for.
ContactResponsePerson
object
Contact information.
5 properties
5 required
PartyStatementDisplayName
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.
BookTransferStatusReason
object
For failed book transfers - details on why the book transfer is in a failed state.
2 properties
ErrorResponse
object
3 properties
2 required
SubledgerTestRequest
object
2 properties
2 required
ContactTypePerson
string
Type of contact information associated with a person - 'email' or 'phone'.
ContactTypeBusiness
string
Type of contact information associated with a business - 'email', 'phone' or 'website'.
Address2
string
Address line 2.
AddressType
string
Type of address.
AbaRoutingNumber
string
9-digit American Bankers Association (ABA) routing number.
TransferAmount
integer
Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
OwnershipPerson
object
Ownership details for a person
7 properties
2 required
VerifyAccountEventType
string
The type of event you want to invoke a webhook for.
TransferStatusReason
object
For failed transfers - details on why the transfer is in a failed state.
2 properties
PersonResponseBase
object
14 properties
7 required
UsBankAccountNumber
string
Account number for US bank account. 4 to 17 digits are acceptable.
Address1
string
Address line 1.
ReasonCodes
object
5 properties
2 required
ReasonCodeMessage
string
A human-readable description of the reason code.
VerificationStatus
string
Status of account verification.
ExternalAccountResponseBase
object
A single object of External Account.
13 properties
11 required
Email
string
Email address to notify once the statement code is sent to the account to verify account control.
ReturnTraceNumber
string
Unique tracking number assigned to a return to associate it back with its original trace number for reconciliation.
CreatedAt
string
Timestamp when the resource was created.
TraceNumber
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.
VerifyAccountTestRequest
object
2 properties
2 required
SubledgerEventType
string
The type of event you want to invoke a webhook for.
BusinessResponseBase
object
15 properties
6 required
Currency
string
Currency code in ISO 4217 format. Only USD is supported.
TransferSpeed
string
Speed of transfer.
PersonTestRequest
object
2 properties
2 required
TransferTestRequest
object
2 properties
2 required
StatusReason
object
2 properties
2 required
TransferResponseBaseObject
object
17 properties
8 required
SourceTransferPartyResponse
object
For use cases that require a Source, information about the transfer funding source, which will be debited.
5 properties
2 required
OwnershipBusiness
object
Ownership details for a business
5 properties
1 required
TransferStatus
string
Describes the current status of the transfer.
OwnershipStatus
string
Status of account ownership.
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…
CustomerReferenceId
string
Unique reference id for the customer (business or person) resource. Generated by you.
OrumId
string
Orum generated unique id for the resource.
DebitStatusReason
string
Status reason for failed and blocked accounts.
ExternalAccountStatus
string
Status of the external account.
PersonEventType
string
The type of event you want to invoke a webhook for.
BookTransferEventType
string
The type of event you want to invoke a webhook for.
ExternalAccountCustomerReferenceId
string
Unique customerreferenceid that you passed when creating the associated customer (business or person) resource.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Orum publishes across the network.
