Appearance
BLSALE
3 min read
This endpoint authorizes the form of payment and captures the payment.
POST Request Format
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description | Required |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| atoken | Authorization token to allow access to the service | ✔️ |
| entity | This tells the API what database to use for your transactions. | ✔️ |
| store | The unique assignment for your location(s). Merchant accounts are assigned by store/location. Defaults to 1 if not provided | |
| reg | This identifies the POS station, user, terminal or process requesting transaction. Defaults to 1 if not provided | |
| date | Date of the request made to Rover Pay. Supports MM/DD/YYYY or YYYY-MM-DD formats. Defaults to current date if not provided | |
| tran | This is the sequential number for the REG requesting the transaction. Defaults to current time (in seconds) if not provided | |
| invoice | Invoice must be unique per card request in order to request Inquiry from BLINQUIRE | |
| amount | Amount to be authorized with two implied decimal places (example: to specify "$10.00," use "1000"). | ✔️ |
| manual | If flag is set to 0 then it requests an MSR (magnetic stripe), EMV (chip), or NFC (contactless) payment card interaction, else it will request manually-entered data. Defaults to 0 | |
| forcezip | Force ZIP code entry. Set to TRUE to force ZIP, FALSE to skip ZIP, or leave empty to use default AVS settings | |
| level23 | Optional Level 2 / Level 3 transaction data. See Level 2 / Level 3 Data for the schema and validation rules | |
| debug | If flag is set to 1 then error messages will be more verbose. Set to 2 to enable debugger mode |
Example Request (basic)
javascript
{
"atoken": {{atoken}},
"entity": {{entity}},
"store": {{store}},
"reg": {{reg}},
"date": "",
"tran": "rc783",
"invoice": "rc783.1",
"amount": "353",
"manual": "0",
"debug": {{debug}}
}Example Request (with Level 2 / Level 3 data)
javascript
{
"atoken": {{atoken}},
"entity": {{entity}},
"store": {{store}},
"reg": {{reg}},
"date": "",
"tran": "rc783",
"invoice": "rc783.2",
"amount": "1230",
"manual": "0",
"level23": {
"ponumber": "PO-10042",
"taxamnt": "80",
"taxexempt": "N",
"frtamnt": "150",
"dutyamnt": "0",
"orderdate": "20260427",
"shiptozip": "92614",
"shipfromzip": "85284",
"shiptocountry": "US",
"items": [
{
"lineno": "1",
"material": "WIDGET-100",
"description": "Blue widget",
"upc": "012345678905",
"quantity": "2",
"uom": "EA",
"unitcost": "500",
"netamnt": "1000",
"taxamnt": "80"
},
{
"lineno": "2",
"description": "Ground shipping",
"quantity": "1",
"uom": "EA",
"unitcost": "150",
"netamnt": "150",
"taxamnt": "0"
}
]
},
"debug": "0"
}Example Response
| Attribute | Description |
|---|---|
| verified | Flag will be set to 1 if call was successful or 0 if it failed |
| errorCode | Error code, empty if call was successful |
| errorMessage | Error message, empty if call was successful |
| resultId | Result ID that can be used as the reqid field in BLTOKENREFUND |
| auth | Authorization code returned from the processor |
| reference | Authorization reference number returned from the processor |
| cardType | Card type code (e.g., V for Visa, M for Mastercard) |
| cardDesc | Card type description (e.g., Visa, Mastercard) |
| name | Cardholder name returned from the processor |
| token | Card Token returned from the processor |
| expiry | Credit card expiration date (MMYY format) |
| signature | Base64 encoded GZIPPED BMP file of the customer signature (if applicable) |
| avsCode | Address Verification Service (AVS) response code |
| cvvCode | CVV/CVC verification response code |
| fee_amount | Surcharge fee amount (if applicable) |
| fee_authcode | Fee authorization code (if applicable) |
| fee_format | Fee format (if applicable) |
| fee_merchid | Fee merchant ID (if applicable) |
| fee_retref | Fee retrieval reference (if applicable) |
| fee_type | Fee type (if applicable) |
| fee_value | Fee value (if applicable) |
| ccvRec | Base64 encoded string containing the full CCV record |
| level23Errors | Comma-delimited list of Level 2 / Level 3 validation issues, omitted when none. See Level 2 / Level 3 Data |
javascript
{
"verified": "1",
"errorCode": "",
"errorMessage": "",
"resultId": "1*19562*110*rc783*4",
"auth": "123456",
"reference": "203563747337",
"cardType": "V",
"cardDesc": "Visa",
"name": "JOHN DOE",
"token": "9478848718650076",
"expiry": "1222",
"signature": "H4sICAAAAAAC/1NJRy5CTVAA7MuhEcJAAADBe08hTFQqQOBphepSEGXgPiYiHkHErr255+u9VNWjulefUVs1GlWtRz+bcwYAAAAAAABc1+2H9/unFwAAgGvaBwBEpsRWbioAAA==",
"avsCode": "Y",
"cvvCode": "M",
"ccvRec": "NCoqKioqKioqMDA3Nv4xMjIy/v5QUFMxNTL+MjAzNTYzNzQ3MzM3/v5FTkNSWVBURUT+Vv5WaXNh/v5Q/v5bRDIwXSBDaGFyZ2UgQWNjZXB0ZWQu/v7+/v7+MSoxOTU2MioxMTAqcmM3ODMqNP7+/v7+/v7+/v7+/jEwMDD+/v7+/v7+/kNDLUFVVEj+OTQ3ODg0ODcxODY1MDA3Nv5CT0xU/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+IP5Y/nJjNzAz/kg0c0lDQUFBQUFBQy8xTkpSeTVDVFZBQTdNdWhFY0pBQUFEQmUwOGhURlFxUU9CcGhlcFNFR1hnUGlZaUhrSEVycjI1NSt1OVZOV2p1bGVmVVZzMUdsV3RSeitiY3dZQUFBQUFBQUJjMSsySDkvdW5Gd0FBZ0d2YUJ3QkVwc1JXYmlvQUFBPT0="
}