EPS API Collection (1.0.0)

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"poiAddresses": [{"logicalID": "001",
"poiID": "3e08c0a1-c08b-41b6-a9b9-78cb81b868d9",
"workstationType": "pointOfService"
},
{"logicalID": "002",
"poiID": "6e08c0a1-c08b-41b6-a9b9-78cb81b83312",
"workstationType": "pointOfService"
},
{"logicalID": "001",
"poiID": "7777c0a1-c08b-41b6-a9b9-78cb81b83312",
"workstationType": "fuelingPoint"
}
]
}

/POIs/iccStart/{iccStartID}

Upon receiving the iccStartAvailableEvent, request information about the transaction needed to process an ICC card

Authorizations:

path Parameters

iccStartID

required

string (id40BaseType) [ 1 .. 40 ] characters

The icc start identifier created by the EPS.

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"iccStartID": "ab64d0b2-8b31-4c90-a3b3-ff83cb10f8f8",
"iccAmount": {"value": "25.00",
"currency": "USD"
},
"chipData": [{"chipTagData": {"tag": "4A",
"value": "A000000100000"
}
},
{"chipTagData": {"tag": "57",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
},
{"chipParameterData": {"iccParameter": "aidName",
"value": "Conexxus AID"
}
},
{"chipParameterData": {"iccParameter": "ddolDefault",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
}
]
}

/POIs/iccStart/{iccStartID}

Provide information gathered during ICC processing.

Authorizations:

path Parameters

iccStartID

required

string (id40BaseType) [ 1 .. 40 ] characters

The icc start identifier created by the EPS.

Request Body schema: application/json

connectionID required	string (connectionIDType) [ 1 .. 1024 ] characters The site reference ID is created by the Host. It is used in subsequent requests. It avoids the need to send all vendor information on subsequent requests.
iccStartID required	string (id40BaseType) [ 1 .. 40 ] characters 40 character ID
required	object (statusReturn) 'status' (defined in the API Data dictionary as "statusReturn.yaml") should be the first property returned at the beginning of reach response. 'timestamp' and 'result' are required properties inside this 'status' property. 'error' and 'message' give more information and may therefore unsuitable for production, and are therefore optional. 'uuid' is included specifically for FACTORY INTEGRATION, FACTORY PRE-CERTIFICATION, and FACTORY CERTIFICATION support, where returned errors may use 'uuid' to provide more information (like validation results) than should be returned in a production implementation.
required	Array of objects (chipDataObject) [ 0 .. 100 ] items [ items ] The chip data information acquired at the POI.

Responses

Request samples

Payload

Content type

application/json

{"connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5",
"iccStartID": "e68ee6a7-4ce9-4981-b8a0-fc16d9b9accd",
"statusNotification": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"chipData": [{"chipTagData": {"tag": "9f26",
"value": "80"
}
},
{"chipTagData": {"tag": "57",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
}
]
}

Response samples

200
400
500

Content type

application/json

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

/POIs/iccCompletion/{iccCompletionID}

Upon receiving the iccCompletionAvailableEvent, request information needed to complete the ICC Transaction

Authorizations:

path Parameters

iccCompletionID

required

string (id40BaseType) [ 1 .. 40 ] characters

The icc completion identifier created by the EPS.

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"iccCompletionID": "ab64d0b2-8b31-4c90-a3b3-ff83cb10f8f8",
"iccAmount": {"value": "25.00",
"currency": "USD"
},
"chipData": [{"chipTagData": {"tag": "4A",
"value": "A000000100000"
}
},
{"chipTagData": {"tag": "57",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
},
{"chipParameterData": {"iccParameter": "aidName",
"value": "Conexxus AID"
}
},
{"chipParameterData": {"iccParameter": "ddolDefault",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
}
]
}

/POIs/iccCompletion/{iccCompletionID}

Provide information gathered from completing the ICC processing

Authorizations:

path Parameters

iccCompletionID

required

string (id40BaseType) [ 1 .. 40 ] characters

The icc completion identifier created by the EPS.

Request Body schema: application/json

connectionID required	string (connectionIDType) [ 1 .. 1024 ] characters The site reference ID is created by the Host. It is used in subsequent requests. It avoids the need to send all vendor information on subsequent requests.
iccCompletionID required	string (id40BaseType) [ 1 .. 40 ] characters 40 character ID
required	object (statusReturn) 'status' (defined in the API Data dictionary as "statusReturn.yaml") should be the first property returned at the beginning of reach response. 'timestamp' and 'result' are required properties inside this 'status' property. 'error' and 'message' give more information and may therefore unsuitable for production, and are therefore optional. 'uuid' is included specifically for FACTORY INTEGRATION, FACTORY PRE-CERTIFICATION, and FACTORY CERTIFICATION support, where returned errors may use 'uuid' to provide more information (like validation results) than should be returned in a production implementation.
required	Array of objects (chipDataObject) [ 0 .. 100 ] items [ items ] The chip data information acquired at the POI.

Responses

Request samples

Payload

Content type

application/json

{"connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5",
"iccCompletionID": "e68ee6a7-4ce9-4981-b8a0-fc16d9b9accd",
"statusNotification": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"chipData": [{"chipTagData": {"tag": "9f26",
"value": "80"
}
},
{"chipTagData": {"tag": "57",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
}
]
}

Response samples

200
400
500

Content type

application/json

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

/POIs/iccCardRemoval/{iccCardRemovalID}

Upon receiving the iccRemoveCardEvent, Provide information confirming card removal

Authorizations:

path Parameters

iccCardRemovalID

required

string (id40BaseType) [ 1 .. 40 ] characters

The icc card removal identifier created by the EPS.

Request Body schema: application/json

connectionID required	string (connectionIDType) [ 1 .. 1024 ] characters The site reference ID is created by the Host. It is used in subsequent requests. It avoids the need to send all vendor information on subsequent requests.
iccCardRemovalID required	string (id40BaseType) [ 1 .. 40 ] characters 40 character ID
required	object (statusReturn) 'status' (defined in the API Data dictionary as "statusReturn.yaml") should be the first property returned at the beginning of reach response. 'timestamp' and 'result' are required properties inside this 'status' property. 'error' and 'message' give more information and may therefore unsuitable for production, and are therefore optional. 'uuid' is included specifically for FACTORY INTEGRATION, FACTORY PRE-CERTIFICATION, and FACTORY CERTIFICATION support, where returned errors may use 'uuid' to provide more information (like validation results) than should be returned in a production implementation.

Responses

Request samples

Payload

Content type

application/json

{"connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5",
"iccCardRemovalID": "e68ee6a7-4ce9-4981-b8a0-fc16d9b9accd",
"statusNotification": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
}
}

Response samples

200
400
500

Content type

application/json

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

/POIs/aidCanidateListUpdate

This request will be performed by the POI when it needs an AID to be selected from a candidate list.

Authorizations:

Request Body schema: application/json

connectionID required	string (connectionIDType) [ 1 .. 1024 ] characters The site reference ID is created by the Host. It is used in subsequent requests. It avoids the need to send all vendor information on subsequent requests.
poiID required	string (id80BaseType) [ 1 .. 80 ] characters 80 character ID
aidCandidateList required	Array of strings (iccAIDType) <= 10 items [ items [ 10 .. 40 ] characters ([A-Fa-f0-9]{10,32}) ]

Responses

Request samples

Payload

Content type

application/json

{"connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5",
"poiID": "703ef3b9-dc4b-4240-a81a-85e392ac9fb6",
"aidCandidateList": ["A00000031310",
"A20231231232"
]
}

Response samples

200
400
500

Content type

application/json

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

/POIs/registration

The POI registers with its unique identifier and capabilities.

Authorizations:

Request Body schema: application/json

poiID required	string (id80BaseType) [ 1 .. 80 ] characters 80 character ID
logicalID	string (id4BaseType) [ 1 .. 4 ] characters 4 character ID
	object (poiCapabilitiesObject) POI address object.

Responses

Request samples

Payload

Content type

application/json

{"poiID": "1231231231209382018302130",
"capabilities": {"chipCardCapable": "yes",
"msrCapable": "yes",
"printerCapable": "yes",
"scannerCapable": "yes"
}
}

Response samples

200
400
500

Content type

application/json

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

/POIs/cardAcquisition/{cardAcquisitionID}

Upon receiving the cardAcquisitionEvent, request information about the transaction needed to acquire the card information

Authorizations:

path Parameters

cardAcquisitionID

required

string (id40BaseType) [ 1 .. 40 ] characters

The card acquistion identifier is a unique identifier created by the EPS when requesting a card acquisition from the POI.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"timestamp": "2021-06-18T12:55:00",
"chipData": [{"chipTagData": {"tag": "9F02",
"value": "00000000001000"
}
},
{"chipTagData": {"tag": "9F03",
"value": "00000000000000"
}
},
{"chipTagData": {"tag": "4F"
}
},
{"chipTagData": {"tag": "50"
}
},
{"chipTagData": {"tag": "57"
}
}
],
"prompt": {"promptID": "123456",
"textLines": [{"text": "Please, insert or swipe",
"language": "eng"
},
{"text": "your card",
"language": "eng"
}
],
"input": {"target": "poi",
"minLen": 2,
"maxLen": 3,
"defaultValue": "yes",
"inputType": "menu",
"options": [{"optionKey": "yes",
"optionText": {"text": "YES",
"language": "eng"
}
},
{"optionKey": "no",
"optionText": {"text": "NO",
"language": "eng"
}
}
]
}
}
}

/POIs/cardAcquisition/{cardAcquisitionID}

Provide information acquired from the card

Authorizations:

path Parameters

cardAcquisitionID

required

string (id40BaseType) [ 1 .. 40 ] characters

The card acquistion identifier is a unique identifier created by the EPS when requesting a card acquisition from the POI.

Request Body schema: application/json

connectionID required	string (connectionIDType) [ 1 .. 1024 ] characters The site reference ID is created by the Host. It is used in subsequent requests. It avoids the need to send all vendor information on subsequent requests.
required	object (cardDataObject) The entry method and the card instrument acquired by the POI.
poiID required	string (id80BaseType) [ 1 .. 80 ] characters 80 character ID

Responses

Request samples

Payload

Content type

application/json

{"connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5",
"poiID": "703ef3b9-dc4b-4240-a81a-85e392ac9fb6",
"cardInstrument": {"cardData": {"entryMethod": "chip-EMV",
"instrument": {"chipDataList": [{"chipTagData": {"tag": "4A",
"value": "A000000100000"
}
},
{"chipTagData": {"tag": "57",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
},
{"chipParameterData": {"iccParameter": "aidName",
"value": "Conexxus AID"
}
},
{"chipParameterData": {"iccParameter": "ddolDefault",
"secureValue": "bO7a3lxn90wdFuTwbi+g6MuuTq4x0Z+k3Wwk7z+eQdFbVhaanA2a2x4J4eapZY6y/a92afQ7xhjzU0NBx+bp65jCiu3BmwkCYXEx1J5CrGa5jKVyCT+wouEO4ES5uqZkVpDii2eaTMYHJiDflanKHM1G5+tpg5PMz3rSLf4D5sPxQeYurjdgQ9xIzRsC+nbE4dpA4bhBqhFd+3/Eqmnt1Kk490kY9SIQG6GM8Kk52ogVdZuemDj/40bL8hOv/i81i2NgJwekhf2rqnicbXkoivYCIidD4rYSP7x25nIRwnkTxGsNxCQVpyo+YU54yDBQWED0quQ7ip0UXh2qNxoVhg=="
}
}
]
}
}
}
}

Response samples

200
400
500

Content type

application/json

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

/prompt/{promptID}

Upon receiving the promptAvailableEvent, request information about the prompt desired

Authorizations:

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"promptID": "e68ee6a7-4ce9-4981-b8a0-fc16d9b9accd",
"lines": ["PLEASE, ENTER THE",
"INFORMATION REQUESTED",
"THANK YOU FOR SHOPPING",
"WITH US TODAY"
],
"input": {"target": "pos",
"minLen": 2,
"maxLen": 3,
"defaultValue": "yes",
"inputType": "menu",
"options": [{"optionKey": "yes",
"optionText": "YES"
},
{"optionKey": "no",
"optionText": "NO"
}
]
}
}

/prompt/{promptID}

Provide information about the prompt data acquired.

Authorizations:

Request Body schema: application/json

connectionID required	string (connectionIDType) [ 1 .. 1024 ] characters The site reference ID is created by the Host. It is used in subsequent requests. It avoids the need to send all vendor information on subsequent requests.
promptID required	string (id40BaseType) [ 1 .. 40 ] characters 40 character ID
required	object (statusReturn) 'status' (defined in the API Data dictionary as "statusReturn.yaml") should be the first property returned at the beginning of reach response. 'timestamp' and 'result' are required properties inside this 'status' property. 'error' and 'message' give more information and may therefore unsuitable for production, and are therefore optional. 'uuid' is included specifically for FACTORY INTEGRATION, FACTORY PRE-CERTIFICATION, and FACTORY CERTIFICATION support, where returned errors may use 'uuid' to provide more information (like validation results) than should be returned in a production implementation.
value	string [ 0 .. 500 ] characters

Responses

Request samples

Payload

Content type

application/json

{"connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5",
"promptID": "e68ee6a7-4ce9-4981-b8a0-fc16d9b9accd",
"statusNotification": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"value": "yes"
}

Response samples

200
400
500

Content type

application/json

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

/receipt/{receiptID}

Upon receiving the receiptAvailableEvent, request the receipt data

Authorizations:

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"receiptID": "0d1d9f51-6540-4cbd-ae0c-13bd224e8057",
"mandatory": "yes",
"numberOfCopies": 2,
"target": "customer",
"lines": ["TRANSACTION APPROVED",
"CREDIT",
"***********1234",
"AUTH#: 123456",
"REFERENCE #: REF123",
"INVOICE #: INV1234",
"BATCH #: 1",
"BATCH SEQ: 123456",
"FEP NAME: PAYMENT",
"EMV:",
"AID: A1234567890123456",
"AC: TRQC",
"THANK YOU FOR SHOPPING",
"WITH US TODAY"
]
}

/receipt/{receiptID}

Provide confirmation that the receipt has been printed. It is an optional message only required if the mandatory flag in the reponse to the GET /receipt request is set to yes.

Authorizations:

Request Body schema: application/json

connectionID	string (connectionIDType) [ 1 .. 1024 ] characters The site reference ID is created by the Host. It is used in subsequent requests. It avoids the need to send all vendor information on subsequent requests.
receiptID	string (id40BaseType) [ 1 .. 40 ] characters 40 character ID
	object (statusReturn) 'status' (defined in the API Data dictionary as "statusReturn.yaml") should be the first property returned at the beginning of reach response. 'timestamp' and 'result' are required properties inside this 'status' property. 'error' and 'message' give more information and may therefore unsuitable for production, and are therefore optional. 'uuid' is included specifically for FACTORY INTEGRATION, FACTORY PRE-CERTIFICATION, and FACTORY CERTIFICATION support, where returned errors may use 'uuid' to provide more information (like validation results) than should be returned in a production implementation.

Responses

Request samples

Payload

Content type

application/json

{"connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5",
"receiptID": "e68ee6a7-4ce9-4981-b8a0-fc16d9b9accd",
"statusNotification": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
}
}

