GetHoldAllCredits
- Method
- Example Request
- Example Response
GetHoldAllCredits(HoldAllCreditsRequest)
The purpose of this operation is to create a list all merchants and their locations, of an owning entity, that are in a Hold All Credits processing status.
Parameters
TYPE | NAME | DESCRIPTION |
---|---|---|
HoldAllCreditsRequest | request |
Returns
TYPE | DESCRIPTION |
---|---|
HoldAllCreditsResponse |
<GetHoldAllCredits>
<MethodParameters>
<request>
<Credentials>
<EntityId>12345</EntityId>
<StoreId>987654</StoreId>
<StoreKey>wCgMQun4HQBXXzsGZrZtCcpTT6xh</StoreKey>
</Credentials>
<RequestDate>10/18/2017 12:57:57 PM</RequestDate>
<RequestId isNull="false" />
</request>
</MethodParameters>
</GetHoldAllCredits>
<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>