OpenApi SpecContact Us

Check Return Payload

Suggest Edits

The Check Return payload (payloadTypeId=609) relates to a customers bank returning a check that has already been processed on a customers account

Possible properties in data node:

Click to expand
  • amount
  • availableDate
  • cardId
  • checkAmount
  • comment
  • createdDate
  • customerId
  • customField1
  • description
  • friendlyDescription
  • fromAccountAmount
  • fromAccountId
  • fromAccountNumberMasked
  • fromAvailableAmount
  • fromCategory
  • fromCreatedDate
  • fromCustomField1
  • fromCustomField2
  • fromCustomField3
  • fromCustomField4
  • fromCustomField5
  • fromLegalName1
  • fromLegalName2
  • fromName
  • fromPendingAmount
  • fromPrimaryCustomerId
  • fromSubCategory
  • fromTag
  • fromTargetAmount
  • fromTargetDate
  • fromTargetMetDate
  • institutionName
  • isReturn
  • masterId
  • modifiedById
  • payloadTypeId
  • receiptId
  • rejectDate
  • rejectReason
  • settledDate
  • submissionDate
  • tag
  • transactionId
  • type
  • typeCode
  • version
  • voidedDate

Example Payload

{
  "accountId":325818,
  "contextId":"0e814868-abe3-4acf-863c-b421c8b0b94e",
  "data":[
    [
      {
        "customerId":325819,
        "transactionId":8831781,
        "masterId":8809851,
        "type":"Check Return",
        "typeCode":"CHKRET",
        "tag":"",
        "amount":850.29,
        "friendlyDescription":"Check Return",
        "description":"Check Return - 9000 - A",
        "createdDate":"2018-06-12T09:26:12.6115040-05:00",
        "settledDate":"2018-06-12T09:26:12.5958994-05:00",
        "voidedDate":"1900-01-01T00:00:00Z",
        "availableDate":"2018-06-12T09:26:12.5958994-05:00",
        "returnCode":"A",
        "comment":"",
        "modifiedById":325819,
        "institutionName":"",
        "customField1":"",
        "fromAccountNumberMasked":"*************7694",
        "fromAccountId":325818,
        "fromCategory":"",
        "fromSubCategory":"",
        "fromTag":"",
        "fromCustomField1":"",
        "fromCustomField2":"",
        "fromCustomField3":"",
        "fromCustomField4":"",
        "fromCustomField5":"",
        "fromCreatedDate":"2017-09-14T18:36:52.1455930-05:00",
        "fromTargetAmount":0,
        "fromTargetMetDate":"9999-12-31T23:59:59.9999999Z",
        "fromTargetDate":"9999-12-31T23:59:59.9999999Z",
        "fromLegalName1":"",
        "fromLegalName2":"",
        "fromName":"Tom Account",
        "fromPrimaryCustomerId":325819,
        "fromAccountAmount":0.00,
        "fromAvailableAmount":-850.29,
        "fromPendingAmount":0,
        "payloadTypeId":609,
        "version":1,
        "cardId":0,
        "receiptId":81624247,
        "checkAmount":850.29,
        "submissionDate":"2018-06-11T14:26:52.7727199-05:00",
        "rejectDate":"2018-06-11T16:12:44.5937275-05:00",
        "rejectReason":"NSF - Not Sufficient Funds",
        "isReturn":0
      }
    ]
  ],
  "eventTimeUtc":"2018-06-12T09:26:12.5958994-05:00",
  "externalAccountId":0,
  "impactedCustomerId":325819,
  "impactedUserId":0,
  "payloadTypeId":609,
  "transactionId":8831780,
  "userEventId":132291550,
  "userEventTypeId":30605104,
  "version":1
}

Updated 4 days ago