Webhook events

These are sample webhook reports you receive after you've registered to receive those event types.

Payload Delivery Wrapper

When an event is sent in the form of a webhook, there will always be a wrapper around the content. The actual event will be in the JSON's content section.

{
  "MPLId": "TST",
  "Ignore": false,
  "content": {
    "Id": 0,
    "LoanId": "c1ee19e4-791c-4f38-b581-ae6d007692a6",
    "Status": 5,
    "TimeStamp": "2022-04-04T07:13:08.5754408+00:00",
    "DateInserted": "0001-01-01T00:00:00+00:00"
  }
}

Attribute

Description

MPLId
string

a 3-letter ID for the partner.

Ignore
boolean

True or False.

Content
json

This is the actual content of the event being sent.

Events

LoanStatusUpdated

This event is reported every time the status of a loan is changed.

{
    "Id": 0,
    "LoanId": "18c8704f-2fd2-4474-9378-aeb5009e6dfd",
    "Status": 3,
    "TimeStamp": "2022-06-15T09:36:52.8913255+00:00",
    "DateInserted": "0001-01-01T00:00:00+00:00"
}

Attribute

Description

LoanId
string

Unique identifier of the loan.

Status
integer

Status of the loan.

TimeStamp
DateTime

Timestamp when the webhook was added.

DateInserted
DateTime

Internal CRB information
This can be ignored

ComplianceLoanFailed

This event is reported every time the loan fails to pass all compliance checks.

{
     "MPLId": "xxx",
     "LoanId": "...guid...",
     "CreateDate": "date",
     "FailedRulesReasons": [
        {
           "RuleName": "rule name",
           "Rule": "some string",
           "Data": "some string",
           "Result": true,
           "FailedComplianceID": 67
        }
     ]  
}

Attribute

Description

EventData
object array

MPLId
string

3-digit ID for the MPL.

LoanId
string

Unique identifier for the loan.

CreateDate
DateTime

Date and time the compliance failed.

FailedRulesReasons
array

RuleName
string

Name of the rule that failed.

Rule
string

The psuedo-code of the rule.

Data
string

The actual data found in the loan tape/ attachments.

Result
boolean

True or false.
True if the compliance rule passed, otherwise false.

FailedComplianceId
integer

ID of failed rule.

RailUpdated

This event is reported when there is a status update to a rail that was requested.

{ 
      "Id":0,
      "RailId":"…ID of rail that is received when rail created…",
      "LoanId":"fd331267-6ac2-4818-9d0f-ab2f00747b61",
      "RailType":8,
      "AmountFunded":8500,
      "RailTransactionId":"…railid from cos…",
      "FundResult": int(this is enum RailResultType), 
      "Message":"Description of rail created if no error returned",
      "ProcessedAt": "2022-07-25T03:25:50.7233333-04:00",
      "TransactionGroupId": "00000000-0000-0000-0000-000000000000",
      "DateCreated": "2022-07-25T07:25:47.283+00:00",
      "RailAmount": 8500
}

Attribute

Description

Id
string

0
ignore

RailId
string

Unique identifier of the rail.

LoanId
string

Unique identifier of the loan.

RailType
integer

Enum representing the rail used.

AmountFunded
integer

Amount sent by the rail.

RailTransactionId
string

Unique identifier of the transaction, received from the rail provider that Arix is using for this rail type.

FundResult
string

Enum RailResultTyperepresenting the result of the funding.

Message
string

Update message.

ProcessedAt
DateTime

Timestamp of when the rail was processed on the payment processor, and received this FundResult status.

TransactionGroupId
string

Unique identifier for the transaction group.
Internal CRB information

DateCreated
DateTime

Timestamp of when the rail request was processed.

RailAmount
integer

Rail amount requested from the payment processor.


Did this page help you?