| 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. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UniqueId | body | string | No | |
| ClientId | body | int | No | |
| GroupId | body | string | No | |
| UserId | body | string | No | |
| BhUserId | body | int | No | |
| Location | body | string | No | |
| CurrencyCode | body | string | No | |
| NameOnCard | body | string | No | |
| Address1 | body | string | No | |
| Address2 | body | string | No | |
| City | body | string | No | |
| State | body | string | No | |
| PostalCode | body | string | No | |
| VerifyPostalCode | body | bool | No | |
| Country | body | string | No | |
| CardType | body | string | No | |
| CardReferenceOrCardNumber | body | string | No | |
| ExpMonth | body | int | No | |
| ExpYear | body | int | No | |
| Cvv | body | string | No | |
| Amount | body | decimal | No | |
| ChapAndUser | body | string | No | |
| Description | body | string | No | |
| PayLinkID | body | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UniqueId | form | string | No | |
| ErrorCode | form | int | No | |
| ErrorMessage | form | string | No | |
| CardRef | form | string | No | |
| IsError | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"UniqueId":"String","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Location":"String","CurrencyCode":"String","NameOnCard":"String","Address1":"String","Address2":"String","City":"String","State":"String","PostalCode":"String","VerifyPostalCode":false,"Country":"String","CardType":"String","CardReferenceOrCardNumber":"String","ExpMonth":0,"ExpYear":0,"Cvv":"String","Amount":0,"ChapAndUser":"String","Description":"String","PayLinkID":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"UniqueId":"String","ErrorCode":0,"ErrorMessage":"String","CardRef":"String","IsError":false}