Response samples

200
400
500

Content type

application/json

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

/POIs/{poiID}/aidsConfiguration

Upon receiving the iccUpdateAIDConfigurationEvent, request the AID configuration for the POI ID

Authorizations:

path Parameters

poiID

required

string (id80BaseType) [ 1 .. 80 ] characters

The Point of Interaction ID for the device performing the operation.

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"aidsConfiguration": [{"aid": "A0000000030101",
"configuration": [{"chipParameterData": {"iccParameter": "aidName",
"value": "Conexxus AID"
}
},
{"chipParameterData": {"iccParameter": "tacDefault",
"value": "0000000000"
}
}
]
}
]
}

/POIs/{poiID}/aidRules

Upon receiving the iccUpdateAIDRulesEvent, request the AID rules for the POI ID

Authorizations:

path Parameters

poiID

required

string (id80BaseType) [ 1 .. 80 ] characters

The Point of Interaction ID for the device performing the operation.

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"timestamp": "2009-11-20T17:30:50",
"aidRules": [{"aid": "A0000000001010",
"exclusionList": ["A000000000000",
"A10000001000",
"A1010101010101"
]
}
]
}

/POIs/{poiID}/iccCAPK

Upon receiving the iccUpdateICCCAPKEvent, request the ICC Keys for the POI ID

