Merchant Initiated Host to Host API (v1.1)

Download OpenAPI specification:Download

Support: support@ifsf.org License: IFSF License

The Data Configuration Standard API provides Data for multiple uses.

DCA Connection

Version Interoperability, Logout, Heartbeat

GET/softwareComponents

List of software versions. Used for version interoperability.

Authorizations:

apikeyoauth2

Responses

Response samples

Content type

application/json

{"statusReturn": {"timestamp": "2019-08-24T14:15:22Z",
"result": "success",
"error": "ERRCD_OK",
"message": "string"
},
"softwareComponents": [{"itemID": "string",
"name": "string",
"manufacturerID": "string",
"manufacturerName": "string",
"applicationName": "string",
"applicationSoftwareVersion": "string",
"applicationType": "chp",
"protocol": "string",
"protocolVersion": "string",
"checksum": "string",
"build": "string",
"buildDate": "2019-08-24T14:15:22Z"
}
]
}

POST/connection

Post to initiate the application heartbeat

Authorizations:

apikeyoauth2

Request Body schema: application/json

applicationSender required	string (description100BaseType) <= 100 characters 100 character description.
clientID required	string (description40BaseType) <= 40 characters 40 character description.
timestamp required	string <date-time> (dateTimeType) [ 10 .. 30 ] characters
interfaceVersion	string (description40BaseType) <= 40 characters 40 character description.

Responses

Request samples

Payload

Content type

application/json

{"applicationSender": "string",
"clientID": "string",
"timestamp": "2019-08-24T14:15:22Z",
"interfaceVersion": "string"
}

Response samples

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
}
}

DELETE/connection

Delete to disconnect

Authorizations:

apikeyoauth2

header Parameters

openretailing-application-sender

required

string (description100BaseType) <= 100 characters

Merchant host device connected that can run transactions for different clients

Responses

Response samples

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
}
}