EXTERNAL_Mobile_Payment_Fleet_Api_-EN.md

External PFEP Fleet Mobile Payment Api

Document Information
File:	ATIONet - Dynamic QR Code Payments
Doc Version:	1.0
Release Date:	2, September 2021
Author:	ATIONet LLC

Change Log
Ver.	Date	Change Summary
1.0	2/September/2021	Initial version.

Contents

• Overview
  • Introduction
• Message Structure
  • PreAuthorizedPayments
    • Request Format
    • Response Format
• Field Descriptions
• Error Handling
• Transactions States
• Response Codes
• Message Samples

Overview

This document is part of Ationet Fleet Mobile Payment Fully Integrated and only describe Mobile Payment Solution flow in which the PFEP is an external agent to ATIONet.

Sequence diagram Pay at Pump with external PFEP

Transaction states sequence diagram on Pre authorization Request

API Details

API URI: ationetmobilepayment-appshost-test.azurewebsites.net/

Message Structure

This section describe the message structure for each API Method available, as well as the responses messages for each one.

PreAuthorizedPayments

Create a Sale with external authorization. The sale creation recibes an ID, if this ID already exists then the method returns the Sale's Id.

Request Format

URL: /api/PreAuthorizedPayments
Method: POST
Body: { "siteCode":"string", "pumpNumber":integer, "fuelCode":"string", "amount":double, "mobilePaymentMode":integer, "potencyKeyId":"string", "externalReferanceID":"string" }

Response Format

Header:

Content-Type: application/json; charset=utf-8
content-encoding: gzip 

Body: { “TransactionId”:”StringValue” }

Field Descriptions

This section describe through a table all parameters from request.

Paramether	Type	Description
			siteCode	string	The site code
			pumpNumber	integer	The pump number
fuelCode	string	The fuel code
amount	double	Number of liters of fuel to dispatch
mobilePaymentMode	integer	The operation mode Code. It can be for 1 for Fullintegrated
potencyKeyId	string	The Transaction's ID
externalReferenceID	string	Authorization reference ID

Error Handling

Success/failure exits on the Native Transaction Protocol will be handled via HTTP status codes.

Successful request will get a HTTP 200 and the resulting response.

Failure to process the request will be indicated by an HTTP 400’s range status code.

Transactions States

This section describe through a table all states that a sale can have.

State name	ID	Message
			Created	1	Created
FuelPointAuthorizationRequested	4	FuelPoint Authorization Requested
PumpReserveAccepted	5	Site System Accept Pump Reserve
PumpReserveRefused	6	Site System not Accept Pump Reserve
FuelPointAuthorized	7	Fuel Point Authorized
CanceledByFuelPoint	8	Canceled By Fuel Point
Fueling	9	Fueling
Complete	10	Complete
CancelationRequested	12	Cancelation Requested
CanceledByUser	13	Canceled By User
CanceledBySiteSystem	14	Canceled By Site System
FuelPointDeauthorizationRequested	15	Fuel Point Deauthorization Requested
SessionError	16	Session not available
UnknownError	17	Unknown error when trying to connect with session
SiteSystemError	18	Site System Generic error
SiteSystemError	19	Cancelled By MPPA

Response Codes

Both methos response the same codes.

Code	Description
		200	Success
		400	Bad request

Message Samples

PreAuthorizedPayments

Request Example

{
  "siteCode": "1524",
  "pumpNumber": 1,
  "fuelCode": "3",
  "amount": 9,
  "mobilePaymentMode": 1,
  "potencyKeyId": "5734cbb9-f78f-4ad4-aa87-79ed95181c5a",
  "externalReferanceID": "854712"
}

Response Example

{
  "transactionId": "5734cbb9-f78f-4ad4-aa87-79ed95181c5a"
}