POST api/v100/stores/{storeID}/pumps/{pumpID}/authorize

Authorizes a fuel sale at a specific pump.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
storeID

Store In use.

string

Required

pumpID

Pump ID to reserve.

integer

Required

Headers

NameDescriptionTypeAdditional information
appkey

Ej. abcdefghijk

None.

session

Ej. 1234567890

None.

Body Parameters

RqPumpAuthorize
NameDescriptionTypeAdditional information
sendEmail

Send Email with the receipt

boolean

Required

token

Token for Card

string

Required

amount

Amount used to Authorize Transaction

decimal number

None.

currencyISOCode

Currency ISOCode

string

None.

PIN

Pin of the User to Authorize the transaction

string

String length: inclusive between 0 and 50

tokenLoyalty

Token for Card to credit points

string

None.

Request Formats

application/json, text/json

Sample:
{
  "sendEmail": true,
  "token": "sample string 2",
  "amount": 3.0,
  "currencyISOCode": "sample string 4",
  "PIN": "sample string 5",
  "tokenLoyalty": "sample string 6"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RqPumpAuthorize'.

Response Information

Resource Description

RsTransaction
NameDescriptionTypeAdditional information
transactionID

Transaction ID

integer

Required

currencyISOCode

Currency ISOCode

string

Required

currencySymbol

Currency Symbol

string

Required

requestedAmount

Requested Amount

decimal number

Required

authorizedAmount

Authorized Amount

decimal number

None.

finalizedAmount

Finalized Amount

decimal number

None.

status

Status

TransactionStatusEnum

Required

result

Includes Result Code Information. See Return Codes Section below. Pumps RsResultUsed
Transactions RsResultUsed

Result

Required

Prompts

Prompts

Collection of RsPrompts

None.

Response Formats

application/json, text/json

Sample:
{
  "transactionID": 1,
  "currencyISOCode": "sample string 2",
  "currencySymbol": "sample string 3",
  "requestedAmount": 4.0,
  "authorizedAmount": 1.0,
  "finalizedAmount": 1.0,
  "status": 0,
  "result": null,
  "Prompts": [
    {
      "PromptID": "sample string 1",
      "Message": "sample string 2",
      "Mask": "sample string 3"
    },
    {
      "PromptID": "sample string 1",
      "Message": "sample string 2",
      "Mask": "sample string 3"
    }
  ]
}