POST api/Payment/ProcessCheck/{testProcess}

Processes a check payment

Request Information

URI Parameters

Name	Description	Type	Additional information
testProcess	True if just testing	boolean	Required

Body Parameters

The check object

CheckDto

Name	Description	Type	Additional information
BankAccountNumber	the Checking account number	string	None.
RoutingNumber	the bank account routing number	string	None.
ConfirmationNumber	the confirmation number	string	None.
CheckNumber	the check number	integer	None.
IsACH	A true or false statement on whether the item is or isn't a checking account	boolean	None.
ACHType	The type of bank account	string	None.
CheckType	The type of checking account	string	None.
AccountNumber	The account number related to this payment method	string	None.
Name	The name on the bank account	string	None.
OrderID	The order number	string	None.
PaymentCodeDescription	The description of the payment code	string	None.
User	the user id related processing this payment	string	None.
PaymentTypeDescription	The description of this type of payment method	string	None.
PaymentID	The unique ID for this payment	string	None.
ServiceType	The payment type (I.E PMT, NCR, PRCR)	string	None.
Amount	The amount of the payment	decimal number	None.
PaymentDate	The payment date	date	None.
EntryDate	The date the payment was entered into the system	date	None.
AccountType	The type of the account	string	None.
Currency	The currency for the payment (USD or CDN)	Currency	None.
InternetCodeType	The internet code type. One of {CNS, CLI, IVR, OTHER, NCL}	string	None.
PaymentStatus	The payment status	string	None.
PaymentType	The payment type.	string	None.
SetupDate	The date this payment was set up	date	None.
SetupBy	Who this payment was set up by	string	None.
LastDebitDate	The last debit date	date	None.
LastDeclineDate	The last decline date	date	None.
LastDeclineReason	The reason for the last decline	string	None.
DisabledReason	The reason this payment is disabled	string	None.
RestrictReason	The reason this payment is restricted	string	None.
CanUnrestrict	True if this payment can be unrestricted	boolean	None.
Debug	True if this is being run as a test payment	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "BankAccountNumber": "sample string 1",
  "RoutingNumber": "sample string 2",
  "ConfirmationNumber": "sample string 3",
  "CheckNumber": 4,
  "IsACH": true,
  "ACHType": "sample string 6",
  "CheckType": "sample string 7",
  "AccountNumber": "sample string 8",
  "Name": "sample string 9",
  "OrderID": "sample string 10",
  "PaymentCodeDescription": "sample string 11",
  "User": "sample string 12",
  "PaymentTypeDescription": "sample string 13",
  "PaymentID": "sample string 14",
  "ServiceType": "sample string 15",
  "Amount": 16.1,
  "PaymentDate": "2025-01-09T11:10:56.3694085-07:00",
  "EntryDate": "2025-01-09T11:10:56.3694085-07:00",
  "AccountType": "sample string 19",
  "Currency": 0,
  "InternetCodeType": "sample string 20",
  "PaymentStatus": "sample string 21",
  "PaymentType": "sample string 22",
  "SetupDate": "2025-01-09T11:10:56.3694085-07:00",
  "SetupBy": "sample string 24",
  "LastDebitDate": "2025-01-09T11:10:56.3694085-07:00",
  "LastDeclineDate": "2025-01-09T11:10:56.3694085-07:00",
  "LastDeclineReason": "sample string 27",
  "DisabledReason": "sample string 28",
  "RestrictReason": "sample string 29",
  "CanUnrestrict": true,
  "Debug": true
}

application/xml, text/xml

Sample:

<CheckDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestAPI.Models">
  <AccountNumber>sample string 8</AccountNumber>
  <AccountType>sample string 19</AccountType>
  <Amount>16.1</Amount>
  <CanUnrestrict>true</CanUnrestrict>
  <Currency>USD</Currency>
  <Debug>true</Debug>
  <DisabledReason>sample string 28</DisabledReason>
  <EntryDate>2025-01-09T11:10:56.3694085-07:00</EntryDate>
  <InternetCodeType>sample string 20</InternetCodeType>
  <LastDebitDate>2025-01-09T11:10:56.3694085-07:00</LastDebitDate>
  <LastDeclineDate>2025-01-09T11:10:56.3694085-07:00</LastDeclineDate>
  <LastDeclineReason>sample string 27</LastDeclineReason>
  <Name>sample string 9</Name>
  <OrderID>sample string 10</OrderID>
  <PaymentCodeDescription>sample string 11</PaymentCodeDescription>
  <PaymentDate>2025-01-09T11:10:56.3694085-07:00</PaymentDate>
  <PaymentID>sample string 14</PaymentID>
  <PaymentStatus>sample string 21</PaymentStatus>
  <PaymentType>sample string 22</PaymentType>
  <PaymentTypeDescription>sample string 13</PaymentTypeDescription>
  <RestrictReason>sample string 29</RestrictReason>
  <ServiceType>sample string 15</ServiceType>
  <SetupBy>sample string 24</SetupBy>
  <SetupDate>2025-01-09T11:10:56.3694085-07:00</SetupDate>
  <User>sample string 12</User>
  <ACHType>sample string 6</ACHType>
  <BankAccountNumber>sample string 1</BankAccountNumber>
  <CheckNumber>4</CheckNumber>
  <CheckType>sample string 7</CheckType>
  <ConfirmationNumber>sample string 3</ConfirmationNumber>
  <IsACH>true</IsACH>
  <RoutingNumber>sample string 2</RoutingNumber>
</CheckDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The transaction ID

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.