POST api/CustomerACHTransaction
Allows the bulk submission of transactions for adding AR_ACH records. New transaction will be added while existing transaction will be skipped to avoid duplicate records. Each AR_ACH will be added to a batch based on the tranasction date
Request Information
URI Parameters
None.
Body Parameters
Collection of ACHTransactionName | Description | Type | Additional information |
---|---|---|---|
TraceNumber | string |
String length: inclusive between 0 and 50 |
|
TransactionDate | date |
None. |
|
Description | string |
String length: inclusive between 0 and 250 |
|
Amount | decimal number |
None. |
|
SubmittedDate | date |
None. |
|
ResponseCode | string |
None. |
|
ApprovedDate | date |
None. |
|
CCToken | string |
None. |
|
CCVCode | string |
None. |
|
CCType | string |
None. |
|
CCExpMonth | string |
None. |
|
CCExpYear | string |
String length: inclusive between 0 and 4 |
|
Last4 | string |
None. |
|
BillToFullName | string |
String length: inclusive between 0 and 50 |
|
BillToAddress1 | string |
String length: inclusive between 0 and 50 |
|
BillToAddress2 | string |
String length: inclusive between 0 and 50 |
|
BillToZip | string |
String length: inclusive between 0 and 10 |
|
BillToPlus4 | string |
String length: inclusive between 0 and 10 |
|
eCheckRoutingNumber | string |
String length: inclusive between 0 and 50 |
|
IseCheckChecking | boolean |
None. |
|
AuthorizationCode | string |
String length: inclusive between 0 and 20 |
|
FundingType | string |
None. |
|
SettlementDate | date |
None. |
|
VoidedDate | date |
None. |
|
EnteredBy | string |
None. |
|
IsMobilePayment | boolean |
None. |
|
IsCreditCard | boolean |
None. |
|
CustomerNumber |
Customer Number the customer sees |
string |
None. |
InvoiceNumber |
Invoice Number |
string |
None. |
Request Formats
application/json, text/json
[ { "TraceNumber": "sample string 1", "TransactionDate": "2025-02-16T13:04:10.0277281-06:00", "Description": "sample string 2", "Amount": 3.0, "SubmittedDate": "2025-02-16T13:04:10.0277281-06:00", "ResponseCode": "sample string 4", "ApprovedDate": "2025-02-16T13:04:10.0277281-06:00", "CCToken": "sample string 5", "CCVCode": "sample string 6", "CCType": "sample string 7", "CCExpMonth": "sample string 8", "CCExpYear": "sample string 9", "Last4": "sample string 10", "BillToFullName": "sample string 11", "BillToAddress1": "sample string 12", "BillToAddress2": "sample string 13", "BillToZip": "sample string 14", "BillToPlus4": "sample string 15", "eCheckRoutingNumber": "sample string 16", "IseCheckChecking": true, "AuthorizationCode": "sample string 18", "FundingType": "sample string 19", "SettlementDate": "2025-02-16T13:04:10.0277281-06:00", "VoidedDate": "2025-02-16T13:04:10.0277281-06:00", "EnteredBy": "sample string 20", "IsMobilePayment": true, "IsCreditCard": true, "CustomerNumber": "sample string 23", "InvoiceNumber": "sample string 24" }, { "TraceNumber": "sample string 1", "TransactionDate": "2025-02-16T13:04:10.0277281-06:00", "Description": "sample string 2", "Amount": 3.0, "SubmittedDate": "2025-02-16T13:04:10.0277281-06:00", "ResponseCode": "sample string 4", "ApprovedDate": "2025-02-16T13:04:10.0277281-06:00", "CCToken": "sample string 5", "CCVCode": "sample string 6", "CCType": "sample string 7", "CCExpMonth": "sample string 8", "CCExpYear": "sample string 9", "Last4": "sample string 10", "BillToFullName": "sample string 11", "BillToAddress1": "sample string 12", "BillToAddress2": "sample string 13", "BillToZip": "sample string 14", "BillToPlus4": "sample string 15", "eCheckRoutingNumber": "sample string 16", "IseCheckChecking": true, "AuthorizationCode": "sample string 18", "FundingType": "sample string 19", "SettlementDate": "2025-02-16T13:04:10.0277281-06:00", "VoidedDate": "2025-02-16T13:04:10.0277281-06:00", "EnteredBy": "sample string 20", "IsMobilePayment": true, "IsCreditCard": true, "CustomerNumber": "sample string 23", "InvoiceNumber": "sample string 24" } ]
application/xml, text/xml
<ArrayOfACHTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <ACHTransaction> <Amount>3</Amount> <ApprovedDate>2025-02-16T13:04:10.0277281-06:00</ApprovedDate> <AuthorizationCode>sample string 18</AuthorizationCode> <BillToAddress1>sample string 12</BillToAddress1> <BillToAddress2>sample string 13</BillToAddress2> <BillToFullName>sample string 11</BillToFullName> <BillToPlus4>sample string 15</BillToPlus4> <BillToZip>sample string 14</BillToZip> <CCExpMonth>sample string 8</CCExpMonth> <CCExpYear>sample string 9</CCExpYear> <CCToken>sample string 5</CCToken> <CCType>sample string 7</CCType> <CCVCode>sample string 6</CCVCode> <CustomerNumber>sample string 23</CustomerNumber> <Description>sample string 2</Description> <EnteredBy>sample string 20</EnteredBy> <FundingType>sample string 19</FundingType> <InvoiceNumber>sample string 24</InvoiceNumber> <IsCreditCard>true</IsCreditCard> <IsMobilePayment>true</IsMobilePayment> <IseCheckChecking>true</IseCheckChecking> <Last4>sample string 10</Last4> <ResponseCode>sample string 4</ResponseCode> <SettlementDate>2025-02-16T13:04:10.0277281-06:00</SettlementDate> <SubmittedDate>2025-02-16T13:04:10.0277281-06:00</SubmittedDate> <TraceNumber>sample string 1</TraceNumber> <TransactionDate>2025-02-16T13:04:10.0277281-06:00</TransactionDate> <VoidedDate>2025-02-16T13:04:10.0277281-06:00</VoidedDate> <eCheckRoutingNumber>sample string 16</eCheckRoutingNumber> </ACHTransaction> <ACHTransaction> <Amount>3</Amount> <ApprovedDate>2025-02-16T13:04:10.0277281-06:00</ApprovedDate> <AuthorizationCode>sample string 18</AuthorizationCode> <BillToAddress1>sample string 12</BillToAddress1> <BillToAddress2>sample string 13</BillToAddress2> <BillToFullName>sample string 11</BillToFullName> <BillToPlus4>sample string 15</BillToPlus4> <BillToZip>sample string 14</BillToZip> <CCExpMonth>sample string 8</CCExpMonth> <CCExpYear>sample string 9</CCExpYear> <CCToken>sample string 5</CCToken> <CCType>sample string 7</CCType> <CCVCode>sample string 6</CCVCode> <CustomerNumber>sample string 23</CustomerNumber> <Description>sample string 2</Description> <EnteredBy>sample string 20</EnteredBy> <FundingType>sample string 19</FundingType> <InvoiceNumber>sample string 24</InvoiceNumber> <IsCreditCard>true</IsCreditCard> <IsMobilePayment>true</IsMobilePayment> <IseCheckChecking>true</IseCheckChecking> <Last4>sample string 10</Last4> <ResponseCode>sample string 4</ResponseCode> <SettlementDate>2025-02-16T13:04:10.0277281-06:00</SettlementDate> <SubmittedDate>2025-02-16T13:04:10.0277281-06:00</SubmittedDate> <TraceNumber>sample string 1</TraceNumber> <TransactionDate>2025-02-16T13:04:10.0277281-06:00</TransactionDate> <VoidedDate>2025-02-16T13:04:10.0277281-06:00</VoidedDate> <eCheckRoutingNumber>sample string 16</eCheckRoutingNumber> </ACHTransaction> </ArrayOfACHTransaction>
application/x-www-form-urlencoded
Response Information
Resource Description
Collection of ACHTransactionResponseName | Description | Type | Additional information |
---|---|---|---|
ACHId |
Sedona internal autonumber for the ACH record |
integer |
None. |
TraceNumber | string |
None. |
|
CustomerId |
Foreign key from AR_Customer table |
integer |
None. |
TransactionDate |
Date of the transaction |
date |
None. |
BatchCode |
Batch Code from the AR_ACH_Batch table |
string |
None. |
NewRecord |
Specifies whether or not a new record was added for this transaction; otherwise, an existing record was found with the TraceNumber |
boolean |
None. |
ErrorCode |
Only set when an error occurs during processing; remains null if processing was successful |
integer |
None. |
ErrorMessage |
Only set when an error occurs during processing; remains null if processing was successful |
string |
None. |
Response Formats
application/json, text/json
[ { "ACHId": 1, "TraceNumber": "sample string 2", "CustomerId": 3, "TransactionDate": "2025-02-16T13:04:10.0433568-06:00", "BatchCode": "sample string 5", "NewRecord": true, "ErrorCode": 1, "ErrorMessage": "sample string 7" }, { "ACHId": 1, "TraceNumber": "sample string 2", "CustomerId": 3, "TransactionDate": "2025-02-16T13:04:10.0433568-06:00", "BatchCode": "sample string 5", "NewRecord": true, "ErrorCode": 1, "ErrorMessage": "sample string 7" } ]
application/xml, text/xml
<ArrayOfACHTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <ACHTransactionResponse> <ACHId>1</ACHId> <BatchCode>sample string 5</BatchCode> <CustomerId>3</CustomerId> <ErrorCode>1</ErrorCode> <ErrorMessage>sample string 7</ErrorMessage> <NewRecord>true</NewRecord> <TraceNumber>sample string 2</TraceNumber> <TransactionDate>2025-02-16T13:04:10.0433568-06:00</TransactionDate> </ACHTransactionResponse> <ACHTransactionResponse> <ACHId>1</ACHId> <BatchCode>sample string 5</BatchCode> <CustomerId>3</CustomerId> <ErrorCode>1</ErrorCode> <ErrorMessage>sample string 7</ErrorMessage> <NewRecord>true</NewRecord> <TraceNumber>sample string 2</TraceNumber> <TransactionDate>2025-02-16T13:04:10.0433568-06:00</TransactionDate> </ACHTransactionResponse> </ArrayOfACHTransactionResponse>