Class HoldAllCreditsResponse
Properties
NAME | TYPE | LENGTH | DESCRIPTION |
---|---|---|---|
RequestId | int | Value provided by the user to identify the request. The element can be blank or null. | |
Result | Result | Possible responses are:
| |
Message | string | Message text to display to client. | |
Results | HoldAllCredits[] | Array of Hold All Credits |
HoldAllCredits
NAME | TYPE | LENGTH | DESCRIPTION |
---|---|---|---|
AccountNumber | string | 17 | Last 4 digits only displayed. |
AccountType | WSAccountType | Possible responses are:
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 | |
Amount | decimal | Dollar amount of the transaction. | |
BatchStatus | string | Possible responses are:
| |
CompanyId | string | 10 | Custom location identification provided by the entity. |
DfiId | int | Unique identifier of the processor, or depository financial institution. | |
EffectiveDate | DateTime | Date of the transaction. | |
EntityId | int | Unique identifier that is generated by EPS. | |
EntityName | string | 120 | Custom name used to identify the merchant. |
GleId | bigint | Unique numeric identifier of ACH batches. | |
LocationId | int | Unique identifier generated by EPS for each location. | |
LocationName | string | 120 | Custom name to identify the location. |
ProcessingStatus | tinyint | 1 | Indicates the processing status of a merchant or location.
|
ProcessingSystem | tinyint | 1 | System used to process the Gle. Possible values include:
|
Rcode | string | 3 | Identifies the type of return (i.e. R01, R29). |
RoutingNumber | string | 9 | Zeroes 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>