Skip to main content

Class HoldAllCreditsResponse


Properties

NAMETYPELENGTHDESCRIPTION
RequestIdintValue provided by the user to identify the request. The element can be blank or null.
ResultResultPossible responses are:
  • Success
  • Error
MessagestringMessage text to display to client.
ResultsHoldAllCredits[]Array of Hold All Credits

HoldAllCredits

NAMETYPELENGTHDESCRIPTION
AccountNumberstring17Last 4 digits only displayed.
AccountTypeWSAccountTypePossible responses are:
  • Checking
  • Savings


AccountType Description

0              Customer

1              Holding

2              NetSettlement

3              Settlement

4              Billing

5              Return

6              Reserve

7              DiscountRate

8              Collection Settlements/Returns

9              NSF Fee Settlements/Returns

10           Convenience Fee Settlements/Returns

11           Sweep

12          Card Funding

13          Credit/Refund

100          Custom1

101          Custom2

102          Custom3

103          Billing Convenience Fee

104          Custom5
AmountdecimalDollar amount of the transaction.
BatchStatusstringPossible responses are:
  • Returned
  • Suspended
CompanyIdstring10Custom location identification provided by the entity.
DfiIdintUnique identifier of the processor, or depository financial institution.
EffectiveDateDateTimeDate of the transaction.
EntityIdintUnique identifier that is generated by EPS.
EntityNamestring120Custom name used to identify the merchant.
GleIdbigintUnique numeric identifier of ACH batches.
LocationIdintUnique identifier generated by EPS for each location.
LocationNamestring120Custom name to identify the location.
ProcessingStatustinyint1Indicates the processing status of a merchant or location.
  • 0 = Normal
  • 1  = Hold All Credits
  • 2  = Off
ProcessingSystemtinyint1System used to process the Gle.

Possible values include:
  • System used to process the Gle.
  • 0 - ACH
  • 1-    Credit Card
  • 2-    Wire
  • 3-    Check21
  • 4-    Online Payment
  • 5-    Cash Payment
  • 6-    Payment Service
Rcodestring3Identifies the type of return (i.e. R01, R29).
RoutingNumberstring9Zeroes will display for Credit Card transactions.

Examples

<GetHoldAllCredits>
<MethodParameters>
<HoldAllCreditsResponse>
<Results attr0="HoldAllCreditsArray" isNull="false">
<HoldAllCreditsArray0>
<AccountNumber>0002</AccountNumber>
<AccountType>Settlement</AccountType>
<Amount>22.00</Amount>
<BatchStatus>Returned</BatchStatus>
<CompanyId isNull="false" />
<DfiId>13106</DfiId>
<EffectiveDate>10/19/2017 12:00:00 AM</EffectiveDate>
<EntityId>96057</EntityId>
<EntityName>Test Merchant Name</EntityName>
<GleId>11114161422</GleId>
<LocationId>321497</LocationId>
<LocationName>Test Location 1</LocationName>
<ProcessingStatus>HoldAllCredits</ProcessingStatus>
<ProcessingSystem>ACH</ProcessingSystem>
<Rcode>R03</Rcode>
<RoutingNumber>122037760</RoutingNumber>
</HoldAllCreditsArray0>
<HoldAllCreditsArray1>
<AccountNumber isNull="false" />
<AccountType>Customer</AccountType>
<Amount>20.00</Amount>
<BatchStatus>Suspended</BatchStatus>
<CompanyId isNull="false" />
<DfiId>13106</DfiId>
<EffectiveDate>9/18/2017 12:00:00 AM</EffectiveDate>
<EntityId>96057</EntityId>
<EntityName>Test Merchant Name</EntityName>
<GleId>11113976198</GleId>
<LocationId>321497</LocationId>
<LocationName>Test Location 1</LocationName>
<ProcessingStatus>HoldAllCredits</ProcessingStatus>
<ProcessingSystem>ACH</ProcessingSystem>
<Rcode isNull="false" />
<RoutingNumber isNull="false" />
</HoldAllCreditsArray1>
</Results>
<Message>Success.</Message>
<RequestId isNull="false" />
<Result>Success</Result>
</HoldAllCreditsResponse>
</MethodParameters>
</GetHoldAllCredits>


Response if no merchants are in Hold All Credits status:

<GetHoldAllCredits>
<MethodParameters>
<HoldAllCreditsResponse>
<Results attr0="HoldAllCreditsArray" isNull="false" />
<Message>Success.</Message>
<RequestId isNull="false" />
<Result>Success</Result>
</HoldAllCreditsResponse>
</MethodParameters>
</GetHoldAllCredits>