| POST | /payments/creditcard/token | (Deprecated) | (Deprecated) |
|---|---|---|---|
| POST | /payments/creditcard/ref |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GroupId | body | string | Yes | |
| CardNumber | body | string | Yes | |
| CardType | body | string | Yes | Allowable Values
|
| ExpirationMonth | body | int | Yes | |
| ExpirationYear | body | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CardToken | form | string | No | Same as CardReference, however this field is deprecated |
| ErrorMessage | form | string | No | |
| ErrorCode | form | int | No | |
| IsError | form | bool | No | |
| CardReference | form | string | 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/token HTTP/1.1
Host: devapi.billhighway.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"GroupId":"String","CardNumber":"String","CardType":"String","ExpirationMonth":0,"ExpirationYear":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"CardToken":"String","ErrorMessage":"String","ErrorCode":0,"IsError":false,"CardReference":"String"}