| POST | /payments/CreditCard/Verify | Performs 0 dollar verify of a credit card. | Validates the credit card type, expiration date and performs credit card address verification against the credit card networks. |
|---|
export class CreditCardVerifyReply implements IHaveErrorField
{
public UniqueId?: string;
public ErrorCode?: number;
public ErrorMessage?: string;
public CardRef?: string;
public IsError?: boolean;
public constructor(init?: Partial<CreditCardVerifyReply>) { (Object as any).assign(this, init); }
}
export class SalesForceCreditCardVerify
{
public UniqueId?: string;
public ClientId?: number;
public GroupId?: string;
public UserId?: string;
public BhUserId?: number;
public Location?: string;
public CurrencyCode?: string;
public NameOnCard?: string;
public Address1?: string;
public Address2?: string;
public City?: string;
public State?: string;
public PostalCode?: string;
public VerifyPostalCode?: boolean;
public Country?: string;
public CardType?: string;
public CardReferenceOrCardNumber?: string;
public ExpMonth?: number;
public ExpYear?: number;
public Cvv?: string;
public Amount?: number;
public ChapAndUser?: string;
public Description?: string;
public PayLinkID?: number;
public constructor(init?: Partial<SalesForceCreditCardVerify>) { (Object as any).assign(this, init); }
}
TypeScript SalesForceCreditCardVerify DTOs
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 /payments/CreditCard/Verify HTTP/1.1
Host: devapi.billhighway.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SalesForceCreditCardVerify xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
<Address1>String</Address1>
<Address2>String</Address2>
<Amount>0</Amount>
<BhUserId>0</BhUserId>
<CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
<CardType>String</CardType>
<ChapAndUser>String</ChapAndUser>
<City>String</City>
<ClientId>0</ClientId>
<Country>String</Country>
<CurrencyCode>String</CurrencyCode>
<Cvv>String</Cvv>
<Description>String</Description>
<ExpMonth>0</ExpMonth>
<ExpYear>0</ExpYear>
<GroupId>String</GroupId>
<Location>String</Location>
<NameOnCard>String</NameOnCard>
<PayLinkID>0</PayLinkID>
<PostalCode>String</PostalCode>
<State>String</State>
<UniqueId>String</UniqueId>
<UserId>String</UserId>
<VerifyPostalCode>false</VerifyPostalCode>
</SalesForceCreditCardVerify>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CreditCardVerifyReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce"> <CardRef>String</CardRef> <ErrorCode>0</ErrorCode> <ErrorMessage>String</ErrorMessage> <UniqueId>String</UniqueId> </CreditCardVerifyReply>