Authorizations:

path Parameters

poiID

required

string (id80BaseType) [ 1 .. 80 ] characters

The Point of Interaction ID for the device performing the operation.

header Parameters

openretailing-connection-id

required

string (connectionIDType) [ 1 .. 1024 ] characters

The Site Reference ID returned in the "connect" call.

Responses

Response samples

200
400
500

Content type

application/json

{"statusReturn": {"timestamp": "2009-11-20T17:30:50",
"result": "success",
"error": "ERRCD_OK",
"message": "Operation completed successfully"
},
"keys": [{"rid": "A000000003",
"exponent": "03",
"index": "01",
"keyLength": 1024,
"signature": "D34A6A776011C7E7CE3AEC5F03AD2F8CFC5503CC",
"modulus": "C696034213D7D8546984579D1D0F0EA519CFF8DEFFC429354CF3A871A6F7183F1228DA5C7470C055387100CB935A712C4E2864DF5D64BA93FE7E63E71F25B1E5F5298575EBE1C63AA617706917911DC2A75AC28B251C7EF40F2365912490B939BCA2124A30A28F54402C34AECA331AB67E1E79B285DD5771B5D9FF79EA630B75",
"expirationDate": "2025-12-12"
}
]
}

/POIs/{poiID}/iccTerminalConfiguration

Upon receiving the iccUpdateAIDICCConfigurationEvent, request the ICC configuration for the POI ID

Authorizations: