Allied API

assistant : assistant

post /assistant

Calls AssistantHandler.Post

Implementation Notes

Uri template /assistant?session={sessionId}

Response Class

Allied.Speech.Parser.Responses.AssistantResponse {

Message (string, optional): String,

SayMessage (string, optional): String,

Action (string, optional): String,

ActionParameters (array[Allied.Speech.Parser.Responses.AssistantResponse+Parameter], optional): IEnumerable[Allied.Speech.Parser.Responses.Parameter]

}
Allied.Speech.Parser.Responses.AssistantResponse+Parameter {

Name (string, optional): String,

Value (string, optional): String

}

{
    "Message": "",
    "SayMessage": "",
    "Action": "",
    "ActionParameters": [
      {
        "Name": "",
        "Value": ""
      }
    ]
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
session			query	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.AssistantRequest { Message (string, optional): String, Select (string, optional): String } `{ "Message": "", "Select": "" }` Click to set as parameter value

audit : audit

Parameter	Parameter Type	Data Type
startDate	query	string
endDate	query	string
domain	query	string
searchTerms	query	string
modifiedBy	query	string
take	query	integer
skip	query	integer

auth : auth

- get /auth/challenge
  - Calls ChallengeHandler.Get
  Implementation Notes
  
  Uri template /auth/challenge
  
  Response Class
  Model
  
  Model Schema
  
  Allied.Services.REST.Handlers.Users.ChallengeRequest {
  Salt (string, optional): String,
  Challenge (string, optional): String,
  PinSalt (string, optional): String
  }
  
  { "Salt": "", "Challenge": "", "PinSalt": "" }
  Response Content Type
  
  Hide Response
  
  Request URL
  
  Response Body
  
  Response Code
  
  Response Headers

put /auth

Calls AuthenticationHandler.Put

Implementation Notes

Uri template /auth

Response Class

Allied.Core.Security.IAlliedIdentity {

Domain (string, optional): String,

ApiKey (string, optional): String,

FinancialInstitution (string, optional): Guid,

CustomerId (string, optional): Guid,

GPinKey (string, optional): String,

Authentication (Allied.Core.Security.IPasswordAuthentication, optional): IPasswordAuthentication,

IsLockedOut (boolean, optional): Boolean,

IsDisabled (boolean, optional): Boolean,

RequiresMultiFactor (boolean, optional): Boolean,

Roles (array[], optional): IEnumerable[System.String],

FirstName (string, optional): String,

LastName (string, optional): String,

FullName (string, optional): String,

IsDeleted (boolean, optional): Boolean,

PinAuthentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

PinEnabled (boolean, optional): Boolean,

UseNewUi (boolean, optional): Boolean,

CurrentTheme (string, optional): String

}
Allied.Core.Security.IPasswordAuthentication {

}

{
    "Domain": "",
    "ApiKey": "",
    "FinancialInstitution": "",
    "CustomerId": "",
    "GPinKey": "",
    "Authentication": {},
    "IsLockedOut": false,
    "IsDisabled": false,
    "RequiresMultiFactor": false,
    "Roles": [
      ""
    ],
    "FirstName": "",
    "LastName": "",
    "FullName": "",
    "IsDeleted": false,
    "PinAuthentication": {},
    "PinEnabled": false,
    "UseNewUi": false,
    "CurrentTheme": ""
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:		body	Model Model Schema Allied.Services.REST.Authentication.AuthenticationRequest { UserName (string, optional): String, Domain (string, optional): String, HashedPassword (string, optional): String, RememberThisMachine (boolean, optional): Boolean, MachineId (string, optional): String, OnBehalfOf (string, optional): String, HashedPin (string, optional): String, Fingerprint (string, optional): String, OnBehalfOfDomain (string, optional): String } `{ "UserName": "", "Domain": "", "HashedPassword": "", "RememberThisMachine": false, "MachineId": "", "OnBehalfOf": "", "HashedPin": "", "Fingerprint": "", "OnBehalfOfDomain": "" }` Click to set as parameter value

post /auth

Calls AuthenticationHandler.Post

Implementation Notes

Uri template /auth

Response Class

Allied.Domain.DTOs.User {

Id (string, optional): Guid,

UserName (string, optional): String,

Roles (array[], optional): IEnumerable[System.String],

Identity (System.Security.Principal.IIdentity, optional): IIdentity,

PhoneNumbers (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber],

FinancialInstitutionId (string, optional): Guid,

Domain (string, optional): String,

CustomerId (string, optional): Guid,

HasGoogleAuth (boolean, optional): Boolean,

IsEnrolled (boolean, optional): Boolean,

EmailAddress (string, optional): String,

IsLockedOut (boolean, optional): Boolean,

RequiresMultiFactor (boolean, optional): Boolean,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

FirstName (string, optional): String,

LastName (string, optional): String,

FullName (string, optional): String,

Password (string, optional): String,

DisplayUserName (string, optional): String,

ForeignKey (string, optional): String,

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean,

IsDeleted (boolean, optional): Boolean,

PinAuthentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

TimeZone (string, optional): String,

Authentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

ApiKey (string, optional): String,

FinancialInstitution (string, optional): Guid,

GPinKey (string, optional): String,

IsUserTeller (boolean, optional): Boolean,

IsDemo (boolean, optional): Boolean,

IsForcePasswordChange (boolean, optional): Boolean,

IsUserFIAdmin (boolean, optional): Boolean,

IsPasswordExpired (boolean, optional): Boolean,

GPinKeyMask (string, optional): String,

PinEnabled (boolean, optional): Boolean,

SelectedTheme (string, optional): String,

IsSSO (boolean, optional): Boolean,

CurrentTheme (string, optional): String,

LimitId (string, optional): Guid,

IsPictureTipsHidden (boolean, optional): Boolean,

HasAcceptedDisclaimer (boolean, optional): Boolean,

DefaultFlexPayView (string, optional): String,

UseNewUi (boolean, optional): Boolean,

IsDisabled (boolean, optional): Boolean

}
System.Security.Principal.IIdentity {

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean

}
Allied.Domain.DTOs.PhoneNumber {

Id (string, optional): Guid,

Name (string, optional): String,

Number (string, optional): String,

IsEnabled (boolean, optional): Boolean,

IsVerified (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

VerificationCode (string, optional): String,

PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes,

IsTextCapable (boolean, optional): Boolean

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}
Allied.Core.Security.IPasswordAuthentication {

}

{
    "Id": "",
    "UserName": "",
    "Roles": [
      ""
    ],
    "Identity": {
      "Name": "",
      "AuthenticationType": "",
      "IsAuthenticated": false
    },
    "PhoneNumbers": [
      {
        "Id": "",
        "Name": "",
        "Number": "",
        "IsEnabled": false,
        "IsVerified": false,
        "IsDefault": false,
        "VerificationCode": "",
        "PhoneType": "",
        "IsTextCapable": false
      }
    ],
    "FinancialInstitutionId": "",
    "Domain": "",
    "CustomerId": "",
    "HasGoogleAuth": false,
    "IsEnrolled": false,
    "EmailAddress": "",
    "IsLockedOut": false,
    "RequiresMultiFactor": false,
    "Links": [
      {
        "HRef": "",
        "Relation": ""
      }
    ],
    "FirstName": "",
    "LastName": "",
    "FullName": "",
    "Password": "",
    "DisplayUserName": "",
    "ForeignKey": "",
    "Name": "",
    "AuthenticationType": "",
    "IsAuthenticated": false,
    "IsDeleted": false,
    "PinAuthentication": {},
    "TimeZone": "",
    "Authentication": {},
    "ApiKey": "",
    "FinancialInstitution": "",
    "GPinKey": "",
    "IsUserTeller": false,
    "IsDemo": false,
    "IsForcePasswordChange": false,
    "IsUserFIAdmin": false,
    "IsPasswordExpired": false,
    "GPinKeyMask": "",
    "PinEnabled": false,
    "SelectedTheme": "",
    "IsSSO": false,
    "CurrentTheme": "",
    "LimitId": "",
    "IsPictureTipsHidden": false,
    "HasAcceptedDisclaimer": false,
    "DefaultFlexPayView": "",
    "UseNewUi": false,
    "IsDisabled": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:		body	Model Model Schema Allied.Services.REST.Authentication.AuthenticationRequest { UserName (string, optional): String, Domain (string, optional): String, HashedPassword (string, optional): String, RememberThisMachine (boolean, optional): Boolean, MachineId (string, optional): String, OnBehalfOf (string, optional): String, HashedPin (string, optional): String, Fingerprint (string, optional): String, OnBehalfOfDomain (string, optional): String } `{ "UserName": "", "Domain": "", "HashedPassword": "", "RememberThisMachine": false, "MachineId": "", "OnBehalfOf": "", "HashedPin": "", "Fingerprint": "", "OnBehalfOfDomain": "" }` Click to set as parameter value

Parameter	Value	Description	Parameter Type	Data Type
pin			query	string

get /auth

Calls AuthenticationSSOHandler.GetSSO

Implementation Notes

Uri template /auth?sso={token}&signature={signature}

Response Class

Allied.Domain.DTOs.User {

Id (string, optional): Guid,

UserName (string, optional): String,

Roles (array[], optional): IEnumerable[System.String],

Identity (System.Security.Principal.IIdentity, optional): IIdentity,

PhoneNumbers (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber],

FinancialInstitutionId (string, optional): Guid,

Domain (string, optional): String,

CustomerId (string, optional): Guid,

HasGoogleAuth (boolean, optional): Boolean,

IsEnrolled (boolean, optional): Boolean,

EmailAddress (string, optional): String,

IsLockedOut (boolean, optional): Boolean,

RequiresMultiFactor (boolean, optional): Boolean,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

FirstName (string, optional): String,

LastName (string, optional): String,

FullName (string, optional): String,

Password (string, optional): String,

DisplayUserName (string, optional): String,

ForeignKey (string, optional): String,

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean,

IsDeleted (boolean, optional): Boolean,

PinAuthentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

TimeZone (string, optional): String,

Authentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

ApiKey (string, optional): String,

FinancialInstitution (string, optional): Guid,

GPinKey (string, optional): String,

IsUserTeller (boolean, optional): Boolean,

IsDemo (boolean, optional): Boolean,

IsForcePasswordChange (boolean, optional): Boolean,

IsUserFIAdmin (boolean, optional): Boolean,

IsPasswordExpired (boolean, optional): Boolean,

GPinKeyMask (string, optional): String,

PinEnabled (boolean, optional): Boolean,

SelectedTheme (string, optional): String,

IsSSO (boolean, optional): Boolean,

CurrentTheme (string, optional): String,

LimitId (string, optional): Guid,

IsPictureTipsHidden (boolean, optional): Boolean,

HasAcceptedDisclaimer (boolean, optional): Boolean,

DefaultFlexPayView (string, optional): String,

UseNewUi (boolean, optional): Boolean,

IsDisabled (boolean, optional): Boolean

}
System.Security.Principal.IIdentity {

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean

}
Allied.Domain.DTOs.PhoneNumber {

Id (string, optional): Guid,

Name (string, optional): String,

Number (string, optional): String,

IsEnabled (boolean, optional): Boolean,

IsVerified (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

VerificationCode (string, optional): String,

PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes,

IsTextCapable (boolean, optional): Boolean

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}
Allied.Core.Security.IPasswordAuthentication {

}

{
    "Id": "",
    "UserName": "",
    "Roles": [
      ""
    ],
    "Identity": {
      "Name": "",
      "AuthenticationType": "",
      "IsAuthenticated": false
    },
    "PhoneNumbers": [
      {
        "Id": "",
        "Name": "",
        "Number": "",
        "IsEnabled": false,
        "IsVerified": false,
        "IsDefault": false,
        "VerificationCode": "",
        "PhoneType": "",
        "IsTextCapable": false
      }
    ],
    "FinancialInstitutionId": "",
    "Domain": "",
    "CustomerId": "",
    "HasGoogleAuth": false,
    "IsEnrolled": false,
    "EmailAddress": "",
    "IsLockedOut": false,
    "RequiresMultiFactor": false,
    "Links": [
      {
        "HRef": "",
        "Relation": ""
      }
    ],
    "FirstName": "",
    "LastName": "",
    "FullName": "",
    "Password": "",
    "DisplayUserName": "",
    "ForeignKey": "",
    "Name": "",
    "AuthenticationType": "",
    "IsAuthenticated": false,
    "IsDeleted": false,
    "PinAuthentication": {},
    "TimeZone": "",
    "Authentication": {},
    "ApiKey": "",
    "FinancialInstitution": "",
    "GPinKey": "",
    "IsUserTeller": false,
    "IsDemo": false,
    "IsForcePasswordChange": false,
    "IsUserFIAdmin": false,
    "IsPasswordExpired": false,
    "GPinKeyMask": "",
    "PinEnabled": false,
    "SelectedTheme": "",
    "IsSSO": false,
    "CurrentTheme": "",
    "LimitId": "",
    "IsPictureTipsHidden": false,
    "HasAcceptedDisclaimer": false,
    "DefaultFlexPayView": "",
    "UseNewUi": false,
    "IsDisabled": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
sso			query	string
signature			query	string

customerInfo : customerInfo

get /customerInfo/fromAccount

Calls CustomerInfoHandler.GetInformationFromAccount

Implementation Notes

Uri template /customerInfo/fromAccount?accountNumber={accountNumber}&routingNumber={routingNumber}

Response Class

Allied.Domain.DTOs.CustomerInformation {

Name (string, optional): String,

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

State (string, optional): String,

PostalCode (string, optional): String

}

{
    "Name": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "State": "",
    "PostalCode": ""
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
accountNumber			query	string
routingNumber			query	string

Response Messages

HTTP Status Code	Reason	Response Model
204

customers : customers

get /customers/{customerId}/history

Calls PaymentHistoryHandlerStrategy.Get

Implementation Notes

Uri template /customers/{customerId}/history?$view={view}&processed={processed}&$top={top}&$page={page}&templateType={templateType}

Response Class

Allied.Domain.DTOs.PaymentHistory {

Id (string, optional): Guid,

CustomerId (string, optional): Guid,

UserId (string, optional): Guid,

PayToName (string, optional): String,

DisplayName (string, optional): String,

Amount (number, optional): Decimal,

ExpectedDeliveryDate (string, optional): DateTime,

PaymentDate (string, optional): DateTime,

IsElectronic (boolean, optional): Boolean,

PaymentId (string, optional): Guid,

Status (string, optional): String,

PictureId (string, optional): Guid,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

CheckNumber (string, optional): String,

PaymentType (string, optional): String,

CreateOnDate (string, optional): DateTime,

PayFromAccount (string, optional): String,

PayFromRouting (string, optional): String,

PayToAccount (string, optional): String,

PayToAddress (string, optional): String,

PayToAddress2 (string, optional): String,

PayToCity (string, optional): String,

PayToState (string, optional): String,

PayToZip (string, optional): String,

IsScheduled (boolean, optional): Boolean,

IsRecurring (boolean, optional): Boolean,

PaymentTemplateId (string, optional): Guid,

ConfirmationNumber (string, optional): String,

Memo (string, optional): String

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}

[
    {
      "Id": "",
      "CustomerId": "",
      "UserId": "",
      "PayToName": "",
      "DisplayName": "",
      "Amount": 0,
      "ExpectedDeliveryDate": "",
      "PaymentDate": "",
      "IsElectronic": false,
      "PaymentId": "",
      "Status": "",
      "PictureId": "",
      "Links": [
        {
          "HRef": "",
          "Relation": ""
        }
      ],
      "CheckNumber": "",
      "PaymentType": "",
      "CreateOnDate": "",
      "PayFromAccount": "",
      "PayFromRouting": "",
      "PayToAccount": "",
      "PayToAddress": "",
      "PayToAddress2": "",
      "PayToCity": "",
      "PayToState": "",
      "PayToZip": "",
      "IsScheduled": false,
      "IsRecurring": false,
      "PaymentTemplateId": "",
      "ConfirmationNumber": "",
      "Memo": ""
    }
  ]

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
customerId	path	string
processed	query	string
$view	query	string
$top	query	integer
$page	query	integer
templateType	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200

post /customers/create

Calls CustomerRequestHandler.Post

Implementation Notes

Uri template /customers/create

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.CreateCustomerRequest { UserName (string, optional): String, Password (string, optional): String, Roles (array[], optional): IEnumerable[System.String], Phones (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber], FinancialInstitutionId (string, optional): Guid, UserId (string, optional): Guid, Id (string, optional): Guid, Address (Allied.Domain.DTOs.Address, optional): Address, BankUserId (string, optional): String, CreateBy (string, optional): String, CreateOn (string, optional): DateTime, DailyLimit (integer, optional): Int32, Email (string, optional): String, FirstName (string, optional): String, FullName (string, optional): String, IsActive (boolean, optional): Boolean, LastName (string, optional): String, LastPasswordChange (string, optional): DateTime, ModifyBy (string, optional): String, ModifyOn (string, optional): DateTime, TransactionLimit (integer, optional): Int32, Phone (string, optional): String, ShardKey (string, optional): String, Accounts (array[Allied.Domain.DTOs.BankAccount], optional): IEnumerable[Allied.Domain.DTOs.BankAccount], NextPaperCheckNumber (string, optional): String, CompanyName (string, optional): String, Version (integer, optional): Int64, VerifyLimit (integer, optional): Int32, ShowPreferencesOnLogin (boolean, optional): Boolean, Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link], LimitId (string, optional): Guid, CustomerLogoId (string, optional): Guid, TenantKey (string, optional): String, PicPayStartingDate (string, optional): DateTime, PicPayLatestDate (string, optional): DateTime, EffectiveAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address, WaiveFees (boolean, optional): Boolean, NotifyWhenPayeeCreated (boolean, optional): Boolean, CurrentTheme (string, optional): String, NotifyWhenPaymentOverAmount (boolean, optional): Boolean, NotifyWhenPaymentOverAmountValue (number, optional): Double, NotifyOfPaymentsSent (boolean, optional): Boolean, FeeScheduleId (string, optional): Guid } Allied.Domain.DTOs.PhoneNumber { Id (string, optional): Guid, Name (string, optional): String, Number (string, optional): String, IsEnabled (boolean, optional): Boolean, IsVerified (boolean, optional): Boolean, IsDefault (boolean, optional): Boolean, VerificationCode (string, optional): String, PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes, IsTextCapable (boolean, optional): Boolean } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.DTOs.BankAccount { Id (string, optional): Guid, Name (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime, Empty (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount, DisplayName (string, optional): String, IsConfirmed (boolean, optional): Boolean } Allied.Core.Collections.Link { HRef (string, optional): Uri, Relation (string, optional): String } { "UserName": "", "Password": "", "Roles": [ "" ], "Phones": [ { "Id": "", "Name": "", "Number": "", "IsEnabled": false, "IsVerified": false, "IsDefault": false, "VerificationCode": "", "PhoneType": "", "IsTextCapable": false } ], "FinancialInstitutionId": "", "UserId": "", "Id": "", "Address": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "BankUserId": "", "CreateBy": "", "CreateOn": "", "DailyLimit": 0, "Email": "", "FirstName": "", "FullName": "", "IsActive": false, "LastName": "", "LastPasswordChange": "", "ModifyBy": "", "ModifyOn": "", "TransactionLimit": 0, "Phone": "", "ShardKey": "", "Accounts": [ { "Id": "", "Name": "", "AccountNumber": "", "RoutingNumber": "", "AccountType": "", "AvailableBalance": 0, "IsDefault": false, "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "", "Empty": "Allied.Domain.DTOs.BankAccount", "DisplayName": "", "IsConfirmed": false } ], "NextPaperCheckNumber": "", "CompanyName": "", "Version": 0, "VerifyLimit": 0, "ShowPreferencesOnLogin": false, "Links": [ { "HRef": "", "Relation": "" } ], "LimitId": "", "CustomerLogoId": "", "TenantKey": "", "PicPayStartingDate": "", "PicPayLatestDate": "", "EffectiveAddress": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "WaiveFees": false, "NotifyWhenPayeeCreated": false, "CurrentTheme": "", "NotifyWhenPaymentOverAmount": false, "NotifyWhenPaymentOverAmountValue": 0, "NotifyOfPaymentsSent": false, "FeeScheduleId": "" } Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
201
200

get /customers

Calls CustomerListHandler.Get

Implementation Notes

Uri template /customers?$top={top}&$page={page}&name={name}&zip={zip}&accountNumber={accountNumber}&$orderby={orderby}&$filter={filter}&$view={viewName}

Response Class

Allied.Core.Collections.IPagedResult {

Next (Allied.Core.Collections.Link[Allied.Core.Collections.Link], optional): Link,

Previous (Allied.Core.Collections.Link[Allied.Core.Collections.Link], optional): Link,

ApproxCount (integer, optional): Int64

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}

{
    "Next": {
      "HRef": "",
      "Relation": ""
    },
    "Previous": {
      "HRef": "",
      "Relation": ""
    },
    "ApproxCount": 0
  }

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
$top	query	integer
name	query	string
zip	query	string
accountNumber	query	string
orderBy	query	string
$filter	query	string
$page	query	integer
$view	query	string

Response Messages

HTTP Status Code	Reason	Response Model
403

get /customers/{customerId}/address

Calls CustomerAddressHandlerStrategy.GetAddress

put /customers/{customerId}/address

Calls CustomerAddressHandlerStrategy.PutAddress

Implementation Notes

Uri template /customers/{customerId}/address

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } `{ "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }` Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
204

post /customers/{customerId}/submitPayment

Calls SubmitPaymentHandlerStrategy.Post

Implementation Notes

Uri template /customers/{customerId}/submitPayment

Response Class

Allied.Domain.Resources.PaymentCreatedResource {

PayToName (string, optional): String,

Id (string, optional): Guid,

Status (string, optional): String,

ExpectedDeliveryDate (string, optional): DateTime,

PaymentDate (string, optional): DateTime,

Amount (number, optional): Decimal,

ConfirmationNumber (string, optional): String

}

{
    "PayToName": "",
    "Id": "",
    "Status": "",
    "ExpectedDeliveryDate": "",
    "PaymentDate": "",
    "Amount": 0,
    "ConfirmationNumber": ""
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.SubmitPaymentRequest { TemplateId (string, optional): Guid, PictureId (string, optional): Guid, Amount (number, optional): Double, AccountNumber (string, optional): String, DeliveryOptionId (string, optional): Guid, ScheduleForDate (string, optional): DateTime, PayToName (string, optional): String, PayToAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address, PayFromBankAccount (Allied.Domain.Resources.BankAccount, optional): BankAccount, PayFromName (string, optional): String, Memo (string, optional): String } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.Resources.BankAccount { Id (string, optional): Guid, DisplayName (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime } { "TemplateId": "", "PictureId": "", "Amount": 0, "AccountNumber": "", "DeliveryOptionId": "", "ScheduleForDate": "", "PayToName": "", "PayToAddress": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "PayFromBankAccount": { "Id": "", "DisplayName": "", "AccountNumber": "", "RoutingNumber": "", "AvailableBalance": 0, "IsDefault": false, "AccountType": "", "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "" }, "PayFromName": "", "Memo": "" } Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
201
404
400

post /customers/{customerId}/submitPayments

Calls SubmitMultiPaymentHandlerStrategy.Post

Implementation Notes

Uri template /customers/{customerId}/submitPayments

Response Class

Allied.Domain.Resources.PaymentCreatedResource {

PayToName (string, optional): String,

Id (string, optional): Guid,

Status (string, optional): String,

ExpectedDeliveryDate (string, optional): DateTime,

PaymentDate (string, optional): DateTime,

Amount (number, optional): Decimal,

ConfirmationNumber (string, optional): String

}

{
    "PayToName": "",
    "Id": "",
    "Status": "",
    "ExpectedDeliveryDate": "",
    "PaymentDate": "",
    "Amount": 0,
    "ConfirmationNumber": ""
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.SubmitPaymentRequest { TemplateId (string, optional): Guid, PictureId (string, optional): Guid, Amount (number, optional): Double, AccountNumber (string, optional): String, DeliveryOptionId (string, optional): Guid, ScheduleForDate (string, optional): DateTime, PayToName (string, optional): String, PayToAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address, PayFromBankAccount (Allied.Domain.Resources.BankAccount, optional): BankAccount, PayFromName (string, optional): String, Memo (string, optional): String } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.Resources.BankAccount { Id (string, optional): Guid, DisplayName (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime } [ { "TemplateId": "", "PictureId": "", "Amount": 0, "AccountNumber": "", "DeliveryOptionId": "", "ScheduleForDate": "", "PayToName": "", "PayToAddress": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "PayFromBankAccount": { "Id": "", "DisplayName": "", "AccountNumber": "", "RoutingNumber": "", "AvailableBalance": 0, "IsDefault": false, "AccountType": "", "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "" }, "PayFromName": "", "Memo": "" } ] Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
201
404
400

get /customers/{customerId}/payments

Calls GetPaymentsByCustomerHandlerStrategy.Get

post /customers/{customerId}/templates/{templateId}

Calls TemplateHandlerStrategy.Post

Implementation Notes

Uri template /customers/{customerId}/templates/{templateId}

Response Class

System.Void {

}

{}

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
customerId		path	string
templateId		path	string
body	Parameter content type:	body	Model Model Schema Allied.Domain.DTOs.CreatePaymentTemplateRequest { Name (string, optional): String, Address (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address, AccountNumber (string, optional): String, PictureId (string, optional): Guid, PayFromBankAccount (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount, TemplateType (string, optional): String, DisplayName (string, optional): String, PayToEmailAddress (string, optional): String, Memo (string, optional): String } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.DTOs.BankAccount { Id (string, optional): Guid, Name (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime, Empty (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount, DisplayName (string, optional): String, IsConfirmed (boolean, optional): Boolean } { "Name": "", "Address": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "AccountNumber": "", "PictureId": "", "PayFromBankAccount": { "Id": "", "Name": "", "AccountNumber": "", "RoutingNumber": "", "AccountType": "", "AvailableBalance": 0, "IsDefault": false, "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "", "Empty": "Allied.Domain.DTOs.BankAccount", "DisplayName": "", "IsConfirmed": false }, "TemplateType": "", "DisplayName": "", "PayToEmailAddress": "", "Memo": "" } Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
201
401
400
404
303

get /customers/{customerId}/templates/{templateId}

Calls TemplateHandlerStrategy.Get

Implementation Notes

Uri template /customers/{customerId}/templates/{templateId}

Response Class

Allied.Domain.DTOs.PaymentTemplate {

Id (string, optional): Guid,

Name (string, optional): String,

PayToAccount (string, optional): String,

Schedule (Allied.Domain.Schedule, optional): Schedule,

Amount (number, optional): Double,

TemplateType (string, optional): String,

ShowInQuickPay (boolean, optional): Boolean,

DisplayName (string, optional): String,

IsElectronic (boolean, optional): Boolean,

PayToAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address,

PayFromAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address,

UseElectronicView (boolean, optional): Boolean,

LastPaymentInfo (Allied.Domain.DTOs.PaymentInfo, optional): PaymentInfo,

NextPaymentInfo (Allied.Domain.DTOs.PaymentInfo[Allied.Domain.DTOs.PaymentInfo], optional): PaymentInfo,

PayFromBankAccount (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount,

MemoField (string, optional): String,

LastModified (string, optional): DateTime,

CorrectedAccountNumber (string, optional): String,

PictureId (string, optional): Guid,

IsReviewed (boolean, optional): Boolean,

CustomerId (string, optional): Guid,

ImageUrl (string, optional): String,

Description (string, optional): String,

ClickThruUrl (string, optional): String,

LargeImageUrl (string, optional): String,

PaymentDate (string, optional): DateTime,

DefaultScheduledForOffset (integer, optional): Int32,

DefaultScheduledForOffsetAlgo (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Category (string, optional): String,

CustomerMessages (array[Allied.Domain.DTOs.CustomerMessage], optional): IEnumerable[Allied.Domain.DTOs.CustomerMessage],

DuplicateOf (string, optional): Guid,

PayToEmailAddress (string, optional): String,

ConversionKey (string, optional): String,

FusePayCbToken (string, optional): String,

IsReadOnly (boolean, optional): Boolean,

FusePayBillerQuestions (array[Allied.Domain.FusePayBillerQuestion], optional): IEnumerable[Allied.Domain.FusePayBillerQuestion],

DismissedMessages (array[Allied.Domain.DismissedMessage], optional): IEnumerable[Allied.Domain.DismissedMessage]

}
Allied.Domain.Schedule {

Id (string, optional): Guid,

Amount (number, optional): Double,

Frequency (string, optional) = ['None' or 'OnceEveryMonth' or 'TwiceEveryMonth' or 'EveryWeek' or 'Every2Weeks' or 'Every4Weeks' or 'Every2Months' or 'Every3Months' or 'Every6Months' or 'EveryYear']: Frequencies,

StartingDate (string, optional): DateTime,

UntilButNotAfter (string, optional): DateTime,

UntilTotalPayments (integer, optional): Int32,

TerminateCondition (string, optional) = ['UntilCancelled' or 'UntilButNotAfterDate' or 'UntilTotalPaymentsMade']: TerminateConditions,

NonBusinessDayOption (string, optional) = ['PreviousBusinessDay' or 'NextBusinessDay']: NonBusinessDayOptions,

IsScheduleActive (boolean, optional): Boolean

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.DTOs.PaymentInfo {

PaymentId (string, optional): Guid,

Amount (number, optional): Double,

PaymentDate (string, optional): DateTime

}
Allied.Domain.DTOs.BankAccount {

Id (string, optional): Guid,

Name (string, optional): String,

AccountNumber (string, optional): String,

RoutingNumber (string, optional): String,

AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes,

AvailableBalance (number, optional): Double,

IsDefault (boolean, optional): Boolean,

AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes,

BalanceLastModified (string, optional): DateTime,

AccountOpenDate (string, optional): DateTime,

Empty (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount,

DisplayName (string, optional): String,

IsConfirmed (boolean, optional): Boolean

}
Allied.Domain.DTOs.CustomerMessage {

MessageType (string, optional): String,

Message (string, optional): String,

MessageId (string, optional): Guid

}
Allied.Domain.FusePayBillerQuestion {

QuestionKey (string, optional): String,

AnswerValue (string, optional): String

}
Allied.Domain.DismissedMessage {

Message (string, optional): String,

DismissedOn (string, optional): DateTime

}

{
    "Id": "",
    "Name": "",
    "PayToAccount": "",
    "Schedule": {
      "Id": "",
      "Amount": 0,
      "Frequency": "",
      "StartingDate": "",
      "UntilButNotAfter": "",
      "UntilTotalPayments": 0,
      "TerminateCondition": "",
      "NonBusinessDayOption": "",
      "IsScheduleActive": false
    },
    "Amount": 0,
    "TemplateType": "",
    "ShowInQuickPay": false,
    "DisplayName": "",
    "IsElectronic": false,
    "PayToAddress": {
      "Address1": "",
      "Address2": "",
      "City": "",
      "Country": "",
      "PostalCode": "",
      "State": "",
      "Result": ""
    },
    "PayFromAddress": {
      "Address1": "",
      "Address2": "",
      "City": "",
      "Country": "",
      "PostalCode": "",
      "State": "",
      "Result": ""
    },
    "UseElectronicView": false,
    "LastPaymentInfo": {
      "PaymentId": "",
      "Amount": 0,
      "PaymentDate": ""
    },
    "NextPaymentInfo": {
      "PaymentId": "",
      "Amount": 0,
      "PaymentDate": ""
    },
    "PayFromBankAccount": {
      "Id": "",
      "Name": "",
      "AccountNumber": "",
      "RoutingNumber": "",
      "AccountType": "",
      "AvailableBalance": 0,
      "IsDefault": false,
      "AccountOwnerType": "",
      "BalanceLastModified": "",
      "AccountOpenDate": "",
      "Empty": "Allied.Domain.DTOs.BankAccount",
      "DisplayName": "",
      "IsConfirmed": false
    },
    "MemoField": "",
    "LastModified": "",
    "CorrectedAccountNumber": "",
    "PictureId": "",
    "IsReviewed": false,
    "CustomerId": "",
    "ImageUrl": "",
    "Description": "",
    "ClickThruUrl": "",
    "LargeImageUrl": "",
    "PaymentDate": "",
    "DefaultScheduledForOffset": 0,
    "DefaultScheduledForOffsetAlgo": "",
    "Category": "",
    "CustomerMessages": [
      {
        "MessageType": "",
        "Message": "",
        "MessageId": ""
      }
    ],
    "DuplicateOf": "",
    "PayToEmailAddress": "",
    "ConversionKey": "",
    "FusePayCbToken": "",
    "IsReadOnly": false,
    "FusePayBillerQuestions": [
      {
        "QuestionKey": "",
        "AnswerValue": ""
      }
    ],
    "DismissedMessages": [
      {
        "Message": "",
        "DismissedOn": ""
      }
    ]
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			path	string
templateId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
404
200

put /customers/{customerId}/templates/{templateId}

Calls TemplateHandlerStrategy.Put

Implementation Notes

Uri template /customers/{customerId}/templates/{templateId}

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
customerId		path	string
templateId		path	string
body	Parameter content type:	body	Model Model Schema Allied.Domain.DTOs.PaymentTemplate { Id (string, optional): Guid, Name (string, optional): String, PayToAccount (string, optional): String, Schedule (Allied.Domain.Schedule, optional): Schedule, Amount (number, optional): Double, TemplateType (string, optional): String, ShowInQuickPay (boolean, optional): Boolean, DisplayName (string, optional): String, IsElectronic (boolean, optional): Boolean, PayToAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address, PayFromAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address, UseElectronicView (boolean, optional): Boolean, LastPaymentInfo (Allied.Domain.DTOs.PaymentInfo, optional): PaymentInfo, NextPaymentInfo (Allied.Domain.DTOs.PaymentInfo[Allied.Domain.DTOs.PaymentInfo], optional): PaymentInfo, PayFromBankAccount (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount, MemoField (string, optional): String, LastModified (string, optional): DateTime, CorrectedAccountNumber (string, optional): String, PictureId (string, optional): Guid, IsReviewed (boolean, optional): Boolean, CustomerId (string, optional): Guid, ImageUrl (string, optional): String, Description (string, optional): String, ClickThruUrl (string, optional): String, LargeImageUrl (string, optional): String, PaymentDate (string, optional): DateTime, DefaultScheduledForOffset (integer, optional): Int32, DefaultScheduledForOffsetAlgo (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations, Category (string, optional): String, CustomerMessages (array[Allied.Domain.DTOs.CustomerMessage], optional): IEnumerable[Allied.Domain.DTOs.CustomerMessage], DuplicateOf (string, optional): Guid, PayToEmailAddress (string, optional): String, ConversionKey (string, optional): String, FusePayCbToken (string, optional): String, IsReadOnly (boolean, optional): Boolean, FusePayBillerQuestions (array[Allied.Domain.FusePayBillerQuestion], optional): IEnumerable[Allied.Domain.FusePayBillerQuestion], DismissedMessages (array[Allied.Domain.DismissedMessage], optional): IEnumerable[Allied.Domain.DismissedMessage] } Allied.Domain.Schedule { Id (string, optional): Guid, Amount (number, optional): Double, Frequency (string, optional) = ['None' or 'OnceEveryMonth' or 'TwiceEveryMonth' or 'EveryWeek' or 'Every2Weeks' or 'Every4Weeks' or 'Every2Months' or 'Every3Months' or 'Every6Months' or 'EveryYear']: Frequencies, StartingDate (string, optional): DateTime, UntilButNotAfter (string, optional): DateTime, UntilTotalPayments (integer, optional): Int32, TerminateCondition (string, optional) = ['UntilCancelled' or 'UntilButNotAfterDate' or 'UntilTotalPaymentsMade']: TerminateConditions, NonBusinessDayOption (string, optional) = ['PreviousBusinessDay' or 'NextBusinessDay']: NonBusinessDayOptions, IsScheduleActive (boolean, optional): Boolean } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.DTOs.PaymentInfo { PaymentId (string, optional): Guid, Amount (number, optional): Double, PaymentDate (string, optional): DateTime } Allied.Domain.DTOs.BankAccount { Id (string, optional): Guid, Name (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime, Empty (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount, DisplayName (string, optional): String, IsConfirmed (boolean, optional): Boolean } Allied.Domain.DTOs.CustomerMessage { MessageType (string, optional): String, Message (string, optional): String, MessageId (string, optional): Guid } Allied.Domain.FusePayBillerQuestion { QuestionKey (string, optional): String, AnswerValue (string, optional): String } Allied.Domain.DismissedMessage { Message (string, optional): String, DismissedOn (string, optional): DateTime } { "Id": "", "Name": "", "PayToAccount": "", "Schedule": { "Id": "", "Amount": 0, "Frequency": "", "StartingDate": "", "UntilButNotAfter": "", "UntilTotalPayments": 0, "TerminateCondition": "", "NonBusinessDayOption": "", "IsScheduleActive": false }, "Amount": 0, "TemplateType": "", "ShowInQuickPay": false, "DisplayName": "", "IsElectronic": false, "PayToAddress": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "PayFromAddress": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "UseElectronicView": false, "LastPaymentInfo": { "PaymentId": "", "Amount": 0, "PaymentDate": "" }, "NextPaymentInfo": { "PaymentId": "", "Amount": 0, "PaymentDate": "" }, "PayFromBankAccount": { "Id": "", "Name": "", "AccountNumber": "", "RoutingNumber": "", "AccountType": "", "AvailableBalance": 0, "IsDefault": false, "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "", "Empty": "Allied.Domain.DTOs.BankAccount", "DisplayName": "", "IsConfirmed": false }, "MemoField": "", "LastModified": "", "CorrectedAccountNumber": "", "PictureId": "", "IsReviewed": false, "CustomerId": "", "ImageUrl": "", "Description": "", "ClickThruUrl": "", "LargeImageUrl": "", "PaymentDate": "", "DefaultScheduledForOffset": 0, "DefaultScheduledForOffsetAlgo": "", "Category": "", "CustomerMessages": [ { "MessageType": "", "Message": "", "MessageId": "" } ], "DuplicateOf": "", "PayToEmailAddress": "", "ConversionKey": "", "FusePayCbToken": "", "IsReadOnly": false, "FusePayBillerQuestions": [ { "QuestionKey": "", "AnswerValue": "" } ], "DismissedMessages": [ { "Message": "", "DismissedOn": "" } ] } Click to set as parameter value

patch /customers/{customerId}/templates/{templateId}

Calls TemplateHandlerStrategy.Patch

Implementation Notes

Uri template /customers/{customerId}/templates/{templateId}

Response Class

System.Void {

}

{}

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
customerId		path	string
templateId		path	string
body	Parameter content type:	body	Model Model Schema Allied.Domain.Resources.PaymentTemplatePatch { ClearSchedule (string, optional): String, PayToAccountNumber (string, optional): String, PayToAddress (Allied.Domain.Address, optional): Address, DisplayName (string, optional): String, BankAccountId (string, optional): Guid, PayToName (string, optional): String, PayFromAccountNumber (string, optional): String, PayFromRoutingNumber (string, optional): String, MemoField (string, optional): String, NotificationEmail (string, optional): String, PayToBankAccount (Allied.Domain.Resources.PaymentTemplateAccountNumberPatch, optional): PaymentTemplateAccountNumberPatch } Allied.Domain.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, State (string, optional): String, PostalCode (string, optional): String, Country (string, optional): String, Id (string, optional): Guid, Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address, Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address } Allied.Domain.Resources.PaymentTemplateAccountNumberPatch { AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes } `{ "ClearSchedule": "", "PayToAccountNumber": "", "PayToAddress": { "Address1": "", "Address2": "", "City": "", "State": "", "PostalCode": "", "Country": "", "Id": "", "Empty": "Allied.Domain.Address", "Allied": "Allied.Domain.Address" }, "DisplayName": "", "BankAccountId": "", "PayToName": "", "PayFromAccountNumber": "", "PayFromRoutingNumber": "", "MemoField": "", "NotificationEmail": "", "PayToBankAccount": { "AccountNumber": "", "RoutingNumber": "", "AccountType": "" } }` Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
404
204

delete /customers/{customerId}/templates/{templateId}

Calls TemplateHandlerStrategy.Delete

get /customers/{customerId}/templates

Calls PaymentTemplateListHandlerStrategy.Get

Implementation Notes

Uri template /customers/{customerId}/templates?scheduled={scheduled}&templateType={templateType}

Response Class

Allied.Domain.DTOs.PaymentTemplate {

Id (string, optional): Guid,

Name (string, optional): String,

PayToAccount (string, optional): String,

Schedule (Allied.Domain.Schedule, optional): Schedule,

Amount (number, optional): Double,

TemplateType (string, optional): String,

ShowInQuickPay (boolean, optional): Boolean,

DisplayName (string, optional): String,

IsElectronic (boolean, optional): Boolean,

PayToAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address,

PayFromAddress (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address,

UseElectronicView (boolean, optional): Boolean,

LastPaymentInfo (Allied.Domain.DTOs.PaymentInfo, optional): PaymentInfo,

NextPaymentInfo (Allied.Domain.DTOs.PaymentInfo[Allied.Domain.DTOs.PaymentInfo], optional): PaymentInfo,

PayFromBankAccount (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount,

MemoField (string, optional): String,

LastModified (string, optional): DateTime,

CorrectedAccountNumber (string, optional): String,

PictureId (string, optional): Guid,

IsReviewed (boolean, optional): Boolean,

CustomerId (string, optional): Guid,

ImageUrl (string, optional): String,

Description (string, optional): String,

ClickThruUrl (string, optional): String,

LargeImageUrl (string, optional): String,

PaymentDate (string, optional): DateTime,

DefaultScheduledForOffset (integer, optional): Int32,

DefaultScheduledForOffsetAlgo (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Category (string, optional): String,

CustomerMessages (array[Allied.Domain.DTOs.CustomerMessage], optional): IEnumerable[Allied.Domain.DTOs.CustomerMessage],

DuplicateOf (string, optional): Guid,

PayToEmailAddress (string, optional): String,

ConversionKey (string, optional): String,

FusePayCbToken (string, optional): String,

IsReadOnly (boolean, optional): Boolean,

FusePayBillerQuestions (array[Allied.Domain.FusePayBillerQuestion], optional): IEnumerable[Allied.Domain.FusePayBillerQuestion],

DismissedMessages (array[Allied.Domain.DismissedMessage], optional): IEnumerable[Allied.Domain.DismissedMessage]

}
Allied.Domain.Schedule {

Id (string, optional): Guid,

Amount (number, optional): Double,

StartingDate (string, optional): DateTime,

UntilButNotAfter (string, optional): DateTime,

UntilTotalPayments (integer, optional): Int32,

TerminateCondition (string, optional) = ['UntilCancelled' or 'UntilButNotAfterDate' or 'UntilTotalPaymentsMade']: TerminateConditions,

NonBusinessDayOption (string, optional) = ['PreviousBusinessDay' or 'NextBusinessDay']: NonBusinessDayOptions,

IsScheduleActive (boolean, optional): Boolean

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.DTOs.PaymentInfo {

PaymentId (string, optional): Guid,

Amount (number, optional): Double,

PaymentDate (string, optional): DateTime

}
Allied.Domain.DTOs.BankAccount {

Id (string, optional): Guid,

Name (string, optional): String,

AccountNumber (string, optional): String,

RoutingNumber (string, optional): String,

AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes,

AvailableBalance (number, optional): Double,

IsDefault (boolean, optional): Boolean,

AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes,

BalanceLastModified (string, optional): DateTime,

AccountOpenDate (string, optional): DateTime,

Empty (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount,

DisplayName (string, optional): String,

IsConfirmed (boolean, optional): Boolean

}
Allied.Domain.DTOs.CustomerMessage {

MessageType (string, optional): String,

Message (string, optional): String,

MessageId (string, optional): Guid

}
Allied.Domain.FusePayBillerQuestion {

QuestionKey (string, optional): String,

AnswerValue (string, optional): String

}
Allied.Domain.DismissedMessage {

Message (string, optional): String,

DismissedOn (string, optional): DateTime

}

[
    {
      "Id": "",
      "Name": "",
      "PayToAccount": "",
      "Schedule": {
        "Id": "",
        "Amount": 0,
        "Frequency": "",
        "StartingDate": "",
        "UntilButNotAfter": "",
        "UntilTotalPayments": 0,
        "TerminateCondition": "",
        "NonBusinessDayOption": "",
        "IsScheduleActive": false
      },
      "Amount": 0,
      "TemplateType": "",
      "ShowInQuickPay": false,
      "DisplayName": "",
      "IsElectronic": false,
      "PayToAddress": {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "PostalCode": "",
        "State": "",
        "Result": ""
      },
      "PayFromAddress": {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "PostalCode": "",
        "State": "",
        "Result": ""
      },
      "UseElectronicView": false,
      "LastPaymentInfo": {
        "PaymentId": "",
        "Amount": 0,
        "PaymentDate": ""
      },
      "NextPaymentInfo": {
        "PaymentId": "",
        "Amount": 0,
        "PaymentDate": ""
      },
      "PayFromBankAccount": {
        "Id": "",
        "Name": "",
        "AccountNumber": "",
        "RoutingNumber": "",
        "AccountType": "",
        "AvailableBalance": 0,
        "IsDefault": false,
        "AccountOwnerType": "",
        "BalanceLastModified": "",
        "AccountOpenDate": "",
        "Empty": "Allied.Domain.DTOs.BankAccount",
        "DisplayName": "",
        "IsConfirmed": false
      },
      "MemoField": "",
      "LastModified": "",
      "CorrectedAccountNumber": "",
      "PictureId": "",
      "IsReviewed": false,
      "CustomerId": "",
      "ImageUrl": "",
      "Description": "",
      "ClickThruUrl": "",
      "LargeImageUrl": "",
      "PaymentDate": "",
      "DefaultScheduledForOffset": 0,
      "DefaultScheduledForOffsetAlgo": "",
      "Category": "",
      "CustomerMessages": [
        {
          "MessageType": "",
          "Message": "",
          "MessageId": ""
        }
      ],
      "DuplicateOf": "",
      "PayToEmailAddress": "",
      "ConversionKey": "",
      "FusePayCbToken": "",
      "IsReadOnly": false,
      "FusePayBillerQuestions": [
        {
          "QuestionKey": "",
          "AnswerValue": ""
        }
      ],
      "DismissedMessages": [
        {
          "Message": "",
          "DismissedOn": ""
        }
      ]
    }
  ]

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
customerId	path	string
scheduled	query	boolean
templateType	query	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

post /customers/{customerId}/templates

Calls PaymentTemplateListHandlerStrategy.Post

Implementation Notes

Uri template /customers/{customerId}/templates?scheduled={scheduled}&templateType={templateType}

Response Class

array[byte]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.DTOs.CreatePaymentTemplateRequest { Name (string, optional): String, Address (Allied.Domain.DTOs.Address[Allied.Domain.DTOs.Address], optional): Address, AccountNumber (string, optional): String, PictureId (string, optional): Guid, PayFromBankAccount (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount, TemplateType (string, optional): String, DisplayName (string, optional): String, PayToEmailAddress (string, optional): String, Memo (string, optional): String } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.DTOs.BankAccount { Id (string, optional): Guid, Name (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime, Empty (Allied.Domain.DTOs.BankAccount[Allied.Domain.DTOs.BankAccount], optional): BankAccount, DisplayName (string, optional): String, IsConfirmed (boolean, optional): Boolean } { "Name": "", "Address": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "AccountNumber": "", "PictureId": "", "PayFromBankAccount": { "Id": "", "Name": "", "AccountNumber": "", "RoutingNumber": "", "AccountType": "", "AvailableBalance": 0, "IsDefault": false, "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "", "Empty": "Allied.Domain.DTOs.BankAccount", "DisplayName": "", "IsConfirmed": false }, "TemplateType": "", "DisplayName": "", "PayToEmailAddress": "", "Memo": "" } Click to set as parameter value

put /customers/{customerId}/templates/{templateId}/schedule

Calls PaymentScheduleStrategy.Put

Implementation Notes

Uri template /customers/{customerId}/templates/{templateId}/schedule

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
customerId		path	string
templateId		path	string
body	Parameter content type:	body	Model Model Schema Allied.Services.REST.Handlers.Stategies.PaymentScheduleStrategy+ScheduleDTO { AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AvailableBalance (number, optional): Double, PayFromAccountId (string, optional): Guid, Id (string, optional): Guid, Amount (number, optional): Double, Frequency (string, optional) = ['None' or 'OnceEveryMonth' or 'TwiceEveryMonth' or 'EveryWeek' or 'Every2Weeks' or 'Every4Weeks' or 'Every2Months' or 'Every3Months' or 'Every6Months' or 'EveryYear']: Frequencies, StartingDate (string, optional): DateTime, UntilButNotAfter (string, optional): DateTime, UntilTotalPayments (integer, optional): Int32, TerminateCondition (string, optional) = ['UntilCancelled' or 'UntilButNotAfterDate' or 'UntilTotalPaymentsMade']: TerminateConditions, NonBusinessDayOption (string, optional) = ['PreviousBusinessDay' or 'NextBusinessDay']: NonBusinessDayOptions, IsScheduleActive (boolean, optional): Boolean } `{ "AccountNumber": "", "RoutingNumber": "", "AvailableBalance": 0, "PayFromAccountId": "", "Id": "", "Amount": 0, "Frequency": "", "StartingDate": "", "UntilButNotAfter": "", "UntilTotalPayments": 0, "TerminateCondition": "", "NonBusinessDayOption": "", "IsScheduleActive": false }` Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
403
400
204
200

get /customers/{customerId}/templates/{templateId}/schedule

Calls PaymentScheduleStrategy.Get

Implementation Notes

Uri template /customers/{customerId}/templates/{templateId}/schedule

Response Class

Allied.Domain.Schedule {

Id (string, optional): Guid,

Amount (number, optional): Double,

StartingDate (string, optional): DateTime,

UntilButNotAfter (string, optional): DateTime,

UntilTotalPayments (integer, optional): Int32,

TerminateCondition (string, optional) = ['UntilCancelled' or 'UntilButNotAfterDate' or 'UntilTotalPaymentsMade']: TerminateConditions,

NonBusinessDayOption (string, optional) = ['PreviousBusinessDay' or 'NextBusinessDay']: NonBusinessDayOptions,

IsScheduleActive (boolean, optional): Boolean

}

{
    "Id": "",
    "Amount": 0,
    "Frequency": "",
    "StartingDate": "",
    "UntilButNotAfter": "",
    "UntilTotalPayments": 0,
    "TerminateCondition": "",
    "NonBusinessDayOption": "",
    "IsScheduleActive": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			path	string
templateId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
400
404
200

delete /customers/{customerId}/templates/{templateId}/schedule

Calls PaymentScheduleStrategy.Delete

post /customers/{customerId}/templates/{templateId}/submitPayment

Calls PaymentTemplatePaymentPoster.Post

Implementation Notes

Uri template /customers/{customerId}/templates/{templateId}/submitPayment

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
customerId		path	string
templateId		path	string
body	Parameter content type:	body	Model Model Schema Allied.Domain.Resources.SimplePaymentRequest { PaymentDate (string, optional): DateTime, Amount (number, optional): Decimal, PayFromBankAccount (Allied.Domain.Interfaces.IBankAccount, optional): IBankAccount } Allied.Domain.Interfaces.IBankAccount { Id (string, optional): Guid, DisplayName (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime } `{ "PaymentDate": "", "Amount": 0, "PayFromBankAccount": { "Id": "", "DisplayName": "", "AccountNumber": "", "RoutingNumber": "", "AccountType": "", "AvailableBalance": 0, "IsDefault": false, "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "" } }` Click to set as parameter value

fis : fis

post /fis/{fiName}/createUser

Calls CreateCustomerHandler.Post

Implementation Notes

Uri template /fis/{fiName}/createUser

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
fiName			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.CreateBillPayCustomerRequest { UserName (string, optional): String, Address (Allied.Domain.Address, optional): Address, Name (string, optional): String, ForeignKey (string, optional): String, MobilePhoneNumber (string, optional): String, Email (string, optional): String, BankAccountNumber (string, optional): String, BankAccountRoutingNumber (string, optional): String, Password (string, optional): String, Roles (array[], optional): IEnumerable[System.String], Fingerprint (string, optional): String } Allied.Domain.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, State (string, optional): String, PostalCode (string, optional): String, Country (string, optional): String, Id (string, optional): Guid, Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address, Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address } `{ "UserName": "", "Address": { "Address1": "", "Address2": "", "City": "", "State": "", "PostalCode": "", "Country": "", "Id": "", "Empty": "Allied.Domain.Address", "Allied": "Allied.Domain.Address" }, "Name": "", "ForeignKey": "", "MobilePhoneNumber": "", "Email": "", "BankAccountNumber": "", "BankAccountRoutingNumber": "", "Password": "", "Roles": [ "" ], "Fingerprint": "" }` Click to set as parameter value

get /fis/{fiName}/deliveryinfo

Calls FIDeliveryOptionHandler.Get

post /fis/{fiName}/users/{username}/submitPayment

Calls SubmitPaymentHandlerStrategy.Post

Implementation Notes

Uri template /fis/{fiName}/users/{username}/submitPayment

Response Class

Allied.Domain.Resources.PaymentCreatedResource {

PayToName (string, optional): String,

Id (string, optional): Guid,

Status (string, optional): String,

ExpectedDeliveryDate (string, optional): DateTime,

PaymentDate (string, optional): DateTime,

Amount (number, optional): Decimal,

ConfirmationNumber (string, optional): String

}

{
    "PayToName": "",
    "Id": "",
    "Status": "",
    "ExpectedDeliveryDate": "",
    "PaymentDate": "",
    "Amount": 0,
    "ConfirmationNumber": ""
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			query	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.SubmitPaymentRequest { TemplateId (string, optional): Guid, PictureId (string, optional): Guid, Amount (number, optional): Double, AccountNumber (string, optional): String, DeliveryOptionId (string, optional): Guid, ScheduleForDate (string, optional): DateTime, PayToName (string, optional): String, PayToAddress (Allied.Domain.DTOs.Address, optional): Address, PayFromBankAccount (Allied.Domain.Resources.BankAccount, optional): BankAccount, PayFromName (string, optional): String, Memo (string, optional): String } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.Resources.BankAccount { Id (string, optional): Guid, DisplayName (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime } { "TemplateId": "", "PictureId": "", "Amount": 0, "AccountNumber": "", "DeliveryOptionId": "", "ScheduleForDate": "", "PayToName": "", "PayToAddress": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "PayFromBankAccount": { "Id": "", "DisplayName": "", "AccountNumber": "", "RoutingNumber": "", "AvailableBalance": 0, "IsDefault": false, "AccountType": "", "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "" }, "PayFromName": "", "Memo": "" } Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
201
404
400

post /fis/{fiName}/users/{username}/submitPayments

Calls SubmitMultiPaymentHandlerStrategy.Post

Implementation Notes

Uri template /fis/{fiName}/users/{username}/submitPayments

Response Class

Allied.Domain.Resources.PaymentCreatedResource {

PayToName (string, optional): String,

Id (string, optional): Guid,

Status (string, optional): String,

ExpectedDeliveryDate (string, optional): DateTime,

PaymentDate (string, optional): DateTime,

Amount (number, optional): Decimal,

ConfirmationNumber (string, optional): String

}

{
    "PayToName": "",
    "Id": "",
    "Status": "",
    "ExpectedDeliveryDate": "",
    "PaymentDate": "",
    "Amount": 0,
    "ConfirmationNumber": ""
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerId			query	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.SubmitPaymentRequest { TemplateId (string, optional): Guid, PictureId (string, optional): Guid, Amount (number, optional): Double, AccountNumber (string, optional): String, DeliveryOptionId (string, optional): Guid, ScheduleForDate (string, optional): DateTime, PayToName (string, optional): String, PayToAddress (Allied.Domain.DTOs.Address, optional): Address, PayFromBankAccount (Allied.Domain.Resources.BankAccount, optional): BankAccount, PayFromName (string, optional): String, Memo (string, optional): String } Allied.Domain.DTOs.Address { Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, Country (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, Result (string, optional): String } Allied.Domain.Resources.BankAccount { Id (string, optional): Guid, DisplayName (string, optional): String, AccountNumber (string, optional): String, RoutingNumber (string, optional): String, AvailableBalance (number, optional): Double, IsDefault (boolean, optional): Boolean, AccountType (string, optional) = ['Checking' or 'Savings' or 'DDA' or 'GL']: AccountTypes, AccountOwnerType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes, BalanceLastModified (string, optional): DateTime, AccountOpenDate (string, optional): DateTime } [ { "TemplateId": "", "PictureId": "", "Amount": 0, "AccountNumber": "", "DeliveryOptionId": "", "ScheduleForDate": "", "PayToName": "", "PayToAddress": { "Address1": "", "Address2": "", "City": "", "Country": "", "PostalCode": "", "State": "", "Result": "" }, "PayFromBankAccount": { "Id": "", "DisplayName": "", "AccountNumber": "", "RoutingNumber": "", "AvailableBalance": 0, "IsDefault": false, "AccountType": "", "AccountOwnerType": "", "BalanceLastModified": "", "AccountOpenDate": "" }, "PayFromName": "", "Memo": "" } ] Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
201
404
400

get /fis/{fiName}/users

Calls UsersByForeignKeyHandler.GetByForeignKey

Implementation Notes

Uri template /fis/{fiName}/users?foreignKey={foreignKey}

Response Class

Allied.Domain.DTOs.User {

Id (string, optional): Guid,

UserName (string, optional): String,

Roles (array[], optional): IEnumerable[System.String],

Identity (System.Security.Principal.IIdentity, optional): IIdentity,

PhoneNumbers (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber],

FinancialInstitutionId (string, optional): Guid,

Domain (string, optional): String,

CustomerId (string, optional): Guid,

HasGoogleAuth (boolean, optional): Boolean,

IsEnrolled (boolean, optional): Boolean,

EmailAddress (string, optional): String,

IsLockedOut (boolean, optional): Boolean,

RequiresMultiFactor (boolean, optional): Boolean,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

FirstName (string, optional): String,

LastName (string, optional): String,

FullName (string, optional): String,

Password (string, optional): String,

DisplayUserName (string, optional): String,

ForeignKey (string, optional): String,

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean,

IsDeleted (boolean, optional): Boolean,

PinAuthentication (Allied.Core.Security.IPasswordAuthentication, optional): IPasswordAuthentication,

TimeZone (string, optional): String,

Authentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

ApiKey (string, optional): String,

FinancialInstitution (string, optional): Guid,

GPinKey (string, optional): String,

IsUserTeller (boolean, optional): Boolean,

IsDemo (boolean, optional): Boolean,

IsForcePasswordChange (boolean, optional): Boolean,

IsUserFIAdmin (boolean, optional): Boolean,

IsPasswordExpired (boolean, optional): Boolean,

GPinKeyMask (string, optional): String,

PinEnabled (boolean, optional): Boolean,

SelectedTheme (string, optional): String,

IsSSO (boolean, optional): Boolean,

CurrentTheme (string, optional): String,

LimitId (string, optional): Guid,

IsPictureTipsHidden (boolean, optional): Boolean,

HasAcceptedDisclaimer (boolean, optional): Boolean,

DefaultFlexPayView (string, optional): String,

UseNewUi (boolean, optional): Boolean,

IsDisabled (boolean, optional): Boolean

}
System.Security.Principal.IIdentity {

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean

}
Allied.Domain.DTOs.PhoneNumber {

Id (string, optional): Guid,

Name (string, optional): String,

Number (string, optional): String,

IsEnabled (boolean, optional): Boolean,

IsVerified (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

VerificationCode (string, optional): String,

PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes,

IsTextCapable (boolean, optional): Boolean

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}
Allied.Core.Security.IPasswordAuthentication {

}

{
    "Id": "",
    "UserName": "",
    "Roles": [
      ""
    ],
    "Identity": {
      "Name": "",
      "AuthenticationType": "",
      "IsAuthenticated": false
    },
    "PhoneNumbers": [
      {
        "Id": "",
        "Name": "",
        "Number": "",
        "IsEnabled": false,
        "IsVerified": false,
        "IsDefault": false,
        "VerificationCode": "",
        "PhoneType": "",
        "IsTextCapable": false
      }
    ],
    "FinancialInstitutionId": "",
    "Domain": "",
    "CustomerId": "",
    "HasGoogleAuth": false,
    "IsEnrolled": false,
    "EmailAddress": "",
    "IsLockedOut": false,
    "RequiresMultiFactor": false,
    "Links": [
      {
        "HRef": "",
        "Relation": ""
      }
    ],
    "FirstName": "",
    "LastName": "",
    "FullName": "",
    "Password": "",
    "DisplayUserName": "",
    "ForeignKey": "",
    "Name": "",
    "AuthenticationType": "",
    "IsAuthenticated": false,
    "IsDeleted": false,
    "PinAuthentication": {},
    "TimeZone": "",
    "Authentication": {},
    "ApiKey": "",
    "FinancialInstitution": "",
    "GPinKey": "",
    "IsUserTeller": false,
    "IsDemo": false,
    "IsForcePasswordChange": false,
    "IsUserFIAdmin": false,
    "IsPasswordExpired": false,
    "GPinKeyMask": "",
    "PinEnabled": false,
    "SelectedTheme": "",
    "IsSSO": false,
    "CurrentTheme": "",
    "LimitId": "",
    "IsPictureTipsHidden": false,
    "HasAcceptedDisclaimer": false,
    "DefaultFlexPayView": "",
    "UseNewUi": false,
    "IsDisabled": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
fiName			path	string
foreignKey			query	string

get /fis/{fiName}/users

Calls UsersByForeignKeyHandler.GetByForeignKey

Implementation Notes

Uri template /fis/{fiName}/users?foreignkey={foreignKey}

Response Class

Allied.Domain.DTOs.User {

Id (string, optional): Guid,

UserName (string, optional): String,

Roles (array[], optional): IEnumerable[System.String],

Identity (System.Security.Principal.IIdentity, optional): IIdentity,

PhoneNumbers (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber],

FinancialInstitutionId (string, optional): Guid,

Domain (string, optional): String,

CustomerId (string, optional): Guid,

HasGoogleAuth (boolean, optional): Boolean,

IsEnrolled (boolean, optional): Boolean,

EmailAddress (string, optional): String,

IsLockedOut (boolean, optional): Boolean,

RequiresMultiFactor (boolean, optional): Boolean,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

FirstName (string, optional): String,

LastName (string, optional): String,

FullName (string, optional): String,

Password (string, optional): String,

DisplayUserName (string, optional): String,

ForeignKey (string, optional): String,

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean,

IsDeleted (boolean, optional): Boolean,

PinAuthentication (Allied.Core.Security.IPasswordAuthentication, optional): IPasswordAuthentication,

TimeZone (string, optional): String,

Authentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

ApiKey (string, optional): String,

FinancialInstitution (string, optional): Guid,

GPinKey (string, optional): String,

IsUserTeller (boolean, optional): Boolean,

IsDemo (boolean, optional): Boolean,

IsForcePasswordChange (boolean, optional): Boolean,

IsUserFIAdmin (boolean, optional): Boolean,

IsPasswordExpired (boolean, optional): Boolean,

GPinKeyMask (string, optional): String,

PinEnabled (boolean, optional): Boolean,

SelectedTheme (string, optional): String,

IsSSO (boolean, optional): Boolean,

CurrentTheme (string, optional): String,

LimitId (string, optional): Guid,

IsPictureTipsHidden (boolean, optional): Boolean,

HasAcceptedDisclaimer (boolean, optional): Boolean,

DefaultFlexPayView (string, optional): String,

UseNewUi (boolean, optional): Boolean,

IsDisabled (boolean, optional): Boolean

}
System.Security.Principal.IIdentity {

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean

}
Allied.Domain.DTOs.PhoneNumber {

Id (string, optional): Guid,

Name (string, optional): String,

Number (string, optional): String,

IsEnabled (boolean, optional): Boolean,

IsVerified (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

VerificationCode (string, optional): String,

PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes,

IsTextCapable (boolean, optional): Boolean

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}
Allied.Core.Security.IPasswordAuthentication {

}

{
    "Id": "",
    "UserName": "",
    "Roles": [
      ""
    ],
    "Identity": {
      "Name": "",
      "AuthenticationType": "",
      "IsAuthenticated": false
    },
    "PhoneNumbers": [
      {
        "Id": "",
        "Name": "",
        "Number": "",
        "IsEnabled": false,
        "IsVerified": false,
        "IsDefault": false,
        "VerificationCode": "",
        "PhoneType": "",
        "IsTextCapable": false
      }
    ],
    "FinancialInstitutionId": "",
    "Domain": "",
    "CustomerId": "",
    "HasGoogleAuth": false,
    "IsEnrolled": false,
    "EmailAddress": "",
    "IsLockedOut": false,
    "RequiresMultiFactor": false,
    "Links": [
      {
        "HRef": "",
        "Relation": ""
      }
    ],
    "FirstName": "",
    "LastName": "",
    "FullName": "",
    "Password": "",
    "DisplayUserName": "",
    "ForeignKey": "",
    "Name": "",
    "AuthenticationType": "",
    "IsAuthenticated": false,
    "IsDeleted": false,
    "PinAuthentication": {},
    "TimeZone": "",
    "Authentication": {},
    "ApiKey": "",
    "FinancialInstitution": "",
    "GPinKey": "",
    "IsUserTeller": false,
    "IsDemo": false,
    "IsForcePasswordChange": false,
    "IsUserFIAdmin": false,
    "IsPasswordExpired": false,
    "GPinKeyMask": "",
    "PinEnabled": false,
    "SelectedTheme": "",
    "IsSSO": false,
    "CurrentTheme": "",
    "LimitId": "",
    "IsPictureTipsHidden": false,
    "HasAcceptedDisclaimer": false,
    "DefaultFlexPayView": "",
    "UseNewUi": false,
    "IsDisabled": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
fiName			path	string
foreignkey			query	string

get /fis/{fiName}/users/{userName}

Calls UserByFIHandler.Get

Implementation Notes

Uri template /fis/{fiName}/users/{userName}

Response Class

Allied.Domain.DTOs.User {

Id (string, optional): Guid,

UserName (string, optional): String,

Roles (array[], optional): IEnumerable[System.String],

Identity (System.Security.Principal.IIdentity, optional): IIdentity,

PhoneNumbers (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber],

FinancialInstitutionId (string, optional): Guid,

Domain (string, optional): String,

CustomerId (string, optional): Guid,

HasGoogleAuth (boolean, optional): Boolean,

IsEnrolled (boolean, optional): Boolean,

EmailAddress (string, optional): String,

IsLockedOut (boolean, optional): Boolean,

RequiresMultiFactor (boolean, optional): Boolean,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

FirstName (string, optional): String,

LastName (string, optional): String,

FullName (string, optional): String,

Password (string, optional): String,

DisplayUserName (string, optional): String,

ForeignKey (string, optional): String,

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean,

IsDeleted (boolean, optional): Boolean,

PinAuthentication (Allied.Core.Security.IPasswordAuthentication, optional): IPasswordAuthentication,

TimeZone (string, optional): String,

Authentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

ApiKey (string, optional): String,

FinancialInstitution (string, optional): Guid,

GPinKey (string, optional): String,

IsUserTeller (boolean, optional): Boolean,

IsDemo (boolean, optional): Boolean,

IsForcePasswordChange (boolean, optional): Boolean,

IsUserFIAdmin (boolean, optional): Boolean,

IsPasswordExpired (boolean, optional): Boolean,

GPinKeyMask (string, optional): String,

PinEnabled (boolean, optional): Boolean,

SelectedTheme (string, optional): String,

IsSSO (boolean, optional): Boolean,

CurrentTheme (string, optional): String,

LimitId (string, optional): Guid,

IsPictureTipsHidden (boolean, optional): Boolean,

HasAcceptedDisclaimer (boolean, optional): Boolean,

DefaultFlexPayView (string, optional): String,

UseNewUi (boolean, optional): Boolean,

IsDisabled (boolean, optional): Boolean

}
System.Security.Principal.IIdentity {

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean

}
Allied.Domain.DTOs.PhoneNumber {

Id (string, optional): Guid,

Name (string, optional): String,

Number (string, optional): String,

IsEnabled (boolean, optional): Boolean,

IsVerified (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

VerificationCode (string, optional): String,

PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes,

IsTextCapable (boolean, optional): Boolean

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}
Allied.Core.Security.IPasswordAuthentication {

}

{
    "Id": "",
    "UserName": "",
    "Roles": [
      ""
    ],
    "Identity": {
      "Name": "",
      "AuthenticationType": "",
      "IsAuthenticated": false
    },
    "PhoneNumbers": [
      {
        "Id": "",
        "Name": "",
        "Number": "",
        "IsEnabled": false,
        "IsVerified": false,
        "IsDefault": false,
        "VerificationCode": "",
        "PhoneType": "",
        "IsTextCapable": false
      }
    ],
    "FinancialInstitutionId": "",
    "Domain": "",
    "CustomerId": "",
    "HasGoogleAuth": false,
    "IsEnrolled": false,
    "EmailAddress": "",
    "IsLockedOut": false,
    "RequiresMultiFactor": false,
    "Links": [
      {
        "HRef": "",
        "Relation": ""
      }
    ],
    "FirstName": "",
    "LastName": "",
    "FullName": "",
    "Password": "",
    "DisplayUserName": "",
    "ForeignKey": "",
    "Name": "",
    "AuthenticationType": "",
    "IsAuthenticated": false,
    "IsDeleted": false,
    "PinAuthentication": {},
    "TimeZone": "",
    "Authentication": {},
    "ApiKey": "",
    "FinancialInstitution": "",
    "GPinKey": "",
    "IsUserTeller": false,
    "IsDemo": false,
    "IsForcePasswordChange": false,
    "IsUserFIAdmin": false,
    "IsPasswordExpired": false,
    "GPinKeyMask": "",
    "PinEnabled": false,
    "SelectedTheme": "",
    "IsSSO": false,
    "CurrentTheme": "",
    "LimitId": "",
    "IsPictureTipsHidden": false,
    "HasAcceptedDisclaimer": false,
    "DefaultFlexPayView": "",
    "UseNewUi": false,
    "IsDisabled": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
fiName			path	string
userName			path	string

get /fis/{fiName}/users

Calls UsersByFINameHandler.Get

post /fis/{fiName}/users

Calls UsersByFINameHandler.Post

Implementation Notes

Uri template /fis/{fiName}/users

Response Class

Allied.Domain.DTOs.User {

Id (string, optional): Guid,

UserName (string, optional): String,

Roles (array[], optional): IEnumerable[System.String],

Identity (System.Security.Principal.IIdentity, optional): IIdentity,

PhoneNumbers (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber],

FinancialInstitutionId (string, optional): Guid,

Domain (string, optional): String,

CustomerId (string, optional): Guid,

HasGoogleAuth (boolean, optional): Boolean,

IsEnrolled (boolean, optional): Boolean,

EmailAddress (string, optional): String,

IsLockedOut (boolean, optional): Boolean,

RequiresMultiFactor (boolean, optional): Boolean,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

FirstName (string, optional): String,

LastName (string, optional): String,

FullName (string, optional): String,

Password (string, optional): String,

DisplayUserName (string, optional): String,

ForeignKey (string, optional): String,

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean,

IsDeleted (boolean, optional): Boolean,

PinAuthentication (Allied.Core.Security.IPasswordAuthentication, optional): IPasswordAuthentication,

TimeZone (string, optional): String,

Authentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication,

ApiKey (string, optional): String,

FinancialInstitution (string, optional): Guid,

GPinKey (string, optional): String,

IsUserTeller (boolean, optional): Boolean,

IsDemo (boolean, optional): Boolean,

IsForcePasswordChange (boolean, optional): Boolean,

IsUserFIAdmin (boolean, optional): Boolean,

IsPasswordExpired (boolean, optional): Boolean,

GPinKeyMask (string, optional): String,

PinEnabled (boolean, optional): Boolean,

SelectedTheme (string, optional): String,

IsSSO (boolean, optional): Boolean,

CurrentTheme (string, optional): String,

LimitId (string, optional): Guid,

IsPictureTipsHidden (boolean, optional): Boolean,

HasAcceptedDisclaimer (boolean, optional): Boolean,

DefaultFlexPayView (string, optional): String,

UseNewUi (boolean, optional): Boolean,

IsDisabled (boolean, optional): Boolean

}
System.Security.Principal.IIdentity {

Name (string, optional): String,

AuthenticationType (string, optional): String,

IsAuthenticated (boolean, optional): Boolean

}
Allied.Domain.DTOs.PhoneNumber {

Id (string, optional): Guid,

Name (string, optional): String,

Number (string, optional): String,

IsEnabled (boolean, optional): Boolean,

IsVerified (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

VerificationCode (string, optional): String,

PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes,

IsTextCapable (boolean, optional): Boolean

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}
Allied.Core.Security.IPasswordAuthentication {

}

{
    "Id": "",
    "UserName": "",
    "Roles": [
      ""
    ],
    "Identity": {
      "Name": "",
      "AuthenticationType": "",
      "IsAuthenticated": false
    },
    "PhoneNumbers": [
      {
        "Id": "",
        "Name": "",
        "Number": "",
        "IsEnabled": false,
        "IsVerified": false,
        "IsDefault": false,
        "VerificationCode": "",
        "PhoneType": "",
        "IsTextCapable": false
      }
    ],
    "FinancialInstitutionId": "",
    "Domain": "",
    "CustomerId": "",
    "HasGoogleAuth": false,
    "IsEnrolled": false,
    "EmailAddress": "",
    "IsLockedOut": false,
    "RequiresMultiFactor": false,
    "Links": [
      {
        "HRef": "",
        "Relation": ""
      }
    ],
    "FirstName": "",
    "LastName": "",
    "FullName": "",
    "Password": "",
    "DisplayUserName": "",
    "ForeignKey": "",
    "Name": "",
    "AuthenticationType": "",
    "IsAuthenticated": false,
    "IsDeleted": false,
    "PinAuthentication": {},
    "TimeZone": "",
    "Authentication": {},
    "ApiKey": "",
    "FinancialInstitution": "",
    "GPinKey": "",
    "IsUserTeller": false,
    "IsDemo": false,
    "IsForcePasswordChange": false,
    "IsUserFIAdmin": false,
    "IsPasswordExpired": false,
    "GPinKeyMask": "",
    "PinEnabled": false,
    "SelectedTheme": "",
    "IsSSO": false,
    "CurrentTheme": "",
    "LimitId": "",
    "IsPictureTipsHidden": false,
    "HasAcceptedDisclaimer": false,
    "DefaultFlexPayView": "",
    "UseNewUi": false,
    "IsDisabled": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
fiName			path	string
body	Parameter content type:		body	Model Model Schema Allied.Services.REST.Handlers.UserQueryPost { } `{}` Click to set as parameter value

get /fis/{fiId}/users

Calls UsersByFIHandler.Search

payments : payments

get /payments

Calls PaymentSearchStrategy.Get

Implementation Notes

Uri template /payments?$top={top}&$page={page}&$orderby={orderby}&$orderbyDirection={orderbyDirection}&startDate={startDate}&endDate={endDate}&paymentDate={paymentDate}&expectedDate={expectedDate}&userName={tellerName}&customerName={customerName}&phone={phone}&account={account}&payFromAccount={payFromAccount}&paymentAmount={paymentAmount}&startAmount={startAmount}&endAmount={endAmount}&payeeName={payeeName}&fundingSource={fundingSource}&teller={teller}&memo={memo}&origin={origin}&payorName={payorName}&paymentType={paymentType}&status={status}&paymentCategory={paymentCategory}&statusType={statusType}&confirmationNumber={confirmationNumber}&paymentMethod={paymentMethod}&feeAmount={feeAmount}&customerFee={customerFee}&financialInstitutionName={financialInstitutionName}&achPattern={achPattern}&templateType={templateType}&customerId={customerId}&queryType={queryType}&fiId={fiId}&financialInstitution={fi}&createBy={createBy}&reportName={reportName}&checkNumber={checkNumber}&paymentTemplateId={templateId}&branchId={branchId}&shardKey={shardKey}

Response Class

ResourceCollectionOfPayment {

Next (Allied.Core.Collections.Link, optional): Link,

Previous (Allied.Core.Collections.Link[Allied.Core.Collections.Link], optional): Link,

ApproxCount (integer, optional): Int64,

Resources (array[Allied.Domain.DTOs.Payment], optional): IEnumerable[Allied.Domain.DTOs.Payment],

ActualPageSize (integer, optional): Int32,

PageSize (integer, optional): Int32,

Page (integer, optional): Int32,

PageCount (integer, optional): Int64

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}
Allied.Domain.DTOs.Payment {

Id (string, optional): Guid,

AddressError (string, optional): String,

Amount (number, optional): Double,

BankUserId (string, optional): String,

BatchTimeStamp (string, optional): DateTime,

CheckDig (string, optional): String,

ConfirmationNumber (string, optional): String,

CreateBy (string, optional): String,

CreateOn (string, optional): DateTime,

CutOff (string, optional): DateTime,

DeliveryPoint (string, optional): String,

Email (string, optional): String,

IsExpedited (boolean, optional): Boolean,

Memo (string, optional): String,

ModifyBy (string, optional): String,

ModifyOn (string, optional): DateTime,

NetworkBillerId (string, optional): String,

PayeeId (integer, optional): Int32,

PayFrom (string, optional): String,

PayFromAccount (string, optional): String,

PayFromRtn (string, optional): String,

PaymentDate (string, optional): DateTime,

PayToAccount (string, optional): String,

PayToAddress (string, optional): String,

PayToAddress2 (string, optional): String,

PayToCity (string, optional): String,

PayToName (string, optional): String,

PayToState (string, optional): String,

PayToZip (string, optional): String,

Status (string, optional): String,

AchPattern (string, optional): String,

CustomerAddress1 (string, optional): String,

CustomerAddress2 (string, optional): String,

CustomerAddress3 (string, optional): String,

CustomerAddress4 (string, optional): String,

PayToPhone (string, optional): String,

SettlementType (string, optional): String,

SettlementSubType (string, optional): String,

Biller_Id (string, optional): Guid,

Network_Id (string, optional): Guid,

AggregateRootId (string, optional): Guid,

PaymentMethod (string, optional): String,

Fee (number, optional): Double,

Teller (string, optional): String,

PaymentType (string, optional): String,

FinancialInstitution_Id (string, optional): Guid,

PaymentBatch_Id (string, optional): Guid,

ShardKey (string, optional): String,

Customer_Id (string, optional): Guid,

CheckNumber (string, optional): String,

BankAccountType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes,

PayToBankRoutingNumber (string, optional): String,

PayToBankAccount (string, optional): String,

PayToBankAccountType (string, optional): String,

NetworkName (string, optional): String,

PlanetCodes (array[Allied.Domain.DTOs.PlanetCode], optional): IEnumerable[Allied.Domain.DTOs.PlanetCode],

PayToBankAccountOwner (string, optional): String,

DisplayName (string, optional): String,

PaymentTemplateId (string, optional): Guid,

CreditDate (string, optional): DateTime,

FloatDays (integer, optional): Int32,

IsRecurring (boolean, optional): Boolean,

BankAccountDisplayName (string, optional): String,

ExpectedDeliveryDate (string, optional): DateTime,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

PaymentCategory (string, optional): String,

InvoiceData (string, optional): String,

TemplateType (string, optional): String,

IsReviewed (boolean, optional): Boolean,

IsNoticeSent (boolean, optional): Boolean,

SettlementDate (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

NetworkSendDate (string, optional): DateTime,

PromiseDate (string, optional): DateTime,

PictureId (string, optional): Guid,

CollectionBatch_Id (string, optional): Guid,

SettlementBatch_Id (string, optional): Guid,

NetworkSendBatch_Id (string, optional): Guid,

IsNextCreated (boolean, optional): Boolean,

UserId (string, optional): Guid,

DeliveryOptionId (string, optional): Guid,

DeliveryOptionName (string, optional): String,

Corrected (boolean, optional): Boolean,

Alert (boolean, optional): Boolean,

IsLocked (boolean, optional): Boolean,

IsLockedBy (string, optional): String,

LockExpiresOn (string, optional): DateTime,

StatusReason (string, optional): String,

ProcessingStartDate (string, optional): DateTime,

ProcessingEndDate (string, optional): DateTime,

CustomerFee (number, optional): Decimal,

ReviewBy (string, optional): String,

PrintOnCheck (boolean, optional): Boolean,

IsPaperPaymentReviewed (boolean, optional): Boolean,

ReverseToCustomer (boolean, optional): Boolean,

IsBookmarked (boolean, optional): Boolean,

IsValidated (boolean, optional): Boolean,

HidePayment (boolean, optional): Boolean,

BranchId (string, optional): Guid,

InvoiceNumber (string, optional): String,

BranchName (string, optional): String,

IsRealTime (boolean, optional): Boolean,

SentToNetworkOn (string, optional): DateTime,

SentToNetworkName (string, optional): String,

SentToNetworkId (string, optional): Guid,

SentToNetworkResponse (string, optional): String,

SentToNetworkWasSuccessful (boolean, optional): Boolean,

ForeignPaymentId (string, optional): String,

ForeignSystem (string, optional): String,

PayFromEmail (string, optional): String,

PayFromPhone (string, optional): String,

PayFromBankAccountDescription (string, optional): String,

OverrideCheckRoutingNumber (string, optional): String,

OverrideCheckAccountNumber (string, optional): String,

CollectionType (string, optional): String,

P2PPayToEmailAddress (string, optional): String,

P2PPayToPhoneNumber (string, optional): String,

Secret (string, optional): String,

FundingSource (string, optional): String,

SecOverride (string, optional): String,

P2PStatus (string, optional): String,

P2PExpiresOn (string, optional): DateTime,

PayFromAccountName (string, optional): String,

FusePayCbToken (string, optional): String,

PayFromAccountCategory (string, optional): String,

PayToAccountCategory (string, optional): String,

PayFromAccountDisplayName (string, optional): String,

TabaPayToken (string, optional): String

}
Allied.Domain.DTOs.PlanetCode {

Id (string, optional): Guid,

PieceId (string, optional): String,

ScanTime (string, optional): DateTime,

ScanCity (string, optional): String,

ScanState (string, optional): String,

ScanDescription (string, optional): String,

CreatedOn (string, optional): DateTime,

Zip (string, optional): String,

ScanZip (string, optional): String

}

{
    "Next": {
      "HRef": "",
      "Relation": ""
    },
    "Previous": {
      "HRef": "",
      "Relation": ""
    },
    "ApproxCount": 0,
    "Resources": [
      {
        "Id": "",
        "AddressError": "",
        "Amount": 0,
        "BankUserId": "",
        "BatchTimeStamp": "",
        "CheckDig": "",
        "ConfirmationNumber": "",
        "CreateBy": "",
        "CreateOn": "",
        "CutOff": "",
        "DeliveryPoint": "",
        "Email": "",
        "IsExpedited": false,
        "Memo": "",
        "ModifyBy": "",
        "ModifyOn": "",
        "NetworkBillerId": "",
        "PayeeId": 0,
        "PayFrom": "",
        "PayFromAccount": "",
        "PayFromRtn": "",
        "PaymentDate": "",
        "PayToAccount": "",
        "PayToAddress": "",
        "PayToAddress2": "",
        "PayToCity": "",
        "PayToName": "",
        "PayToState": "",
        "PayToZip": "",
        "Status": "",
        "AchPattern": "",
        "CustomerAddress1": "",
        "CustomerAddress2": "",
        "CustomerAddress3": "",
        "CustomerAddress4": "",
        "PayToPhone": "",
        "SettlementType": "",
        "SettlementSubType": "",
        "Biller_Id": "",
        "Network_Id": "",
        "AggregateRootId": "",
        "PaymentMethod": "",
        "Fee": 0,
        "Teller": "",
        "PaymentType": "",
        "FinancialInstitution_Id": "",
        "PaymentBatch_Id": "",
        "ShardKey": "",
        "Customer_Id": "",
        "CheckNumber": "",
        "BankAccountType": "",
        "PayToBankRoutingNumber": "",
        "PayToBankAccount": "",
        "PayToBankAccountType": "",
        "NetworkName": "",
        "PlanetCodes": [
          {
            "Id": "",
            "PieceId": "",
            "ScanTime": "",
            "ScanCity": "",
            "ScanState": "",
            "ScanDescription": "",
            "CreatedOn": "",
            "Zip": "",
            "ScanZip": ""
          }
        ],
        "PayToBankAccountOwner": "",
        "DisplayName": "",
        "PaymentTemplateId": "",
        "CreditDate": "",
        "FloatDays": 0,
        "IsRecurring": false,
        "BankAccountDisplayName": "",
        "ExpectedDeliveryDate": "",
        "Links": [
          {
            "HRef": "",
            "Relation": ""
          }
        ],
        "PaymentCategory": "",
        "InvoiceData": "",
        "TemplateType": "",
        "IsReviewed": false,
        "IsNoticeSent": false,
        "SettlementDate": "",
        "CollectionDate": "",
        "NetworkSendDate": "",
        "PromiseDate": "",
        "PictureId": "",
        "CollectionBatch_Id": "",
        "SettlementBatch_Id": "",
        "NetworkSendBatch_Id": "",
        "IsNextCreated": false,
        "UserId": "",
        "DeliveryOptionId": "",
        "DeliveryOptionName": "",
        "Corrected": false,
        "Alert": false,
        "IsLocked": false,
        "IsLockedBy": "",
        "LockExpiresOn": "",
        "StatusReason": "",
        "ProcessingStartDate": "",
        "ProcessingEndDate": "",
        "CustomerFee": 0,
        "ReviewBy": "",
        "PrintOnCheck": false,
        "IsPaperPaymentReviewed": false,
        "ReverseToCustomer": false,
        "IsBookmarked": false,
        "IsValidated": false,
        "HidePayment": false,
        "BranchId": "",
        "InvoiceNumber": "",
        "BranchName": "",
        "IsRealTime": false,
        "SentToNetworkOn": "",
        "SentToNetworkName": "",
        "SentToNetworkId": "",
        "SentToNetworkResponse": "",
        "SentToNetworkWasSuccessful": false,
        "ForeignPaymentId": "",
        "ForeignSystem": "",
        "PayFromEmail": "",
        "PayFromPhone": "",
        "PayFromBankAccountDescription": "",
        "OverrideCheckRoutingNumber": "",
        "OverrideCheckAccountNumber": "",
        "CollectionType": "",
        "P2PPayToEmailAddress": "",
        "P2PPayToPhoneNumber": "",
        "Secret": "",
        "FundingSource": "",
        "SecOverride": "",
        "P2PStatus": "",
        "P2PExpiresOn": "",
        "PayFromAccountName": "",
        "FusePayCbToken": "",
        "PayFromAccountCategory": "",
        "PayToAccountCategory": "",
        "PayFromAccountDisplayName": "",
        "TabaPayToken": ""
      }
    ],
    "ActualPageSize": 0,
    "PageSize": 0,
    "Page": 0,
    "PageCount": 0
  }

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
$top	query	integer
$page	query	integer
orderBy	query	string
orderByDirection	query	string
startDate	query	string
endDate	query	string
paymentDate	query	string
expectedDate	query	string
userName	query	string
customerName	query	string
phone	query	string
account	query	string
payFromAccount	query	string
paymentAmount	query	number
startAmount	query	string
endAmount	query	string
payeeName	query	string
payorName	query	string
paymentType	query	string
status	query	string
paymentCategory	query	string
statusType	query	string
paymentStatus	query	string
confirmationNumber	query	string
paymentMethod	query	string
feeAmount	query	number
customerFee	query	string
financialInstitutionName	query	string
achPattern	query	string
templateType	query	string
financialInstitution	query	string
customerId	query	string
queryType	query	string
fiId	query	string
financialInstitution	query	string
createBy	query	string
reportName	query	string
checkNumber	query	string
paymentTemplateId	query	string
branchId	query	string
shardKey	query	string
fundingSource	query	string
teller	query	string
memo	query	string
origin	query	string

post /payments

Calls PaymentSearchStrategy.PostRequest

Implementation Notes

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.ACHPaymentRequest { Amount (number, optional): Double, PaymentDate (string, optional): DateTime, PaymentTemplateId (string, optional): Guid, IsRecurring (boolean, optional): Boolean, DeliveryOptionId (string, optional): Guid, InvoiceData (string, optional): String, Memo (string, optional): String, PictureId (string, optional): Guid, DateCalculationStrategy (string, optional) = ['UseFI' or 'DeliveryDate' or 'SendOnDate']: DateCalculations, ConfirmationNumber (string, optional): String, ACHPattern (string, optional): String, BranchId (string, optional): Guid, Teller (string, optional): String, CardInfo (Allied.Domain.Resources.ACHPaymentRequest+CreditCardInfo, optional): CreditCardInfo, BankAccountId (string, optional): Guid, PaymentId (string, optional): Guid, InitialStatus (string, optional): String, CreditingA2APaymentTemplateId (string, optional): Guid } Allied.Domain.Resources.ACHPaymentRequest+CreditCardInfo { CreditCardNumber (string, optional): String, ExpirationDate (string, optional): String, CVV (string, optional): String } `{ "Amount": 0, "PaymentDate": "", "PaymentTemplateId": "", "IsRecurring": false, "DeliveryOptionId": "", "InvoiceData": "", "Memo": "", "PictureId": "", "DateCalculationStrategy": "", "ConfirmationNumber": "", "ACHPattern": "", "BranchId": "", "Teller": "", "CardInfo": { "CreditCardNumber": "", "ExpirationDate": "", "CVV": "" }, "BankAccountId": "", "PaymentId": "", "InitialStatus": "", "CreditingA2APaymentTemplateId": "" }` Click to set as parameter value

get /payments/{id}

Calls PaymentHandlerStrategy.GetByPaymentId

Implementation Notes

Uri template /payments/{id}

Response Class

Allied.Domain.DTOs.Payment {

Id (string, optional): Guid,

AddressError (string, optional): String,

Amount (number, optional): Double,

BankUserId (string, optional): String,

BatchTimeStamp (string, optional): DateTime,

CheckDig (string, optional): String,

ConfirmationNumber (string, optional): String,

CreateBy (string, optional): String,

CreateOn (string, optional): DateTime,

CutOff (string, optional): DateTime,

DeliveryPoint (string, optional): String,

Email (string, optional): String,

IsExpedited (boolean, optional): Boolean,

Memo (string, optional): String,

ModifyBy (string, optional): String,

ModifyOn (string, optional): DateTime,

NetworkBillerId (string, optional): String,

PayeeId (integer, optional): Int32,

PayFrom (string, optional): String,

PayFromAccount (string, optional): String,

PayFromRtn (string, optional): String,

PaymentDate (string, optional): DateTime,

PayToAccount (string, optional): String,

PayToAddress (string, optional): String,

PayToAddress2 (string, optional): String,

PayToCity (string, optional): String,

PayToName (string, optional): String,

PayToState (string, optional): String,

PayToZip (string, optional): String,

Status (string, optional): String,

AchPattern (string, optional): String,

CustomerAddress1 (string, optional): String,

CustomerAddress2 (string, optional): String,

CustomerAddress3 (string, optional): String,

CustomerAddress4 (string, optional): String,

PayToPhone (string, optional): String,

SettlementType (string, optional): String,

SettlementSubType (string, optional): String,

Biller_Id (string, optional): Guid,

Network_Id (string, optional): Guid,

AggregateRootId (string, optional): Guid,

PaymentMethod (string, optional): String,

Fee (number, optional): Double,

Teller (string, optional): String,

PaymentType (string, optional): String,

FinancialInstitution_Id (string, optional): Guid,

PaymentBatch_Id (string, optional): Guid,

ShardKey (string, optional): String,

Customer_Id (string, optional): Guid,

CheckNumber (string, optional): String,

BankAccountType (string, optional) = ['Personal' or 'Business']: AccountOwnerTypes,

PayToBankRoutingNumber (string, optional): String,

PayToBankAccount (string, optional): String,

PayToBankAccountType (string, optional): String,

NetworkName (string, optional): String,

PlanetCodes (array[Allied.Domain.DTOs.PlanetCode], optional): IEnumerable[Allied.Domain.DTOs.PlanetCode],

PayToBankAccountOwner (string, optional): String,

DisplayName (string, optional): String,

PaymentTemplateId (string, optional): Guid,

CreditDate (string, optional): DateTime,

FloatDays (integer, optional): Int32,

IsRecurring (boolean, optional): Boolean,

BankAccountDisplayName (string, optional): String,

ExpectedDeliveryDate (string, optional): DateTime,

Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link],

PaymentCategory (string, optional): String,

InvoiceData (string, optional): String,

TemplateType (string, optional): String,

IsReviewed (boolean, optional): Boolean,

IsNoticeSent (boolean, optional): Boolean,

SettlementDate (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

NetworkSendDate (string, optional): DateTime,

PromiseDate (string, optional): DateTime,

PictureId (string, optional): Guid,

CollectionBatch_Id (string, optional): Guid,

SettlementBatch_Id (string, optional): Guid,

NetworkSendBatch_Id (string, optional): Guid,

IsNextCreated (boolean, optional): Boolean,

UserId (string, optional): Guid,

DeliveryOptionId (string, optional): Guid,

DeliveryOptionName (string, optional): String,

Corrected (boolean, optional): Boolean,

Alert (boolean, optional): Boolean,

IsLocked (boolean, optional): Boolean,

IsLockedBy (string, optional): String,

LockExpiresOn (string, optional): DateTime,

StatusReason (string, optional): String,

ProcessingStartDate (string, optional): DateTime,

ProcessingEndDate (string, optional): DateTime,

CustomerFee (number, optional): Decimal,

ReviewBy (string, optional): String,

PrintOnCheck (boolean, optional): Boolean,

IsPaperPaymentReviewed (boolean, optional): Boolean,

ReverseToCustomer (boolean, optional): Boolean,

IsBookmarked (boolean, optional): Boolean,

IsValidated (boolean, optional): Boolean,

HidePayment (boolean, optional): Boolean,

BranchId (string, optional): Guid,

InvoiceNumber (string, optional): String,

BranchName (string, optional): String,

IsRealTime (boolean, optional): Boolean,

SentToNetworkOn (string, optional): DateTime,

SentToNetworkName (string, optional): String,

SentToNetworkId (string, optional): Guid,

SentToNetworkResponse (string, optional): String,

SentToNetworkWasSuccessful (boolean, optional): Boolean,

ForeignPaymentId (string, optional): String,

ForeignSystem (string, optional): String,

PayFromEmail (string, optional): String,

PayFromPhone (string, optional): String,

PayFromBankAccountDescription (string, optional): String,

OverrideCheckRoutingNumber (string, optional): String,

OverrideCheckAccountNumber (string, optional): String,

CollectionType (string, optional): String,

P2PPayToEmailAddress (string, optional): String,

P2PPayToPhoneNumber (string, optional): String,

Secret (string, optional): String,

FundingSource (string, optional): String,

SecOverride (string, optional): String,

P2PStatus (string, optional): String,

P2PExpiresOn (string, optional): DateTime,

PayFromAccountName (string, optional): String,

FusePayCbToken (string, optional): String,

PayFromAccountCategory (string, optional): String,

PayToAccountCategory (string, optional): String,

PayFromAccountDisplayName (string, optional): String,

TabaPayToken (string, optional): String

}
Allied.Domain.DTOs.PlanetCode {

Id (string, optional): Guid,

PieceId (string, optional): String,

ScanTime (string, optional): DateTime,

ScanCity (string, optional): String,

ScanState (string, optional): String,

ScanDescription (string, optional): String,

CreatedOn (string, optional): DateTime,

Zip (string, optional): String,

ScanZip (string, optional): String

}
Allied.Core.Collections.Link {

HRef (string, optional): Uri,

Relation (string, optional): String

}

{
    "Id": "",
    "AddressError": "",
    "Amount": 0,
    "BankUserId": "",
    "BatchTimeStamp": "",
    "CheckDig": "",
    "ConfirmationNumber": "",
    "CreateBy": "",
    "CreateOn": "",
    "CutOff": "",
    "DeliveryPoint": "",
    "Email": "",
    "IsExpedited": false,
    "Memo": "",
    "ModifyBy": "",
    "ModifyOn": "",
    "NetworkBillerId": "",
    "PayeeId": 0,
    "PayFrom": "",
    "PayFromAccount": "",
    "PayFromRtn": "",
    "PaymentDate": "",
    "PayToAccount": "",
    "PayToAddress": "",
    "PayToAddress2": "",
    "PayToCity": "",
    "PayToName": "",
    "PayToState": "",
    "PayToZip": "",
    "Status": "",
    "AchPattern": "",
    "CustomerAddress1": "",
    "CustomerAddress2": "",
    "CustomerAddress3": "",
    "CustomerAddress4": "",
    "PayToPhone": "",
    "SettlementType": "",
    "SettlementSubType": "",
    "Biller_Id": "",
    "Network_Id": "",
    "AggregateRootId": "",
    "PaymentMethod": "",
    "Fee": 0,
    "Teller": "",
    "PaymentType": "",
    "FinancialInstitution_Id": "",
    "PaymentBatch_Id": "",
    "ShardKey": "",
    "Customer_Id": "",
    "CheckNumber": "",
    "BankAccountType": "",
    "PayToBankRoutingNumber": "",
    "PayToBankAccount": "",
    "PayToBankAccountType": "",
    "NetworkName": "",
    "PlanetCodes": [
      {
        "Id": "",
        "PieceId": "",
        "ScanTime": "",
        "ScanCity": "",
        "ScanState": "",
        "ScanDescription": "",
        "CreatedOn": "",
        "Zip": "",
        "ScanZip": ""
      }
    ],
    "PayToBankAccountOwner": "",
    "DisplayName": "",
    "PaymentTemplateId": "",
    "CreditDate": "",
    "FloatDays": 0,
    "IsRecurring": false,
    "BankAccountDisplayName": "",
    "ExpectedDeliveryDate": "",
    "Links": [
      {
        "HRef": "",
        "Relation": ""
      }
    ],
    "PaymentCategory": "",
    "InvoiceData": "",
    "TemplateType": "",
    "IsReviewed": false,
    "IsNoticeSent": false,
    "SettlementDate": "",
    "CollectionDate": "",
    "NetworkSendDate": "",
    "PromiseDate": "",
    "PictureId": "",
    "CollectionBatch_Id": "",
    "SettlementBatch_Id": "",
    "NetworkSendBatch_Id": "",
    "IsNextCreated": false,
    "UserId": "",
    "DeliveryOptionId": "",
    "DeliveryOptionName": "",
    "Corrected": false,
    "Alert": false,
    "IsLocked": false,
    "IsLockedBy": "",
    "LockExpiresOn": "",
    "StatusReason": "",
    "ProcessingStartDate": "",
    "ProcessingEndDate": "",
    "CustomerFee": 0,
    "ReviewBy": "",
    "PrintOnCheck": false,
    "IsPaperPaymentReviewed": false,
    "ReverseToCustomer": false,
    "IsBookmarked": false,
    "IsValidated": false,
    "HidePayment": false,
    "BranchId": "",
    "InvoiceNumber": "",
    "BranchName": "",
    "IsRealTime": false,
    "SentToNetworkOn": "",
    "SentToNetworkName": "",
    "SentToNetworkId": "",
    "SentToNetworkResponse": "",
    "SentToNetworkWasSuccessful": false,
    "ForeignPaymentId": "",
    "ForeignSystem": "",
    "PayFromEmail": "",
    "PayFromPhone": "",
    "PayFromBankAccountDescription": "",
    "OverrideCheckRoutingNumber": "",
    "OverrideCheckAccountNumber": "",
    "CollectionType": "",
    "P2PPayToEmailAddress": "",
    "P2PPayToPhoneNumber": "",
    "Secret": "",
    "FundingSource": "",
    "SecOverride": "",
    "P2PStatus": "",
    "P2PExpiresOn": "",
    "PayFromAccountName": "",
    "FusePayCbToken": "",
    "PayFromAccountCategory": "",
    "PayToAccountCategory": "",
    "PayFromAccountDisplayName": "",
    "TabaPayToken": ""
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
id			path	string

patch /payments/{id}

Calls PaymentHandlerStrategy.Patch

Implementation Notes

Uri template /payments/{id}

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
id			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.PaymentPatch { Status (string, optional): String, Amount (number, optional): Double, PaymentDate (string, optional): String, CancelAll (boolean, optional): Boolean, PayFromName (string, optional): String, Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, PostalCode (string, optional): String, State (string, optional): String, DeliveryOptionId (string, optional): Guid, PayFromAccountNumber (string, optional): String, PayFromRoutingNumber (string, optional): String, Memo (string, optional): String } `{ "Status": "", "Amount": 0, "PaymentDate": "", "CancelAll": false, "PayFromName": "", "Address1": "", "Address2": "", "City": "", "PostalCode": "", "State": "", "DeliveryOptionId": "", "PayFromAccountNumber": "", "PayFromRoutingNumber": "", "Memo": "" }` Click to set as parameter value

post /payments/{id}/networkreject

Calls NetworkRejectHandler.Post

Implementation Notes

Uri template /payments/{id}/networkreject

Response Class

System.Void {

}

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
id			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.DTOs.NetworkReject { RejectionCode (string, optional): String, Reason (string, optional): String } `{ "RejectionCode": "", "Reason": "" }` Click to set as parameter value

Response Messages

HTTP Status Code	Reason	Response Model
200
400
404
406
500

post /payments/{paymentId}/cancel

Calls CancelPaymentHandlerStrategy.Post

photos : photos

Implementation Notes

Uri template /photos/{photoId}/status

Response Class

Allied.Domain.ScanPictureRequestTicket {

PictureId (string, optional): Guid,

Status (string, optional): String,

Message (string, optional): String,

ScanStatus (string, optional): String,

Coupon (Allied.Domain.Interfaces.ScanPictureCouponData, optional): ScanPictureCouponData,

PictureSize (integer, optional): Int32,

CreatedOn (string, optional): DateTime,

ProcessingFinished (string, optional): DateTime,

DeliveryOptions (array[Allied.Domain.Services.DeliveryOptionRouteResponse], optional): IEnumerable[Allied.Domain.Services.DeliveryOptionRouteResponse],

GreyScaleImageUri (string, optional): Uri,

OriginalImageUri (string, optional): Uri,

UserName (string, optional): String,

Domain (string, optional): String,

ProcessedOn (string, optional): DateTime,

ProcessingTime (string, optional): TimeSpan,

RawResponse (Allied.Domain.DTOs.PicturePayResponse, optional): PicturePayResponse,

AlliedResponse (Allied.Domain.DTOs.AlliedPicturePayResponse, optional): AlliedPicturePayResponse,

Responses (array[Allied.Domain.DTOs.IPicturePayResponse], optional): IEnumerable[Allied.Domain.DTOs.IPicturePayResponse],

ResultedInPayment (boolean, optional): Boolean,

PaymentId (string, optional): Guid,

Id (string, optional): Guid,

EventSourceId (string, optional): Guid,

Version (integer, optional): Int64,

InitialVersion (integer, optional): Int64

}
Allied.Domain.Interfaces.ScanPictureCouponData {

Address (Allied.Domain.DTOs.Address, optional): Address,

AccountNumber (string, optional): String,

PayeeName (string, optional): String,

DueDate (string, optional): DateTime,

AmountDue (number, optional): Double

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse {

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

Name (string, optional): String,

DeliveryTimeOffset (integer, optional): Int32,

DaysFromScheduleForDate (integer, optional): Int32,

OptionId (string, optional): Guid,

DeliveryOption (Allied.Domain.Entities.DeliveryOption, optional): DeliveryOption,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Priority (integer, optional): Int32,

EarliestDeliveryDate (string, optional): DateTime,

MinimiumScheduledForDate (string, optional): DateTime,

MaximiumScheduledForDate (string, optional): DateTime,

DeliveryDates (array[Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair], optional): IEnumerable[Allied.Domain.Services.DeliveryDatePair],

NetworkBillerId (string, optional): String,

MatchedAccountNumber (string, optional): String,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

Cost (number, optional): Double,

Overrides (Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides, optional): RoutingOverrides,

ViableRoutes (array[Allied.Domain.Services.RouteResponse], optional): IEnumerable[Allied.Domain.Services.RouteResponse],

DeliveryTime (integer, optional): Int32,

BillerClass (string, optional): String,

CorrectedAddress (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

DateCalculation (string, optional): String

}
Allied.Domain.Entities.DeliveryOption {

Id (string, optional): Guid,

AllowedNetworks (array[], optional): IEnumerable[System.Guid],

Description (string, optional): String,

ShippingMethod (string, optional) = ['Standard' or 'NextDay' or 'Expidited' or 'Paper' or 'SameDay']: ShippingMethods,

Floats (Allied.Domain.Entities.Floats, optional): Floats,

MinimiumDeliveryTime (integer, optional): Int32,

MaximiumDeliveryTime (integer, optional): Int32,

CutOff (string, optional): TimeSpan,

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsRealTime (boolean, optional): Boolean,

IsEnabled (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

CalculateMinimiumScheduleForDate (string, optional): String,

DateCalculation (string, optional) = ['UseFI' or 'DeliveryDate' or 'SendOnDate']: DateCalculations,

MaximiumValidFor (string, optional): TimeSpan,

ValidFor (array[], optional): IEnumerable[System.String],

Priority (integer, optional): Int32,

MaxDaysReturned (integer, optional): Int32

}
Allied.Domain.Entities.Floats {

ScheduledForOffset (integer, optional): Int32,

CollectionDateOffset (integer, optional): Int32,

SettlementDateOffset (integer, optional): Int32,

NetworkSendDateOffset (integer, optional): Int32

}
Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair {

ScheduleForDate (string, optional): DateTime,

DeliveryDate (string, optional): DateTime,

DayZero (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

Description1 (string, optional): String,

Description2 (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.Services.RouteResponse {

DeliveryOption (Allied.Domain.INetworkDeliveryOption, optional): INetworkDeliveryOption,

Cost (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DeliveryTime (integer, optional): Int32,

DateTimeCalculation (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

NetworkBillerId (string, optional): String,

AccountNumber (string, optional): String,

CanReverse (boolean, optional): Boolean,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

BillerClass (string, optional): String,

IsSameDay (boolean, optional): Boolean,

CorrectedAddress (Allied.Domain.Address, optional): Address,

MinimiumScheduleForDate (string, optional): DateTime,

MinimiumDeliverByDate (string, optional): DateTime,

Overrides (Allied.Domain.Services.RouteResponse+RoutingOverrides, optional): RoutingOverrides,

NetworkGroupId (string, optional): Guid

}
Allied.Domain.INetworkDeliveryOption {

RouteId (string, optional): Guid,

Cost (number, optional): Double,

DeliveryDateOffset (integer, optional): Int32,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

CutOff (string, optional): TimeSpan,

Name (string, optional): String

}
Allied.Domain.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

State (string, optional): String,

PostalCode (string, optional): String,

Country (string, optional): String,

Id (string, optional): Guid,

Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address

}
Allied.Domain.Services.RouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.DTOs.PicturePayResponse {

IQAFields (array[Allied.Domain.DTOs.IQAField], optional): IEnumerable[Allied.Domain.DTOs.IQAField],

ExtractedFields (array[Allied.Domain.DTOs.ExtractedField], optional): IEnumerable[Allied.Domain.DTOs.ExtractedField],

GreyscaleImageLink (string, optional): String,

OriginalImageLink (string, optional): String,

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData, optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IQAField {

Name (string, optional): String,

Score (integer, optional): Int32,

Threshold (integer, optional): Int32

}
Allied.Domain.DTOs.ExtractedField {

Name (string, optional): String,

Value (string, optional): String,

ValueBest (string, optional): String,

Confidence (integer, optional): Int32

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}
Allied.Domain.DTOs.AlliedPicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IPicturePayResponse {

PictureId (string, optional): Guid,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}

{
    "PictureId": "",
    "Status": "",
    "Message": "",
    "ScanStatus": "",
    "Coupon": {
      "Address": {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "PostalCode": "",
        "State": "",
        "Result": ""
      },
      "AccountNumber": "",
      "PayeeName": "",
      "DueDate": "",
      "AmountDue": 0
    },
    "PictureSize": 0,
    "CreatedOn": "",
    "ProcessingFinished": "",
    "DeliveryOptions": [
      {
        "Fee": 0,
        "IsElectronic": false,
        "IsDefault": false,
        "Name": "",
        "DeliveryTimeOffset": 0,
        "DaysFromScheduleForDate": 0,
        "OptionId": "",
        "DeliveryOption": {
          "Id": "",
          "AllowedNetworks": [
            ""
          ],
          "Description": "",
          "ShippingMethod": "",
          "Floats": {
            "ScheduledForOffset": 0,
            "CollectionDateOffset": 0,
            "SettlementDateOffset": 0,
            "NetworkSendDateOffset": 0
          },
          "MinimiumDeliveryTime": 0,
          "MaximiumDeliveryTime": 0,
          "CutOff": "",
          "Fee": 0,
          "IsElectronic": false,
          "IsRealTime": false,
          "IsEnabled": false,
          "IsDefault": false,
          "CalculateMinimiumScheduleForDate": "",
          "DateCalculation": "",
          "MaximiumValidFor": "",
          "ValidFor": [
            ""
          ],
          "Priority": 0,
          "MaxDaysReturned": 0
        },
        "NetworkId": "",
        "RouteId": "",
        "DateTimeCalculationAlgorithm": "",
        "Priority": 0,
        "EarliestDeliveryDate": "",
        "MinimiumScheduledForDate": "",
        "MaximiumScheduledForDate": "",
        "DeliveryDates": [
          {
            "ScheduleForDate": "",
            "DeliveryDate": "",
            "DayZero": "",
            "CollectionDate": "",
            "Description1": "",
            "Description2": ""
          }
        ],
        "NetworkBillerId": "",
        "MatchedAccountNumber": "",
        "CutOff": "",
        "RouteName": "",
        "Cost": 0,
        "Overrides": {
          "AchPattern": "",
          "DoNotCollect": false,
          "DoNotSettle": false,
          "DoNotNetworkSend": false,
          "Hold": false
        },
        "ViableRoutes": [
          {
            "DeliveryOption": {
              "RouteId": "",
              "Cost": 0,
              "DeliveryDateOffset": 0,
              "DateTimeCalculationAlgorithm": "",
              "CutOff": "",
              "Name": ""
            },
            "Cost": 0,
            "IsElectronic": false,
            "NetworkId": "",
            "RouteId": "",
            "DeliveryTime": 0,
            "DateTimeCalculation": "",
            "NetworkBillerId": "",
            "AccountNumber": "",
            "CanReverse": false,
            "CutOff": "",
            "RouteName": "",
            "BillerClass": "",
            "IsSameDay": false,
            "CorrectedAddress": {
              "Address1": "",
              "Address2": "",
              "City": "",
              "State": "",
              "PostalCode": "",
              "Country": "",
              "Id": "",
              "Empty": "Allied.Domain.Address",
              "Allied": "Allied.Domain.Address"
            },
            "MinimiumScheduleForDate": "",
            "MinimiumDeliverByDate": "",
            "Overrides": {
              "AchPattern": "",
              "DoNotCollect": false,
              "DoNotSettle": false,
              "DoNotNetworkSend": false,
              "Hold": false
            },
            "NetworkGroupId": ""
          }
        ],
        "DeliveryTime": 0,
        "BillerClass": "",
        "CorrectedAddress": {
          "Address1": "",
          "Address2": "",
          "City": "",
          "State": "",
          "PostalCode": "",
          "Country": "",
          "Id": "",
          "Empty": "Allied.Domain.Address",
          "Allied": "Allied.Domain.Address"
        },
        "DateCalculation": ""
      }
    ],
    "GreyScaleImageUri": "",
    "OriginalImageUri": "",
    "UserName": "",
    "Domain": "",
    "ProcessedOn": "",
    "ProcessingTime": "",
    "RawResponse": {
      "IQAFields": [
        {
          "Name": "",
          "Score": 0,
          "Threshold": 0
        }
      ],
      "ExtractedFields": [
        {
          "Name": "",
          "Value": "",
          "ValueBest": "",
          "Confidence": 0
        }
      ],
      "GreyscaleImageLink": "",
      "OriginalImageLink": "",
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "AlliedResponse": {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "Responses": [
      {
        "PictureId": "",
        "Message": "",
        "ScanResponse": "",
        "Data": {
          "PayeeRecipient": "",
          "HighestConfidencePayeeName": ""
        },
        "ProcessingTime": "",
        "Accepted": false
      }
    ],
    "ResultedInPayment": false,
    "PaymentId": "",
    "Id": "",
    "EventSourceId": "",
    "Version": 0,
    "InitialVersion": 0
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status

Calls PictureStatusHandler.GetAlliedStatus

Implementation Notes

Uri template /photos/{photoId}/status

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status

Calls PictureStatusHandler.GetMitekStatus

Implementation Notes

Uri template /photos/{photoId}/status

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status

Calls PictureStatusHandler.GetTisStatus

Implementation Notes

Uri template /photos/{photoId}/status

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status

Calls PictureStatusHandler.GetAll

Implementation Notes

Uri template /photos/{photoId}/status

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

[
    {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    }
  ]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/allied

Calls PictureStatusHandler.Get

Implementation Notes

Uri template /photos/{photoId}/status/allied

Response Class

Allied.Domain.ScanPictureRequestTicket {

PictureId (string, optional): Guid,

Status (string, optional): String,

Message (string, optional): String,

ScanStatus (string, optional): String,

Coupon (Allied.Domain.Interfaces.ScanPictureCouponData, optional): ScanPictureCouponData,

PictureSize (integer, optional): Int32,

CreatedOn (string, optional): DateTime,

ProcessingFinished (string, optional): DateTime,

DeliveryOptions (array[Allied.Domain.Services.DeliveryOptionRouteResponse], optional): IEnumerable[Allied.Domain.Services.DeliveryOptionRouteResponse],

GreyScaleImageUri (string, optional): Uri,

OriginalImageUri (string, optional): Uri,

UserName (string, optional): String,

Domain (string, optional): String,

ProcessedOn (string, optional): DateTime,

ProcessingTime (string, optional): TimeSpan,

RawResponse (Allied.Domain.DTOs.PicturePayResponse, optional): PicturePayResponse,

AlliedResponse (Allied.Domain.DTOs.AlliedPicturePayResponse, optional): AlliedPicturePayResponse,

Responses (array[Allied.Domain.DTOs.IPicturePayResponse], optional): IEnumerable[Allied.Domain.DTOs.IPicturePayResponse],

ResultedInPayment (boolean, optional): Boolean,

PaymentId (string, optional): Guid,

Id (string, optional): Guid,

EventSourceId (string, optional): Guid,

Version (integer, optional): Int64,

InitialVersion (integer, optional): Int64

}
Allied.Domain.Interfaces.ScanPictureCouponData {

Address (Allied.Domain.DTOs.Address, optional): Address,

AccountNumber (string, optional): String,

PayeeName (string, optional): String,

DueDate (string, optional): DateTime,

AmountDue (number, optional): Double

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse {

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

Name (string, optional): String,

DeliveryTimeOffset (integer, optional): Int32,

DaysFromScheduleForDate (integer, optional): Int32,

OptionId (string, optional): Guid,

DeliveryOption (Allied.Domain.Entities.DeliveryOption, optional): DeliveryOption,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Priority (integer, optional): Int32,

EarliestDeliveryDate (string, optional): DateTime,

MinimiumScheduledForDate (string, optional): DateTime,

MaximiumScheduledForDate (string, optional): DateTime,

DeliveryDates (array[Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair], optional): IEnumerable[Allied.Domain.Services.DeliveryDatePair],

NetworkBillerId (string, optional): String,

MatchedAccountNumber (string, optional): String,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

Cost (number, optional): Double,

Overrides (Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides, optional): RoutingOverrides,

ViableRoutes (array[Allied.Domain.Services.RouteResponse], optional): IEnumerable[Allied.Domain.Services.RouteResponse],

DeliveryTime (integer, optional): Int32,

BillerClass (string, optional): String,

CorrectedAddress (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

DateCalculation (string, optional): String

}
Allied.Domain.Entities.DeliveryOption {

Id (string, optional): Guid,

AllowedNetworks (array[], optional): IEnumerable[System.Guid],

Description (string, optional): String,

ShippingMethod (string, optional) = ['Standard' or 'NextDay' or 'Expidited' or 'Paper' or 'SameDay']: ShippingMethods,

Floats (Allied.Domain.Entities.Floats, optional): Floats,

MinimiumDeliveryTime (integer, optional): Int32,

MaximiumDeliveryTime (integer, optional): Int32,

CutOff (string, optional): TimeSpan,

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsRealTime (boolean, optional): Boolean,

IsEnabled (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

CalculateMinimiumScheduleForDate (string, optional): String,

DateCalculation (string, optional) = ['UseFI' or 'DeliveryDate' or 'SendOnDate']: DateCalculations,

MaximiumValidFor (string, optional): TimeSpan,

ValidFor (array[], optional): IEnumerable[System.String],

Priority (integer, optional): Int32,

MaxDaysReturned (integer, optional): Int32

}
Allied.Domain.Entities.Floats {

ScheduledForOffset (integer, optional): Int32,

CollectionDateOffset (integer, optional): Int32,

SettlementDateOffset (integer, optional): Int32,

NetworkSendDateOffset (integer, optional): Int32

}
Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair {

ScheduleForDate (string, optional): DateTime,

DeliveryDate (string, optional): DateTime,

DayZero (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

Description1 (string, optional): String,

Description2 (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.Services.RouteResponse {

DeliveryOption (Allied.Domain.INetworkDeliveryOption, optional): INetworkDeliveryOption,

Cost (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DeliveryTime (integer, optional): Int32,

DateTimeCalculation (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

NetworkBillerId (string, optional): String,

AccountNumber (string, optional): String,

CanReverse (boolean, optional): Boolean,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

BillerClass (string, optional): String,

IsSameDay (boolean, optional): Boolean,

CorrectedAddress (Allied.Domain.Address, optional): Address,

MinimiumScheduleForDate (string, optional): DateTime,

MinimiumDeliverByDate (string, optional): DateTime,

Overrides (Allied.Domain.Services.RouteResponse+RoutingOverrides, optional): RoutingOverrides,

NetworkGroupId (string, optional): Guid

}
Allied.Domain.INetworkDeliveryOption {

RouteId (string, optional): Guid,

Cost (number, optional): Double,

DeliveryDateOffset (integer, optional): Int32,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

CutOff (string, optional): TimeSpan,

Name (string, optional): String

}
Allied.Domain.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

State (string, optional): String,

PostalCode (string, optional): String,

Country (string, optional): String,

Id (string, optional): Guid,

Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address

}
Allied.Domain.Services.RouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.DTOs.PicturePayResponse {

IQAFields (array[Allied.Domain.DTOs.IQAField], optional): IEnumerable[Allied.Domain.DTOs.IQAField],

ExtractedFields (array[Allied.Domain.DTOs.ExtractedField], optional): IEnumerable[Allied.Domain.DTOs.ExtractedField],

GreyscaleImageLink (string, optional): String,

OriginalImageLink (string, optional): String,

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData, optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IQAField {

Name (string, optional): String,

Score (integer, optional): Int32,

Threshold (integer, optional): Int32

}
Allied.Domain.DTOs.ExtractedField {

Name (string, optional): String,

Value (string, optional): String,

ValueBest (string, optional): String,

Confidence (integer, optional): Int32

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}
Allied.Domain.DTOs.AlliedPicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IPicturePayResponse {

PictureId (string, optional): Guid,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}

{
    "PictureId": "",
    "Status": "",
    "Message": "",
    "ScanStatus": "",
    "Coupon": {
      "Address": {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "PostalCode": "",
        "State": "",
        "Result": ""
      },
      "AccountNumber": "",
      "PayeeName": "",
      "DueDate": "",
      "AmountDue": 0
    },
    "PictureSize": 0,
    "CreatedOn": "",
    "ProcessingFinished": "",
    "DeliveryOptions": [
      {
        "Fee": 0,
        "IsElectronic": false,
        "IsDefault": false,
        "Name": "",
        "DeliveryTimeOffset": 0,
        "DaysFromScheduleForDate": 0,
        "OptionId": "",
        "DeliveryOption": {
          "Id": "",
          "AllowedNetworks": [
            ""
          ],
          "Description": "",
          "ShippingMethod": "",
          "Floats": {
            "ScheduledForOffset": 0,
            "CollectionDateOffset": 0,
            "SettlementDateOffset": 0,
            "NetworkSendDateOffset": 0
          },
          "MinimiumDeliveryTime": 0,
          "MaximiumDeliveryTime": 0,
          "CutOff": "",
          "Fee": 0,
          "IsElectronic": false,
          "IsRealTime": false,
          "IsEnabled": false,
          "IsDefault": false,
          "CalculateMinimiumScheduleForDate": "",
          "DateCalculation": "",
          "MaximiumValidFor": "",
          "ValidFor": [
            ""
          ],
          "Priority": 0,
          "MaxDaysReturned": 0
        },
        "NetworkId": "",
        "RouteId": "",
        "DateTimeCalculationAlgorithm": "",
        "Priority": 0,
        "EarliestDeliveryDate": "",
        "MinimiumScheduledForDate": "",
        "MaximiumScheduledForDate": "",
        "DeliveryDates": [
          {
            "ScheduleForDate": "",
            "DeliveryDate": "",
            "DayZero": "",
            "CollectionDate": "",
            "Description1": "",
            "Description2": ""
          }
        ],
        "NetworkBillerId": "",
        "MatchedAccountNumber": "",
        "CutOff": "",
        "RouteName": "",
        "Cost": 0,
        "Overrides": {
          "AchPattern": "",
          "DoNotCollect": false,
          "DoNotSettle": false,
          "DoNotNetworkSend": false,
          "Hold": false
        },
        "ViableRoutes": [
          {
            "DeliveryOption": {
              "RouteId": "",
              "Cost": 0,
              "DeliveryDateOffset": 0,
              "DateTimeCalculationAlgorithm": "",
              "CutOff": "",
              "Name": ""
            },
            "Cost": 0,
            "IsElectronic": false,
            "NetworkId": "",
            "RouteId": "",
            "DeliveryTime": 0,
            "DateTimeCalculation": "",
            "NetworkBillerId": "",
            "AccountNumber": "",
            "CanReverse": false,
            "CutOff": "",
            "RouteName": "",
            "BillerClass": "",
            "IsSameDay": false,
            "CorrectedAddress": {
              "Address1": "",
              "Address2": "",
              "City": "",
              "State": "",
              "PostalCode": "",
              "Country": "",
              "Id": "",
              "Empty": "Allied.Domain.Address",
              "Allied": "Allied.Domain.Address"
            },
            "MinimiumScheduleForDate": "",
            "MinimiumDeliverByDate": "",
            "Overrides": {
              "AchPattern": "",
              "DoNotCollect": false,
              "DoNotSettle": false,
              "DoNotNetworkSend": false,
              "Hold": false
            },
            "NetworkGroupId": ""
          }
        ],
        "DeliveryTime": 0,
        "BillerClass": "",
        "CorrectedAddress": {
          "Address1": "",
          "Address2": "",
          "City": "",
          "State": "",
          "PostalCode": "",
          "Country": "",
          "Id": "",
          "Empty": "Allied.Domain.Address",
          "Allied": "Allied.Domain.Address"
        },
        "DateCalculation": ""
      }
    ],
    "GreyScaleImageUri": "",
    "OriginalImageUri": "",
    "UserName": "",
    "Domain": "",
    "ProcessedOn": "",
    "ProcessingTime": "",
    "RawResponse": {
      "IQAFields": [
        {
          "Name": "",
          "Score": 0,
          "Threshold": 0
        }
      ],
      "ExtractedFields": [
        {
          "Name": "",
          "Value": "",
          "ValueBest": "",
          "Confidence": 0
        }
      ],
      "GreyscaleImageLink": "",
      "OriginalImageLink": "",
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "AlliedResponse": {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "Responses": [
      {
        "PictureId": "",
        "Message": "",
        "ScanResponse": "",
        "Data": {
          "PayeeRecipient": "",
          "HighestConfidencePayeeName": ""
        },
        "ProcessingTime": "",
        "Accepted": false
      }
    ],
    "ResultedInPayment": false,
    "PaymentId": "",
    "Id": "",
    "EventSourceId": "",
    "Version": 0,
    "InitialVersion": 0
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/allied

Calls PictureStatusHandler.GetAlliedStatus

Implementation Notes

Uri template /photos/{photoId}/status/allied

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/allied

Calls PictureStatusHandler.GetMitekStatus

Implementation Notes

Uri template /photos/{photoId}/status/allied

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/allied

Calls PictureStatusHandler.GetTisStatus

Implementation Notes

Uri template /photos/{photoId}/status/allied

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/allied

Calls PictureStatusHandler.GetAll

Implementation Notes

Uri template /photos/{photoId}/status/allied

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

[
    {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    }
  ]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/mitek

Calls PictureStatusHandler.Get

Implementation Notes

Uri template /photos/{photoId}/status/mitek

Response Class

Allied.Domain.ScanPictureRequestTicket {

PictureId (string, optional): Guid,

Status (string, optional): String,

Message (string, optional): String,

ScanStatus (string, optional): String,

Coupon (Allied.Domain.Interfaces.ScanPictureCouponData, optional): ScanPictureCouponData,

PictureSize (integer, optional): Int32,

CreatedOn (string, optional): DateTime,

ProcessingFinished (string, optional): DateTime,

DeliveryOptions (array[Allied.Domain.Services.DeliveryOptionRouteResponse], optional): IEnumerable[Allied.Domain.Services.DeliveryOptionRouteResponse],

GreyScaleImageUri (string, optional): Uri,

OriginalImageUri (string, optional): Uri,

UserName (string, optional): String,

Domain (string, optional): String,

ProcessedOn (string, optional): DateTime,

ProcessingTime (string, optional): TimeSpan,

RawResponse (Allied.Domain.DTOs.PicturePayResponse, optional): PicturePayResponse,

AlliedResponse (Allied.Domain.DTOs.AlliedPicturePayResponse, optional): AlliedPicturePayResponse,

Responses (array[Allied.Domain.DTOs.IPicturePayResponse], optional): IEnumerable[Allied.Domain.DTOs.IPicturePayResponse],

ResultedInPayment (boolean, optional): Boolean,

PaymentId (string, optional): Guid,

Id (string, optional): Guid,

EventSourceId (string, optional): Guid,

Version (integer, optional): Int64,

InitialVersion (integer, optional): Int64

}
Allied.Domain.Interfaces.ScanPictureCouponData {

Address (Allied.Domain.DTOs.Address, optional): Address,

AccountNumber (string, optional): String,

PayeeName (string, optional): String,

DueDate (string, optional): DateTime,

AmountDue (number, optional): Double

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse {

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

Name (string, optional): String,

DeliveryTimeOffset (integer, optional): Int32,

DaysFromScheduleForDate (integer, optional): Int32,

OptionId (string, optional): Guid,

DeliveryOption (Allied.Domain.Entities.DeliveryOption, optional): DeliveryOption,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Priority (integer, optional): Int32,

EarliestDeliveryDate (string, optional): DateTime,

MinimiumScheduledForDate (string, optional): DateTime,

MaximiumScheduledForDate (string, optional): DateTime,

DeliveryDates (array[Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair], optional): IEnumerable[Allied.Domain.Services.DeliveryDatePair],

NetworkBillerId (string, optional): String,

MatchedAccountNumber (string, optional): String,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

Cost (number, optional): Double,

Overrides (Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides, optional): RoutingOverrides,

ViableRoutes (array[Allied.Domain.Services.RouteResponse], optional): IEnumerable[Allied.Domain.Services.RouteResponse],

DeliveryTime (integer, optional): Int32,

BillerClass (string, optional): String,

CorrectedAddress (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

DateCalculation (string, optional): String

}
Allied.Domain.Entities.DeliveryOption {

Id (string, optional): Guid,

AllowedNetworks (array[], optional): IEnumerable[System.Guid],

Description (string, optional): String,

ShippingMethod (string, optional) = ['Standard' or 'NextDay' or 'Expidited' or 'Paper' or 'SameDay']: ShippingMethods,

Floats (Allied.Domain.Entities.Floats, optional): Floats,

MinimiumDeliveryTime (integer, optional): Int32,

MaximiumDeliveryTime (integer, optional): Int32,

CutOff (string, optional): TimeSpan,

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsRealTime (boolean, optional): Boolean,

IsEnabled (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

CalculateMinimiumScheduleForDate (string, optional): String,

DateCalculation (string, optional) = ['UseFI' or 'DeliveryDate' or 'SendOnDate']: DateCalculations,

MaximiumValidFor (string, optional): TimeSpan,

ValidFor (array[], optional): IEnumerable[System.String],

Priority (integer, optional): Int32,

MaxDaysReturned (integer, optional): Int32

}
Allied.Domain.Entities.Floats {

ScheduledForOffset (integer, optional): Int32,

CollectionDateOffset (integer, optional): Int32,

SettlementDateOffset (integer, optional): Int32,

NetworkSendDateOffset (integer, optional): Int32

}
Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair {

ScheduleForDate (string, optional): DateTime,

DeliveryDate (string, optional): DateTime,

DayZero (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

Description1 (string, optional): String,

Description2 (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.Services.RouteResponse {

DeliveryOption (Allied.Domain.INetworkDeliveryOption, optional): INetworkDeliveryOption,

Cost (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DeliveryTime (integer, optional): Int32,

DateTimeCalculation (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

NetworkBillerId (string, optional): String,

AccountNumber (string, optional): String,

CanReverse (boolean, optional): Boolean,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

BillerClass (string, optional): String,

IsSameDay (boolean, optional): Boolean,

CorrectedAddress (Allied.Domain.Address, optional): Address,

MinimiumScheduleForDate (string, optional): DateTime,

MinimiumDeliverByDate (string, optional): DateTime,

Overrides (Allied.Domain.Services.RouteResponse+RoutingOverrides, optional): RoutingOverrides,

NetworkGroupId (string, optional): Guid

}
Allied.Domain.INetworkDeliveryOption {

RouteId (string, optional): Guid,

Cost (number, optional): Double,

DeliveryDateOffset (integer, optional): Int32,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

CutOff (string, optional): TimeSpan,

Name (string, optional): String

}
Allied.Domain.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

State (string, optional): String,

PostalCode (string, optional): String,

Country (string, optional): String,

Id (string, optional): Guid,

Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address

}
Allied.Domain.Services.RouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.DTOs.PicturePayResponse {

IQAFields (array[Allied.Domain.DTOs.IQAField], optional): IEnumerable[Allied.Domain.DTOs.IQAField],

ExtractedFields (array[Allied.Domain.DTOs.ExtractedField], optional): IEnumerable[Allied.Domain.DTOs.ExtractedField],

GreyscaleImageLink (string, optional): String,

OriginalImageLink (string, optional): String,

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData, optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IQAField {

Name (string, optional): String,

Score (integer, optional): Int32,

Threshold (integer, optional): Int32

}
Allied.Domain.DTOs.ExtractedField {

Name (string, optional): String,

Value (string, optional): String,

ValueBest (string, optional): String,

Confidence (integer, optional): Int32

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}
Allied.Domain.DTOs.AlliedPicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IPicturePayResponse {

PictureId (string, optional): Guid,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}

{
    "PictureId": "",
    "Status": "",
    "Message": "",
    "ScanStatus": "",
    "Coupon": {
      "Address": {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "PostalCode": "",
        "State": "",
        "Result": ""
      },
      "AccountNumber": "",
      "PayeeName": "",
      "DueDate": "",
      "AmountDue": 0
    },
    "PictureSize": 0,
    "CreatedOn": "",
    "ProcessingFinished": "",
    "DeliveryOptions": [
      {
        "Fee": 0,
        "IsElectronic": false,
        "IsDefault": false,
        "Name": "",
        "DeliveryTimeOffset": 0,
        "DaysFromScheduleForDate": 0,
        "OptionId": "",
        "DeliveryOption": {
          "Id": "",
          "AllowedNetworks": [
            ""
          ],
          "Description": "",
          "ShippingMethod": "",
          "Floats": {
            "ScheduledForOffset": 0,
            "CollectionDateOffset": 0,
            "SettlementDateOffset": 0,
            "NetworkSendDateOffset": 0
          },
          "MinimiumDeliveryTime": 0,
          "MaximiumDeliveryTime": 0,
          "CutOff": "",
          "Fee": 0,
          "IsElectronic": false,
          "IsRealTime": false,
          "IsEnabled": false,
          "IsDefault": false,
          "CalculateMinimiumScheduleForDate": "",
          "DateCalculation": "",
          "MaximiumValidFor": "",
          "ValidFor": [
            ""
          ],
          "Priority": 0,
          "MaxDaysReturned": 0
        },
        "NetworkId": "",
        "RouteId": "",
        "DateTimeCalculationAlgorithm": "",
        "Priority": 0,
        "EarliestDeliveryDate": "",
        "MinimiumScheduledForDate": "",
        "MaximiumScheduledForDate": "",
        "DeliveryDates": [
          {
            "ScheduleForDate": "",
            "DeliveryDate": "",
            "DayZero": "",
            "CollectionDate": "",
            "Description1": "",
            "Description2": ""
          }
        ],
        "NetworkBillerId": "",
        "MatchedAccountNumber": "",
        "CutOff": "",
        "RouteName": "",
        "Cost": 0,
        "Overrides": {
          "AchPattern": "",
          "DoNotCollect": false,
          "DoNotSettle": false,
          "DoNotNetworkSend": false,
          "Hold": false
        },
        "ViableRoutes": [
          {
            "DeliveryOption": {
              "RouteId": "",
              "Cost": 0,
              "DeliveryDateOffset": 0,
              "DateTimeCalculationAlgorithm": "",
              "CutOff": "",
              "Name": ""
            },
            "Cost": 0,
            "IsElectronic": false,
            "NetworkId": "",
            "RouteId": "",
            "DeliveryTime": 0,
            "DateTimeCalculation": "",
            "NetworkBillerId": "",
            "AccountNumber": "",
            "CanReverse": false,
            "CutOff": "",
            "RouteName": "",
            "BillerClass": "",
            "IsSameDay": false,
            "CorrectedAddress": {
              "Address1": "",
              "Address2": "",
              "City": "",
              "State": "",
              "PostalCode": "",
              "Country": "",
              "Id": "",
              "Empty": "Allied.Domain.Address",
              "Allied": "Allied.Domain.Address"
            },
            "MinimiumScheduleForDate": "",
            "MinimiumDeliverByDate": "",
            "Overrides": {
              "AchPattern": "",
              "DoNotCollect": false,
              "DoNotSettle": false,
              "DoNotNetworkSend": false,
              "Hold": false
            },
            "NetworkGroupId": ""
          }
        ],
        "DeliveryTime": 0,
        "BillerClass": "",
        "CorrectedAddress": {
          "Address1": "",
          "Address2": "",
          "City": "",
          "State": "",
          "PostalCode": "",
          "Country": "",
          "Id": "",
          "Empty": "Allied.Domain.Address",
          "Allied": "Allied.Domain.Address"
        },
        "DateCalculation": ""
      }
    ],
    "GreyScaleImageUri": "",
    "OriginalImageUri": "",
    "UserName": "",
    "Domain": "",
    "ProcessedOn": "",
    "ProcessingTime": "",
    "RawResponse": {
      "IQAFields": [
        {
          "Name": "",
          "Score": 0,
          "Threshold": 0
        }
      ],
      "ExtractedFields": [
        {
          "Name": "",
          "Value": "",
          "ValueBest": "",
          "Confidence": 0
        }
      ],
      "GreyscaleImageLink": "",
      "OriginalImageLink": "",
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "AlliedResponse": {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "Responses": [
      {
        "PictureId": "",
        "Message": "",
        "ScanResponse": "",
        "Data": {
          "PayeeRecipient": "",
          "HighestConfidencePayeeName": ""
        },
        "ProcessingTime": "",
        "Accepted": false
      }
    ],
    "ResultedInPayment": false,
    "PaymentId": "",
    "Id": "",
    "EventSourceId": "",
    "Version": 0,
    "InitialVersion": 0
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/mitek

Calls PictureStatusHandler.GetAlliedStatus

Implementation Notes

Uri template /photos/{photoId}/status/mitek

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/mitek

Calls PictureStatusHandler.GetMitekStatus

Implementation Notes

Uri template /photos/{photoId}/status/mitek

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/mitek

Calls PictureStatusHandler.GetTisStatus

Implementation Notes

Uri template /photos/{photoId}/status/mitek

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/mitek

Calls PictureStatusHandler.GetAll

Implementation Notes

Uri template /photos/{photoId}/status/mitek

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

[
    {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    }
  ]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/tis

Calls PictureStatusHandler.Get

Implementation Notes

Uri template /photos/{photoId}/status/tis

Response Class

Allied.Domain.ScanPictureRequestTicket {

PictureId (string, optional): Guid,

Status (string, optional): String,

Message (string, optional): String,

ScanStatus (string, optional): String,

Coupon (Allied.Domain.Interfaces.ScanPictureCouponData, optional): ScanPictureCouponData,

PictureSize (integer, optional): Int32,

CreatedOn (string, optional): DateTime,

ProcessingFinished (string, optional): DateTime,

DeliveryOptions (array[Allied.Domain.Services.DeliveryOptionRouteResponse], optional): IEnumerable[Allied.Domain.Services.DeliveryOptionRouteResponse],

GreyScaleImageUri (string, optional): Uri,

OriginalImageUri (string, optional): Uri,

UserName (string, optional): String,

Domain (string, optional): String,

ProcessedOn (string, optional): DateTime,

ProcessingTime (string, optional): TimeSpan,

RawResponse (Allied.Domain.DTOs.PicturePayResponse, optional): PicturePayResponse,

AlliedResponse (Allied.Domain.DTOs.AlliedPicturePayResponse, optional): AlliedPicturePayResponse,

Responses (array[Allied.Domain.DTOs.IPicturePayResponse], optional): IEnumerable[Allied.Domain.DTOs.IPicturePayResponse],

ResultedInPayment (boolean, optional): Boolean,

PaymentId (string, optional): Guid,

Id (string, optional): Guid,

EventSourceId (string, optional): Guid,

Version (integer, optional): Int64,

InitialVersion (integer, optional): Int64

}
Allied.Domain.Interfaces.ScanPictureCouponData {

Address (Allied.Domain.DTOs.Address, optional): Address,

AccountNumber (string, optional): String,

PayeeName (string, optional): String,

DueDate (string, optional): DateTime,

AmountDue (number, optional): Double

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse {

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

Name (string, optional): String,

DeliveryTimeOffset (integer, optional): Int32,

DaysFromScheduleForDate (integer, optional): Int32,

OptionId (string, optional): Guid,

DeliveryOption (Allied.Domain.Entities.DeliveryOption, optional): DeliveryOption,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Priority (integer, optional): Int32,

EarliestDeliveryDate (string, optional): DateTime,

MinimiumScheduledForDate (string, optional): DateTime,

MaximiumScheduledForDate (string, optional): DateTime,

DeliveryDates (array[Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair], optional): IEnumerable[Allied.Domain.Services.DeliveryDatePair],

NetworkBillerId (string, optional): String,

MatchedAccountNumber (string, optional): String,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

Cost (number, optional): Double,

Overrides (Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides, optional): RoutingOverrides,

ViableRoutes (array[Allied.Domain.Services.RouteResponse], optional): IEnumerable[Allied.Domain.Services.RouteResponse],

DeliveryTime (integer, optional): Int32,

BillerClass (string, optional): String,

CorrectedAddress (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

DateCalculation (string, optional): String

}
Allied.Domain.Entities.DeliveryOption {

Id (string, optional): Guid,

AllowedNetworks (array[], optional): IEnumerable[System.Guid],

Description (string, optional): String,

ShippingMethod (string, optional) = ['Standard' or 'NextDay' or 'Expidited' or 'Paper' or 'SameDay']: ShippingMethods,

Floats (Allied.Domain.Entities.Floats, optional): Floats,

MinimiumDeliveryTime (integer, optional): Int32,

MaximiumDeliveryTime (integer, optional): Int32,

CutOff (string, optional): TimeSpan,

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsRealTime (boolean, optional): Boolean,

IsEnabled (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

CalculateMinimiumScheduleForDate (string, optional): String,

DateCalculation (string, optional) = ['UseFI' or 'DeliveryDate' or 'SendOnDate']: DateCalculations,

MaximiumValidFor (string, optional): TimeSpan,

ValidFor (array[], optional): IEnumerable[System.String],

Priority (integer, optional): Int32,

MaxDaysReturned (integer, optional): Int32

}
Allied.Domain.Entities.Floats {

ScheduledForOffset (integer, optional): Int32,

CollectionDateOffset (integer, optional): Int32,

SettlementDateOffset (integer, optional): Int32,

NetworkSendDateOffset (integer, optional): Int32

}
Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair {

ScheduleForDate (string, optional): DateTime,

DeliveryDate (string, optional): DateTime,

DayZero (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

Description1 (string, optional): String,

Description2 (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.Services.RouteResponse {

DeliveryOption (Allied.Domain.INetworkDeliveryOption, optional): INetworkDeliveryOption,

Cost (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DeliveryTime (integer, optional): Int32,

DateTimeCalculation (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

NetworkBillerId (string, optional): String,

AccountNumber (string, optional): String,

CanReverse (boolean, optional): Boolean,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

BillerClass (string, optional): String,

IsSameDay (boolean, optional): Boolean,

CorrectedAddress (Allied.Domain.Address, optional): Address,

MinimiumScheduleForDate (string, optional): DateTime,

MinimiumDeliverByDate (string, optional): DateTime,

Overrides (Allied.Domain.Services.RouteResponse+RoutingOverrides, optional): RoutingOverrides,

NetworkGroupId (string, optional): Guid

}
Allied.Domain.INetworkDeliveryOption {

RouteId (string, optional): Guid,

Cost (number, optional): Double,

DeliveryDateOffset (integer, optional): Int32,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

CutOff (string, optional): TimeSpan,

Name (string, optional): String

}
Allied.Domain.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

State (string, optional): String,

PostalCode (string, optional): String,

Country (string, optional): String,

Id (string, optional): Guid,

Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address

}
Allied.Domain.Services.RouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.DTOs.PicturePayResponse {

IQAFields (array[Allied.Domain.DTOs.IQAField], optional): IEnumerable[Allied.Domain.DTOs.IQAField],

ExtractedFields (array[Allied.Domain.DTOs.ExtractedField], optional): IEnumerable[Allied.Domain.DTOs.ExtractedField],

GreyscaleImageLink (string, optional): String,

OriginalImageLink (string, optional): String,

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData, optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IQAField {

Name (string, optional): String,

Score (integer, optional): Int32,

Threshold (integer, optional): Int32

}
Allied.Domain.DTOs.ExtractedField {

Name (string, optional): String,

Value (string, optional): String,

ValueBest (string, optional): String,

Confidence (integer, optional): Int32

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}
Allied.Domain.DTOs.AlliedPicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IPicturePayResponse {

PictureId (string, optional): Guid,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}

{
    "PictureId": "",
    "Status": "",
    "Message": "",
    "ScanStatus": "",
    "Coupon": {
      "Address": {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "PostalCode": "",
        "State": "",
        "Result": ""
      },
      "AccountNumber": "",
      "PayeeName": "",
      "DueDate": "",
      "AmountDue": 0
    },
    "PictureSize": 0,
    "CreatedOn": "",
    "ProcessingFinished": "",
    "DeliveryOptions": [
      {
        "Fee": 0,
        "IsElectronic": false,
        "IsDefault": false,
        "Name": "",
        "DeliveryTimeOffset": 0,
        "DaysFromScheduleForDate": 0,
        "OptionId": "",
        "DeliveryOption": {
          "Id": "",
          "AllowedNetworks": [
            ""
          ],
          "Description": "",
          "ShippingMethod": "",
          "Floats": {
            "ScheduledForOffset": 0,
            "CollectionDateOffset": 0,
            "SettlementDateOffset": 0,
            "NetworkSendDateOffset": 0
          },
          "MinimiumDeliveryTime": 0,
          "MaximiumDeliveryTime": 0,
          "CutOff": "",
          "Fee": 0,
          "IsElectronic": false,
          "IsRealTime": false,
          "IsEnabled": false,
          "IsDefault": false,
          "CalculateMinimiumScheduleForDate": "",
          "DateCalculation": "",
          "MaximiumValidFor": "",
          "ValidFor": [
            ""
          ],
          "Priority": 0,
          "MaxDaysReturned": 0
        },
        "NetworkId": "",
        "RouteId": "",
        "DateTimeCalculationAlgorithm": "",
        "Priority": 0,
        "EarliestDeliveryDate": "",
        "MinimiumScheduledForDate": "",
        "MaximiumScheduledForDate": "",
        "DeliveryDates": [
          {
            "ScheduleForDate": "",
            "DeliveryDate": "",
            "DayZero": "",
            "CollectionDate": "",
            "Description1": "",
            "Description2": ""
          }
        ],
        "NetworkBillerId": "",
        "MatchedAccountNumber": "",
        "CutOff": "",
        "RouteName": "",
        "Cost": 0,
        "Overrides": {
          "AchPattern": "",
          "DoNotCollect": false,
          "DoNotSettle": false,
          "DoNotNetworkSend": false,
          "Hold": false
        },
        "ViableRoutes": [
          {
            "DeliveryOption": {
              "RouteId": "",
              "Cost": 0,
              "DeliveryDateOffset": 0,
              "DateTimeCalculationAlgorithm": "",
              "CutOff": "",
              "Name": ""
            },
            "Cost": 0,
            "IsElectronic": false,
            "NetworkId": "",
            "RouteId": "",
            "DeliveryTime": 0,
            "DateTimeCalculation": "",
            "NetworkBillerId": "",
            "AccountNumber": "",
            "CanReverse": false,
            "CutOff": "",
            "RouteName": "",
            "BillerClass": "",
            "IsSameDay": false,
            "CorrectedAddress": {
              "Address1": "",
              "Address2": "",
              "City": "",
              "State": "",
              "PostalCode": "",
              "Country": "",
              "Id": "",
              "Empty": "Allied.Domain.Address",
              "Allied": "Allied.Domain.Address"
            },
            "MinimiumScheduleForDate": "",
            "MinimiumDeliverByDate": "",
            "Overrides": {
              "AchPattern": "",
              "DoNotCollect": false,
              "DoNotSettle": false,
              "DoNotNetworkSend": false,
              "Hold": false
            },
            "NetworkGroupId": ""
          }
        ],
        "DeliveryTime": 0,
        "BillerClass": "",
        "CorrectedAddress": {
          "Address1": "",
          "Address2": "",
          "City": "",
          "State": "",
          "PostalCode": "",
          "Country": "",
          "Id": "",
          "Empty": "Allied.Domain.Address",
          "Allied": "Allied.Domain.Address"
        },
        "DateCalculation": ""
      }
    ],
    "GreyScaleImageUri": "",
    "OriginalImageUri": "",
    "UserName": "",
    "Domain": "",
    "ProcessedOn": "",
    "ProcessingTime": "",
    "RawResponse": {
      "IQAFields": [
        {
          "Name": "",
          "Score": 0,
          "Threshold": 0
        }
      ],
      "ExtractedFields": [
        {
          "Name": "",
          "Value": "",
          "ValueBest": "",
          "Confidence": 0
        }
      ],
      "GreyscaleImageLink": "",
      "OriginalImageLink": "",
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "AlliedResponse": {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "Responses": [
      {
        "PictureId": "",
        "Message": "",
        "ScanResponse": "",
        "Data": {
          "PayeeRecipient": "",
          "HighestConfidencePayeeName": ""
        },
        "ProcessingTime": "",
        "Accepted": false
      }
    ],
    "ResultedInPayment": false,
    "PaymentId": "",
    "Id": "",
    "EventSourceId": "",
    "Version": 0,
    "InitialVersion": 0
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/tis

Calls PictureStatusHandler.GetAlliedStatus

Implementation Notes

Uri template /photos/{photoId}/status/tis

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/tis

Calls PictureStatusHandler.GetMitekStatus

Implementation Notes

Uri template /photos/{photoId}/status/tis

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/tis

Calls PictureStatusHandler.GetTisStatus

Implementation Notes

Uri template /photos/{photoId}/status/tis

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/tis

Calls PictureStatusHandler.GetAll

Implementation Notes

Uri template /photos/{photoId}/status/tis

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

[
    {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    }
  ]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/all

Calls PictureStatusHandler.Get

Implementation Notes

Uri template /photos/{photoId}/status/all

Response Class

Allied.Domain.ScanPictureRequestTicket {

PictureId (string, optional): Guid,

Status (string, optional): String,

Message (string, optional): String,

ScanStatus (string, optional): String,

Coupon (Allied.Domain.Interfaces.ScanPictureCouponData, optional): ScanPictureCouponData,

PictureSize (integer, optional): Int32,

CreatedOn (string, optional): DateTime,

ProcessingFinished (string, optional): DateTime,

DeliveryOptions (array[Allied.Domain.Services.DeliveryOptionRouteResponse], optional): IEnumerable[Allied.Domain.Services.DeliveryOptionRouteResponse],

GreyScaleImageUri (string, optional): Uri,

OriginalImageUri (string, optional): Uri,

UserName (string, optional): String,

Domain (string, optional): String,

ProcessedOn (string, optional): DateTime,

ProcessingTime (string, optional): TimeSpan,

RawResponse (Allied.Domain.DTOs.PicturePayResponse, optional): PicturePayResponse,

AlliedResponse (Allied.Domain.DTOs.AlliedPicturePayResponse, optional): AlliedPicturePayResponse,

Responses (array[Allied.Domain.DTOs.IPicturePayResponse], optional): IEnumerable[Allied.Domain.DTOs.IPicturePayResponse],

ResultedInPayment (boolean, optional): Boolean,

PaymentId (string, optional): Guid,

Id (string, optional): Guid,

EventSourceId (string, optional): Guid,

Version (integer, optional): Int64,

InitialVersion (integer, optional): Int64

}
Allied.Domain.Interfaces.ScanPictureCouponData {

Address (Allied.Domain.DTOs.Address, optional): Address,

AccountNumber (string, optional): String,

PayeeName (string, optional): String,

DueDate (string, optional): DateTime,

AmountDue (number, optional): Double

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse {

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

Name (string, optional): String,

DeliveryTimeOffset (integer, optional): Int32,

DaysFromScheduleForDate (integer, optional): Int32,

OptionId (string, optional): Guid,

DeliveryOption (Allied.Domain.Entities.DeliveryOption, optional): DeliveryOption,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Priority (integer, optional): Int32,

EarliestDeliveryDate (string, optional): DateTime,

MinimiumScheduledForDate (string, optional): DateTime,

MaximiumScheduledForDate (string, optional): DateTime,

DeliveryDates (array[Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair], optional): IEnumerable[Allied.Domain.Services.DeliveryDatePair],

NetworkBillerId (string, optional): String,

MatchedAccountNumber (string, optional): String,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

Cost (number, optional): Double,

Overrides (Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides, optional): RoutingOverrides,

ViableRoutes (array[Allied.Domain.Services.RouteResponse], optional): IEnumerable[Allied.Domain.Services.RouteResponse],

DeliveryTime (integer, optional): Int32,

BillerClass (string, optional): String,

CorrectedAddress (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

DateCalculation (string, optional): String

}
Allied.Domain.Entities.DeliveryOption {

Id (string, optional): Guid,

AllowedNetworks (array[], optional): IEnumerable[System.Guid],

Description (string, optional): String,

ShippingMethod (string, optional) = ['Standard' or 'NextDay' or 'Expidited' or 'Paper' or 'SameDay']: ShippingMethods,

Floats (Allied.Domain.Entities.Floats, optional): Floats,

MinimiumDeliveryTime (integer, optional): Int32,

MaximiumDeliveryTime (integer, optional): Int32,

CutOff (string, optional): TimeSpan,

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsRealTime (boolean, optional): Boolean,

IsEnabled (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

CalculateMinimiumScheduleForDate (string, optional): String,

DateCalculation (string, optional) = ['UseFI' or 'DeliveryDate' or 'SendOnDate']: DateCalculations,

MaximiumValidFor (string, optional): TimeSpan,

ValidFor (array[], optional): IEnumerable[System.String],

Priority (integer, optional): Int32,

MaxDaysReturned (integer, optional): Int32

}
Allied.Domain.Entities.Floats {

ScheduledForOffset (integer, optional): Int32,

CollectionDateOffset (integer, optional): Int32,

SettlementDateOffset (integer, optional): Int32,

NetworkSendDateOffset (integer, optional): Int32

}
Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair {

ScheduleForDate (string, optional): DateTime,

DeliveryDate (string, optional): DateTime,

DayZero (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

Description1 (string, optional): String,

Description2 (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.Services.RouteResponse {

DeliveryOption (Allied.Domain.INetworkDeliveryOption, optional): INetworkDeliveryOption,

Cost (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DeliveryTime (integer, optional): Int32,

DateTimeCalculation (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

NetworkBillerId (string, optional): String,

AccountNumber (string, optional): String,

CanReverse (boolean, optional): Boolean,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

BillerClass (string, optional): String,

IsSameDay (boolean, optional): Boolean,

CorrectedAddress (Allied.Domain.Address, optional): Address,

MinimiumScheduleForDate (string, optional): DateTime,

MinimiumDeliverByDate (string, optional): DateTime,

Overrides (Allied.Domain.Services.RouteResponse+RoutingOverrides, optional): RoutingOverrides,

NetworkGroupId (string, optional): Guid

}
Allied.Domain.INetworkDeliveryOption {

RouteId (string, optional): Guid,

Cost (number, optional): Double,

DeliveryDateOffset (integer, optional): Int32,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

CutOff (string, optional): TimeSpan,

Name (string, optional): String

}
Allied.Domain.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

State (string, optional): String,

PostalCode (string, optional): String,

Country (string, optional): String,

Id (string, optional): Guid,

Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address

}
Allied.Domain.Services.RouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.DTOs.PicturePayResponse {

IQAFields (array[Allied.Domain.DTOs.IQAField], optional): IEnumerable[Allied.Domain.DTOs.IQAField],

ExtractedFields (array[Allied.Domain.DTOs.ExtractedField], optional): IEnumerable[Allied.Domain.DTOs.ExtractedField],

GreyscaleImageLink (string, optional): String,

OriginalImageLink (string, optional): String,

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData, optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IQAField {

Name (string, optional): String,

Score (integer, optional): Int32,

Threshold (integer, optional): Int32

}
Allied.Domain.DTOs.ExtractedField {

Name (string, optional): String,

Value (string, optional): String,

ValueBest (string, optional): String,

Confidence (integer, optional): Int32

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}
Allied.Domain.DTOs.AlliedPicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IPicturePayResponse {

PictureId (string, optional): Guid,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}

{
    "PictureId": "",
    "Status": "",
    "Message": "",
    "ScanStatus": "",
    "Coupon": {
      "Address": {
        "Address1": "",
        "Address2": "",
        "City": "",
        "Country": "",
        "PostalCode": "",
        "State": "",
        "Result": ""
      },
      "AccountNumber": "",
      "PayeeName": "",
      "DueDate": "",
      "AmountDue": 0
    },
    "PictureSize": 0,
    "CreatedOn": "",
    "ProcessingFinished": "",
    "DeliveryOptions": [
      {
        "Fee": 0,
        "IsElectronic": false,
        "IsDefault": false,
        "Name": "",
        "DeliveryTimeOffset": 0,
        "DaysFromScheduleForDate": 0,
        "OptionId": "",
        "DeliveryOption": {
          "Id": "",
          "AllowedNetworks": [
            ""
          ],
          "Description": "",
          "ShippingMethod": "",
          "Floats": {
            "ScheduledForOffset": 0,
            "CollectionDateOffset": 0,
            "SettlementDateOffset": 0,
            "NetworkSendDateOffset": 0
          },
          "MinimiumDeliveryTime": 0,
          "MaximiumDeliveryTime": 0,
          "CutOff": "",
          "Fee": 0,
          "IsElectronic": false,
          "IsRealTime": false,
          "IsEnabled": false,
          "IsDefault": false,
          "CalculateMinimiumScheduleForDate": "",
          "DateCalculation": "",
          "MaximiumValidFor": "",
          "ValidFor": [
            ""
          ],
          "Priority": 0,
          "MaxDaysReturned": 0
        },
        "NetworkId": "",
        "RouteId": "",
        "DateTimeCalculationAlgorithm": "",
        "Priority": 0,
        "EarliestDeliveryDate": "",
        "MinimiumScheduledForDate": "",
        "MaximiumScheduledForDate": "",
        "DeliveryDates": [
          {
            "ScheduleForDate": "",
            "DeliveryDate": "",
            "DayZero": "",
            "CollectionDate": "",
            "Description1": "",
            "Description2": ""
          }
        ],
        "NetworkBillerId": "",
        "MatchedAccountNumber": "",
        "CutOff": "",
        "RouteName": "",
        "Cost": 0,
        "Overrides": {
          "AchPattern": "",
          "DoNotCollect": false,
          "DoNotSettle": false,
          "DoNotNetworkSend": false,
          "Hold": false
        },
        "ViableRoutes": [
          {
            "DeliveryOption": {
              "RouteId": "",
              "Cost": 0,
              "DeliveryDateOffset": 0,
              "DateTimeCalculationAlgorithm": "",
              "CutOff": "",
              "Name": ""
            },
            "Cost": 0,
            "IsElectronic": false,
            "NetworkId": "",
            "RouteId": "",
            "DeliveryTime": 0,
            "DateTimeCalculation": "",
            "NetworkBillerId": "",
            "AccountNumber": "",
            "CanReverse": false,
            "CutOff": "",
            "RouteName": "",
            "BillerClass": "",
            "IsSameDay": false,
            "CorrectedAddress": {
              "Address1": "",
              "Address2": "",
              "City": "",
              "State": "",
              "PostalCode": "",
              "Country": "",
              "Id": "",
              "Empty": "Allied.Domain.Address",
              "Allied": "Allied.Domain.Address"
            },
            "MinimiumScheduleForDate": "",
            "MinimiumDeliverByDate": "",
            "Overrides": {
              "AchPattern": "",
              "DoNotCollect": false,
              "DoNotSettle": false,
              "DoNotNetworkSend": false,
              "Hold": false
            },
            "NetworkGroupId": ""
          }
        ],
        "DeliveryTime": 0,
        "BillerClass": "",
        "CorrectedAddress": {
          "Address1": "",
          "Address2": "",
          "City": "",
          "State": "",
          "PostalCode": "",
          "Country": "",
          "Id": "",
          "Empty": "Allied.Domain.Address",
          "Allied": "Allied.Domain.Address"
        },
        "DateCalculation": ""
      }
    ],
    "GreyScaleImageUri": "",
    "OriginalImageUri": "",
    "UserName": "",
    "Domain": "",
    "ProcessedOn": "",
    "ProcessingTime": "",
    "RawResponse": {
      "IQAFields": [
        {
          "Name": "",
          "Score": 0,
          "Threshold": 0
        }
      ],
      "ExtractedFields": [
        {
          "Name": "",
          "Value": "",
          "ValueBest": "",
          "Confidence": 0
        }
      ],
      "GreyscaleImageLink": "",
      "OriginalImageLink": "",
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "AlliedResponse": {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    },
    "Responses": [
      {
        "PictureId": "",
        "Message": "",
        "ScanResponse": "",
        "Data": {
          "PayeeRecipient": "",
          "HighestConfidencePayeeName": ""
        },
        "ProcessingTime": "",
        "Accepted": false
      }
    ],
    "ResultedInPayment": false,
    "PaymentId": "",
    "Id": "",
    "EventSourceId": "",
    "Version": 0,
    "InitialVersion": 0
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/all

Calls PictureStatusHandler.GetAlliedStatus

Implementation Notes

Uri template /photos/{photoId}/status/all

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/all

Calls PictureStatusHandler.GetMitekStatus

Implementation Notes

Uri template /photos/{photoId}/status/all

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/all

Calls PictureStatusHandler.GetTisStatus

Implementation Notes

Uri template /photos/{photoId}/status/all

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

{
    "PictureId": "",
    "Processor": "",
    "Message": "",
    "ScanResponse": "",
    "Data": {
      "PayeeRecipient": "",
      "HighestConfidencePayeeName": ""
    },
    "ProcessingTime": "",
    "Accepted": false
  }

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

get /photos/{photoId}/status/all

Calls PictureStatusHandler.GetAll

Implementation Notes

Uri template /photos/{photoId}/status/all

Response Class

Allied.Domain.DTOs.BasePicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}

[
    {
      "PictureId": "",
      "Processor": "",
      "Message": "",
      "ScanResponse": "",
      "Data": {
        "PayeeRecipient": "",
        "HighestConfidencePayeeName": ""
      },
      "ProcessingTime": "",
      "Accepted": false
    }
  ]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
photoId			path	string

Response Messages

HTTP Status Code	Reason	Response Model
200
404

scan : scan

get /scan/checks/{pictureId}/status

Calls CheckStatusHandler.Get

post /scan/checks

Calls CheckPostHandler.Post

get /scan/checks/{pictureId}

Calls CheckPictureGetHandler.Get

get /scan/cc/{pictureId}/status

Calls CCStatusHandler.Get

post /scan/cc

Calls CCPostHandler.Post

get /scan/cc/{pictureId}

Calls CCPictureGetHandler.Get

security : security

get /security/

Calls SecurityLogHandler.Get

sso : sso

post /sso

Calls SSOHandler.Post

Implementation Notes

Uri template /sso

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
body	Parameter content type:		body	Model Model Schema Allied.Domain.DTOs.SSOToken { CustomerId (string, optional): String, FinancialInstitutionId (string, optional): String, FirstName (string, optional): String, MiddleName (string, optional): String, LastName (string, optional): String, OverrideName (string, optional): String, Email (string, optional): String, Timeout (integer, optional): Int32, Accounts (array[Allied.Domain.DTOs.SSOToken+AccountInformation], optional): IEnumerable[Allied.Domain.DTOs.AccountInformation], PrimaryCompanyName (string, optional): String, Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, State (string, optional): String, Zip (string, optional): String, CompanyNames (array[], optional): IEnumerable[System.String], PhoneNumbers (array[Allied.Domain.DTOs.SSOToken+PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber], DailyLimit (number, optional): Decimal, LogoutUri (string, optional): String, UserName (string, optional): String, NameAddress1 (string, optional): String, NameAddress2 (string, optional): String, NameAddress3 (string, optional): String, NameAddress4 (string, optional): String, NameAddress5 (string, optional): String, ForeignKey (string, optional): String, CustomerType (string, optional): String, Application (string, optional): String, ApplicationData (string, optional): String } Allied.Domain.DTOs.SSOToken+AccountInformation { AccountCIF (string, optional): String, AccountNumber (string, optional): String, AccountName (string, optional): String, AvailableAccountBalance (number, optional): Double, CollectedAccountBalance (number, optional): Double, RoutingNumber (string, optional): String, AccountOwnerType (string, optional): String, AccountType (string, optional): String, NameAddress1 (string, optional): String, NameAddress2 (string, optional): String, NameAddress3 (string, optional): String, NameAddress4 (string, optional): String, NameAddress5 (string, optional): String, Address1 (string, optional): String, Address2 (string, optional): String, City (string, optional): String, State (string, optional): String, PostalCode (string, optional): String, PayFromName (string, optional): String, MICRAccountNumber (string, optional): String } Allied.Domain.DTOs.SSOToken+PhoneNumber { Number (string, optional): String, Name (string, optional): String, IsTextCapable (boolean, optional): Boolean } { "CustomerId": "", "FinancialInstitutionId": "", "FirstName": "", "MiddleName": "", "LastName": "", "OverrideName": "", "Email": "", "Timeout": 0, "Accounts": [ { "AccountCIF": "", "AccountNumber": "", "AccountName": "", "AvailableAccountBalance": 0, "CollectedAccountBalance": 0, "RoutingNumber": "", "AccountOwnerType": "", "AccountType": "", "NameAddress1": "", "NameAddress2": "", "NameAddress3": "", "NameAddress4": "", "NameAddress5": "", "Address1": "", "Address2": "", "City": "", "State": "", "PostalCode": "", "PayFromName": "", "MICRAccountNumber": "" } ], "PrimaryCompanyName": "", "Address1": "", "Address2": "", "City": "", "State": "", "Zip": "", "CompanyNames": [ "" ], "PhoneNumbers": [ { "Number": "", "Name": "", "IsTextCapable": false } ], "DailyLimit": 0, "LogoutUri": "", "UserName": "", "NameAddress1": "", "NameAddress2": "", "NameAddress3": "", "NameAddress4": "", "NameAddress5": "", "ForeignKey": "", "CustomerType": "", "Application": "", "ApplicationData": "" } Click to set as parameter value

tickets : tickets

get /tickets

Calls TicketHandler.Get

Implementation Notes

Uri template /tickets?top={top}&page={page}

Response Class

Allied.Domain.ScanPictureRequestTicket {

PictureId (string, optional): Guid,

Status (string, optional): String,

Message (string, optional): String,

ScanStatus (string, optional): String,

Coupon (Allied.Domain.Interfaces.ScanPictureCouponData, optional): ScanPictureCouponData,

PictureSize (integer, optional): Int32,

CreatedOn (string, optional): DateTime,

ProcessingFinished (string, optional): DateTime,

DeliveryOptions (array[Allied.Domain.Services.DeliveryOptionRouteResponse], optional): IEnumerable[Allied.Domain.Services.DeliveryOptionRouteResponse],

GreyScaleImageUri (string, optional): Uri,

OriginalImageUri (string, optional): Uri,

UserName (string, optional): String,

Domain (string, optional): String,

ProcessedOn (string, optional): DateTime,

ProcessingTime (string, optional): TimeSpan,

RawResponse (Allied.Domain.DTOs.PicturePayResponse, optional): PicturePayResponse,

AlliedResponse (Allied.Domain.DTOs.AlliedPicturePayResponse, optional): AlliedPicturePayResponse,

Responses (array[Allied.Domain.DTOs.IPicturePayResponse], optional): IEnumerable[Allied.Domain.DTOs.IPicturePayResponse],

ResultedInPayment (boolean, optional): Boolean,

PaymentId (string, optional): Guid,

Id (string, optional): Guid,

EventSourceId (string, optional): Guid,

Version (integer, optional): Int64,

InitialVersion (integer, optional): Int64

}
Allied.Domain.Interfaces.ScanPictureCouponData {

Address (Allied.Domain.DTOs.Address, optional): Address,

AccountNumber (string, optional): String,

PayeeName (string, optional): String,

DueDate (string, optional): DateTime,

AmountDue (number, optional): Double

}
Allied.Domain.DTOs.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

Country (string, optional): String,

PostalCode (string, optional): String,

State (string, optional): String,

Result (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse {

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

Name (string, optional): String,

DeliveryTimeOffset (integer, optional): Int32,

DaysFromScheduleForDate (integer, optional): Int32,

OptionId (string, optional): Guid,

DeliveryOption (Allied.Domain.Entities.DeliveryOption, optional): DeliveryOption,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

Priority (integer, optional): Int32,

EarliestDeliveryDate (string, optional): DateTime,

MinimiumScheduledForDate (string, optional): DateTime,

MaximiumScheduledForDate (string, optional): DateTime,

DeliveryDates (array[Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair], optional): IEnumerable[Allied.Domain.Services.DeliveryDatePair],

NetworkBillerId (string, optional): String,

MatchedAccountNumber (string, optional): String,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

Cost (number, optional): Double,

Overrides (Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides, optional): RoutingOverrides,

ViableRoutes (array[Allied.Domain.Services.RouteResponse], optional): IEnumerable[Allied.Domain.Services.RouteResponse],

DeliveryTime (integer, optional): Int32,

BillerClass (string, optional): String,

CorrectedAddress (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

DateCalculation (string, optional): String

}
Allied.Domain.Entities.DeliveryOption {

Id (string, optional): Guid,

AllowedNetworks (array[], optional): IEnumerable[System.Guid],

Description (string, optional): String,

ShippingMethod (string, optional) = ['Standard' or 'NextDay' or 'Expidited' or 'Paper' or 'SameDay']: ShippingMethods,

Floats (Allied.Domain.Entities.Floats, optional): Floats,

MinimiumDeliveryTime (integer, optional): Int32,

MaximiumDeliveryTime (integer, optional): Int32,

CutOff (string, optional): TimeSpan,

Fee (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

IsRealTime (boolean, optional): Boolean,

IsEnabled (boolean, optional): Boolean,

IsDefault (boolean, optional): Boolean,

CalculateMinimiumScheduleForDate (string, optional): String,

DateCalculation (string, optional) = ['UseFI' or 'DeliveryDate' or 'SendOnDate']: DateCalculations,

MaximiumValidFor (string, optional): TimeSpan,

ValidFor (array[], optional): IEnumerable[System.String],

Priority (integer, optional): Int32,

MaxDaysReturned (integer, optional): Int32

}
Allied.Domain.Entities.Floats {

ScheduledForOffset (integer, optional): Int32,

CollectionDateOffset (integer, optional): Int32,

SettlementDateOffset (integer, optional): Int32,

NetworkSendDateOffset (integer, optional): Int32

}
Allied.Domain.Services.DeliveryOptionRouteResponse+DeliveryDatePair {

ScheduleForDate (string, optional): DateTime,

DeliveryDate (string, optional): DateTime,

DayZero (string, optional): DateTime,

CollectionDate (string, optional): DateTime,

Description1 (string, optional): String,

Description2 (string, optional): String

}
Allied.Domain.Services.DeliveryOptionRouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.Services.RouteResponse {

DeliveryOption (Allied.Domain.INetworkDeliveryOption, optional): INetworkDeliveryOption,

Cost (number, optional): Double,

IsElectronic (boolean, optional): Boolean,

NetworkId (string, optional): Guid,

RouteId (string, optional): Guid,

DeliveryTime (integer, optional): Int32,

DateTimeCalculation (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

NetworkBillerId (string, optional): String,

AccountNumber (string, optional): String,

CanReverse (boolean, optional): Boolean,

CutOff (string, optional): TimeSpan,

RouteName (string, optional): String,

BillerClass (string, optional): String,

IsSameDay (boolean, optional): Boolean,

CorrectedAddress (Allied.Domain.Address, optional): Address,

MinimiumScheduleForDate (string, optional): DateTime,

MinimiumDeliverByDate (string, optional): DateTime,

Overrides (Allied.Domain.Services.RouteResponse+RoutingOverrides, optional): RoutingOverrides,

NetworkGroupId (string, optional): Guid

}
Allied.Domain.INetworkDeliveryOption {

RouteId (string, optional): Guid,

Cost (number, optional): Double,

DeliveryDateOffset (integer, optional): Int32,

DateTimeCalculationAlgorithm (string, optional) = ['BusinessDays' or 'BusinessDaysPlusSaturday']: DateTimeCalculations,

CutOff (string, optional): TimeSpan,

Name (string, optional): String

}
Allied.Domain.Address {

Address1 (string, optional): String,

Address2 (string, optional): String,

City (string, optional): String,

State (string, optional): String,

PostalCode (string, optional): String,

Country (string, optional): String,

Id (string, optional): Guid,

Empty (Allied.Domain.Address[Allied.Domain.Address], optional): Address,

Allied (Allied.Domain.Address[Allied.Domain.Address], optional): Address

}
Allied.Domain.Services.RouteResponse+RoutingOverrides {

AchPattern (string, optional): String,

DoNotCollect (boolean, optional): Boolean,

DoNotSettle (boolean, optional): Boolean,

DoNotNetworkSend (boolean, optional): Boolean,

Hold (boolean, optional): Boolean

}
Allied.Domain.DTOs.PicturePayResponse {

IQAFields (array[Allied.Domain.DTOs.IQAField], optional): IEnumerable[Allied.Domain.DTOs.IQAField],

ExtractedFields (array[Allied.Domain.DTOs.ExtractedField], optional): IEnumerable[Allied.Domain.DTOs.ExtractedField],

GreyscaleImageLink (string, optional): String,

OriginalImageLink (string, optional): String,

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData, optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IQAField {

Name (string, optional): String,

Score (integer, optional): Int32,

Threshold (integer, optional): Int32

}
Allied.Domain.DTOs.ExtractedField {

Name (string, optional): String,

Value (string, optional): String,

ValueBest (string, optional): String,

Confidence (integer, optional): Int32

}
Allied.Domain.Resources.CouponData {

PayeeRecipient (string, optional): String,

HighestConfidencePayeeName (string, optional): String

}
Allied.Domain.DTOs.AlliedPicturePayResponse {

PictureId (string, optional): Guid,

Processor (string, optional) = ['Allied' or 'Mitek' or 'TIS' or 'Gcv']: PicturePayProcessors,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}
Allied.Domain.DTOs.IPicturePayResponse {

PictureId (string, optional): Guid,

Message (string, optional): String,

ScanResponse (string, optional): String,

Data (Allied.Domain.Resources.CouponData[Allied.Domain.Resources.CouponData], optional): CouponData,

ProcessingTime (string, optional): TimeSpan,

Accepted (boolean, optional): Boolean

}

[
    {
      "PictureId": "",
      "Status": "",
      "Message": "",
      "ScanStatus": "",
      "Coupon": {
        "Address": {
          "Address1": "",
          "Address2": "",
          "City": "",
          "Country": "",
          "PostalCode": "",
          "State": "",
          "Result": ""
        },
        "AccountNumber": "",
        "PayeeName": "",
        "DueDate": "",
        "AmountDue": 0
      },
      "PictureSize": 0,
      "CreatedOn": "",
      "ProcessingFinished": "",
      "DeliveryOptions": [
        {
          "Fee": 0,
          "IsElectronic": false,
          "IsDefault": false,
          "Name": "",
          "DeliveryTimeOffset": 0,
          "DaysFromScheduleForDate": 0,
          "OptionId": "",
          "DeliveryOption": {
            "Id": "",
            "AllowedNetworks": [
              ""
            ],
            "Description": "",
            "ShippingMethod": "",
            "Floats": {
              "ScheduledForOffset": 0,
              "CollectionDateOffset": 0,
              "SettlementDateOffset": 0,
              "NetworkSendDateOffset": 0
            },
            "MinimiumDeliveryTime": 0,
            "MaximiumDeliveryTime": 0,
            "CutOff": "",
            "Fee": 0,
            "IsElectronic": false,
            "IsRealTime": false,
            "IsEnabled": false,
            "IsDefault": false,
            "CalculateMinimiumScheduleForDate": "",
            "DateCalculation": "",
            "MaximiumValidFor": "",
            "ValidFor": [
              ""
            ],
            "Priority": 0,
            "MaxDaysReturned": 0
          },
          "NetworkId": "",
          "RouteId": "",
          "DateTimeCalculationAlgorithm": "",
          "Priority": 0,
          "EarliestDeliveryDate": "",
          "MinimiumScheduledForDate": "",
          "MaximiumScheduledForDate": "",
          "DeliveryDates": [
            {
              "ScheduleForDate": "",
              "DeliveryDate": "",
              "DayZero": "",
              "CollectionDate": "",
              "Description1": "",
              "Description2": ""
            }
          ],
          "NetworkBillerId": "",
          "MatchedAccountNumber": "",
          "CutOff": "",
          "RouteName": "",
          "Cost": 0,
          "Overrides": {
            "AchPattern": "",
            "DoNotCollect": false,
            "DoNotSettle": false,
            "DoNotNetworkSend": false,
            "Hold": false
          },
          "ViableRoutes": [
            {
              "DeliveryOption": {
                "RouteId": "",
                "Cost": 0,
                "DeliveryDateOffset": 0,
                "DateTimeCalculationAlgorithm": "",
                "CutOff": "",
                "Name": ""
              },
              "Cost": 0,
              "IsElectronic": false,
              "NetworkId": "",
              "RouteId": "",
              "DeliveryTime": 0,
              "DateTimeCalculation": "",
              "NetworkBillerId": "",
              "AccountNumber": "",
              "CanReverse": false,
              "CutOff": "",
              "RouteName": "",
              "BillerClass": "",
              "IsSameDay": false,
              "CorrectedAddress": {
                "Address1": "",
                "Address2": "",
                "City": "",
                "State": "",
                "PostalCode": "",
                "Country": "",
                "Id": "",
                "Empty": "Allied.Domain.Address",
                "Allied": "Allied.Domain.Address"
              },
              "MinimiumScheduleForDate": "",
              "MinimiumDeliverByDate": "",
              "Overrides": {
                "AchPattern": "",
                "DoNotCollect": false,
                "DoNotSettle": false,
                "DoNotNetworkSend": false,
                "Hold": false
              },
              "NetworkGroupId": ""
            }
          ],
          "DeliveryTime": 0,
          "BillerClass": "",
          "CorrectedAddress": {
            "Address1": "",
            "Address2": "",
            "City": "",
            "State": "",
            "PostalCode": "",
            "Country": "",
            "Id": "",
            "Empty": "Allied.Domain.Address",
            "Allied": "Allied.Domain.Address"
          },
          "DateCalculation": ""
        }
      ],
      "GreyScaleImageUri": "",
      "OriginalImageUri": "",
      "UserName": "",
      "Domain": "",
      "ProcessedOn": "",
      "ProcessingTime": "",
      "RawResponse": {
        "IQAFields": [
          {
            "Name": "",
            "Score": 0,
            "Threshold": 0
          }
        ],
        "ExtractedFields": [
          {
            "Name": "",
            "Value": "",
            "ValueBest": "",
            "Confidence": 0
          }
        ],
        "GreyscaleImageLink": "",
        "OriginalImageLink": "",
        "PictureId": "",
        "Processor": "",
        "Message": "",
        "ScanResponse": "",
        "Data": {
          "PayeeRecipient": "",
          "HighestConfidencePayeeName": ""
        },
        "ProcessingTime": "",
        "Accepted": false
      },
      "AlliedResponse": {
        "PictureId": "",
        "Processor": "",
        "Message": "",
        "ScanResponse": "",
        "Data": {
          "PayeeRecipient": "",
          "HighestConfidencePayeeName": ""
        },
        "ProcessingTime": "",
        "Accepted": false
      },
      "Responses": [
        {
          "PictureId": "",
          "Message": "",
          "ScanResponse": "",
          "Data": {
            "PayeeRecipient": "",
            "HighestConfidencePayeeName": ""
          },
          "ProcessingTime": "",
          "Accepted": false
        }
      ],
      "ResultedInPayment": false,
      "PaymentId": "",
      "Id": "",
      "EventSourceId": "",
      "Version": 0,
      "InitialVersion": 0
    }
  ]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
page			query	integer
top			query	integer

Response Messages

HTTP Status Code	Reason	Response Model
200
204

users : users

get /users/{userId}

Calls UserHandler.Get

delete /users/{userId}

Calls UserHandler.Delete

patch /users/{userId}

Calls UserHandler.Patch

Implementation Notes

Uri template /users/{userId}

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
userId			path	string
body	Parameter content type:		body	Model Model Schema Allied.Services.REST.Handlers.UserHandler+UserPatch { UserName (string, optional): String, EmailAddress (string, optional): String, PhoneNumbers (array[Allied.Domain.PhoneNumber], optional): IEnumerable[Allied.Domain.PhoneNumber], ForeignKey (string, optional): String } Allied.Domain.PhoneNumber { Id (string, optional): Guid, Name (string, optional): String, Number (string, optional): String, IsEnabled (boolean, optional): Boolean, IsVerified (boolean, optional): Boolean, IsDefault (boolean, optional): Boolean, VerificationCode (string, optional): String, PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes, IsTextCapable (boolean, optional): Boolean } `{ "UserName": "", "EmailAddress": "", "PhoneNumbers": [ { "Id": "", "Name": "", "Number": "", "IsEnabled": false, "IsVerified": false, "IsDefault": false, "VerificationCode": "", "PhoneType": "", "IsTextCapable": false } ], "ForeignKey": "" }` Click to set as parameter value

put /users/{userId}

Calls UserHandler.Put

Implementation Notes

Uri template /users/{userId}

Response Class

unknown

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
userId			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.DTOs.User { Id (string, optional): Guid, UserName (string, optional): String, Roles (array[], optional): IEnumerable[System.String], Identity (System.Security.Principal.IIdentity, optional): IIdentity, PhoneNumbers (array[Allied.Domain.DTOs.PhoneNumber], optional): IEnumerable[Allied.Domain.DTOs.PhoneNumber], FinancialInstitutionId (string, optional): Guid, Domain (string, optional): String, CustomerId (string, optional): Guid, HasGoogleAuth (boolean, optional): Boolean, IsEnrolled (boolean, optional): Boolean, EmailAddress (string, optional): String, IsLockedOut (boolean, optional): Boolean, RequiresMultiFactor (boolean, optional): Boolean, Links (array[Allied.Core.Collections.Link], optional): IEnumerable[Allied.Core.Collections.Link], FirstName (string, optional): String, LastName (string, optional): String, FullName (string, optional): String, Password (string, optional): String, DisplayUserName (string, optional): String, ForeignKey (string, optional): String, Name (string, optional): String, AuthenticationType (string, optional): String, IsAuthenticated (boolean, optional): Boolean, IsDeleted (boolean, optional): Boolean, PinAuthentication (Allied.Core.Security.IPasswordAuthentication, optional): IPasswordAuthentication, TimeZone (string, optional): String, Authentication (Allied.Core.Security.IPasswordAuthentication[Allied.Core.Security.IPasswordAuthentication], optional): IPasswordAuthentication, ApiKey (string, optional): String, FinancialInstitution (string, optional): Guid, GPinKey (string, optional): String, IsUserTeller (boolean, optional): Boolean, IsDemo (boolean, optional): Boolean, IsForcePasswordChange (boolean, optional): Boolean, IsUserFIAdmin (boolean, optional): Boolean, IsPasswordExpired (boolean, optional): Boolean, GPinKeyMask (string, optional): String, PinEnabled (boolean, optional): Boolean, SelectedTheme (string, optional): String, IsSSO (boolean, optional): Boolean, CurrentTheme (string, optional): String, LimitId (string, optional): Guid, IsPictureTipsHidden (boolean, optional): Boolean, HasAcceptedDisclaimer (boolean, optional): Boolean, DefaultFlexPayView (string, optional): String, UseNewUi (boolean, optional): Boolean, IsDisabled (boolean, optional): Boolean } System.Security.Principal.IIdentity { Name (string, optional): String, AuthenticationType (string, optional): String, IsAuthenticated (boolean, optional): Boolean } Allied.Domain.DTOs.PhoneNumber { Id (string, optional): Guid, Name (string, optional): String, Number (string, optional): String, IsEnabled (boolean, optional): Boolean, IsVerified (boolean, optional): Boolean, IsDefault (boolean, optional): Boolean, VerificationCode (string, optional): String, PhoneType (string, optional) = ['None' or 'Android' or 'IPhone' or 'Blackberry']: PhoneTypes, IsTextCapable (boolean, optional): Boolean } Allied.Core.Collections.Link { HRef (string, optional): Uri, Relation (string, optional): String } Allied.Core.Security.IPasswordAuthentication { } { "Id": "", "UserName": "", "Roles": [ "" ], "Identity": { "Name": "", "AuthenticationType": "", "IsAuthenticated": false }, "PhoneNumbers": [ { "Id": "", "Name": "", "Number": "", "IsEnabled": false, "IsVerified": false, "IsDefault": false, "VerificationCode": "", "PhoneType": "", "IsTextCapable": false } ], "FinancialInstitutionId": "", "Domain": "", "CustomerId": "", "HasGoogleAuth": false, "IsEnrolled": false, "EmailAddress": "", "IsLockedOut": false, "RequiresMultiFactor": false, "Links": [ { "HRef": "", "Relation": "" } ], "FirstName": "", "LastName": "", "FullName": "", "Password": "", "DisplayUserName": "", "ForeignKey": "", "Name": "", "AuthenticationType": "", "IsAuthenticated": false, "IsDeleted": false, "PinAuthentication": {}, "TimeZone": "", "Authentication": {}, "ApiKey": "", "FinancialInstitution": "", "GPinKey": "", "IsUserTeller": false, "IsDemo": false, "IsForcePasswordChange": false, "IsUserFIAdmin": false, "IsPasswordExpired": false, "GPinKeyMask": "", "PinEnabled": false, "SelectedTheme": "", "IsSSO": false, "CurrentTheme": "", "LimitId": "", "IsPictureTipsHidden": false, "HasAcceptedDisclaimer": false, "DefaultFlexPayView": "", "UseNewUi": false, "IsDisabled": false } Click to set as parameter value

userSearch : userSearch

get /userSearch

Calls UserSearchHandler.UserSearch

version : version
- - get /version
    - Calls VersionHandler.Get
    Implementation Notes
    
    Uri template /version
    
    Response Class
    Model
    
    Model Schema
    
    Allied.Core.Version {
    Major (integer, optional): Int32,
    Minor (integer, optional): Int32,
    Revision (integer, optional): Int32,
    Build (integer, optional): Int32
    }
    
    { "Major": 0, "Minor": 0, "Revision": 0, "Build": 0 }
    Response Content Type
    
    Hide Response
    
    Request URL
    
    Response Body
    
    Response Code
    
    Response Headers

Parameter	Value	Description	Parameter Type	Data Type
paymentId			path	string
body	Parameter content type:		body	Model Model Schema Allied.Domain.Resources.CancelPaymentResource { Reason (string, optional): String } `{ "Reason": "" }` Click to set as parameter value

assistant : assistant

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

audit : audit

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

auth : auth

Implementation Notes

Response Class

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Request URL

Response Body

Response Code

Response Headers

customerInfo : customerInfo

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

customers : customers

Implementation Notes

Response Class

Parameters

Response Messages

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class

Parameters

Response Messages