POST | /api/CreditCard/Sale | Performs a credit card sale | Performs a low level credit card charge WITHOUT recording credit the as a deposit or payment. This shouldbe used only in conjunction with code that records the credit. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsDuplicate | form | bool | No | |
IsSuccessful | form | bool | No | |
ErrorCode | form | string | No | |
Message | form | string | No | |
GatewayId | form | int? | No | |
ConfirmationNumber | form | string | No | |
NetworkTransactionId | form | string | No | |
IsError | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/CreditCard/Sale HTTP/1.1
Host: devapi.billhighway.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreditCardSale xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
<Address1 xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Address1>
<Address2 xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Address2>
<Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
<AutoPay xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">false</AutoPay>
<BhUserId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</BhUserId>
<CVV xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CVV>
<CardNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CardNumber>
<CardType xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">AmericanExpress</CardType>
<ChapAndUser xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ChapAndUser>
<City xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</City>
<ClientId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ClientId>
<Country xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Country>
<CurrencyCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CurrencyCode>
<Description xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Description>
<ExpMonth xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ExpMonth>
<ExpYear xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ExpYear>
<GroupId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</GroupId>
<Location xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Location>
<NameOnCard xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</NameOnCard>
<NetworkTransactionID xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</NetworkTransactionID>
<PayLinkID xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</PayLinkID>
<PaymentSourceID xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</PaymentSourceID>
<PaymentSourceTypeID xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</PaymentSourceTypeID>
<PostalCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</PostalCode>
<ProcessingType xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">Default</ProcessingType>
<State xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</State>
<StoreCardInfo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">false</StoreCardInfo>
<UniqueId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</UniqueId>
<UserId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</UserId>
</CreditCardSale>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CreditCardSaleResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO"> <ConfirmationNumber>String</ConfirmationNumber> <ErrorCode>String</ErrorCode> <GatewayId>0</GatewayId> <IsDuplicate>false</IsDuplicate> <IsSuccessful>false</IsSuccessful> <Message>String</Message> <NetworkTransactionId>String</NetworkTransactionId> </CreditCardSaleResult>