Card Acquisition
Last updated: 12-Jan-2024
This API is used to initiate card Acquisition requests specifying the following details:
| Request Details | Values |
|---|---|
| Method | POST |
| URL | https://{ENVIRONMENT}/oidc/poscloud/nexo/cardAcquisition |
| Authorization | https://verifone.cloud/docs/in-store-payments/integration-set-terminal#step-3__003a__00a0setting-up-basic-auth-in-postman |
|
Headers: Content-Type x-terminal-simulator x-site-entity-id
Authorization |
application/json true Entity ID of child to be passed in case parent token is used while calling this API. "user-uid:api" key pair encoded in base64. See the Obtaining API Keys guide for more information. |
| Body > Raw | See the request example below. |
Check the POS Cloud API reference for more details on the required parameters.
| Required parameters | Description |
|---|---|
MessageHeader |
Object |
MessageHeader.MessageClass |
"SERVICE" |
MessageHeader.MessageCategory |
"CARDACQUISITION" |
| MessageHeader.MessageType | "REQUEST" |
| MessageHeader.ServiceID | String |
| MessageHeader.SaleID | String |
| MessageHeader.POIID | String |
| CardAcquisitionRequest | Object |
| CardAcquisitionRequest.SaleData | Object |
| CardAcquisitionRequest.TransactionID | String |
| CardAcquisitionRequest.TimeStamp | String |
| CardAcquisitionRequest.CardAcquisitionTransaction | Object |
{
"MessageHeader": {
"MessageClass": "SERVICE",
"MessageCategory": "CARDACQUISITION",
"MessageType": "REQUEST",
"ServiceID": "34567",
"SaleID": "1234",
"POIID": "401-921-303"
},
"CardAcquisitionRequest": {
"SaleData": {
"OperatorID": "string",
"SaleTransactionID": {
"TransactionID": "12345",
"TimeStamp": "2021-07-02T11:39:07.087Z"
},
"SaleReferenceID": "string",
"SaleTerminalData": {},
"CustomerOrderReq": null,
"SaleToPOIData": null,
"SaleToAcquirerData": null
},
"CardAcquisitionTransaction": {
"AllowedPaymentBrand": [
"string"
],
"AllowedLoyaltyBrand": [
"string"
],
"LoyaltyHandling": "FORBIDDEN",
"CustomerLanguage": {},
"ForceEntryMode": [
"CHIP","MAG_STRIPE","CTLS_CARD"
],
"ForceCustomerSelectionFlag": true,
"TotalAmount": "30",
"PaymentType": "NORMAL",
"VF_Message": "CardData",
"CashBackFlag": true
}
}
}Based on the response from the terminal, the POS Cloud will send back the response.
{
"MessageHeader": {
"MessageClass": "SERVICE",
"MessageCategory": "CARDACQUISITION",
"MessageType": "RESPONSE",
"ServiceID": "34567",
"SaleID": "1234",
"POIID": "401-921-303"
},
"CardAcquisitionResponse": {
"Response": {
"Result": "SUCCESS",
"ErrorCondition": null,
"AdditionalResponse": null
},
"SaleData": {
"OperatorID": null,
"SaleTransactionID": null,
"SaleReferenceID": null,
"SaleTerminalData": null,
"CustomerOrderReq": null,
"SaleToPOIData": null,
"SaleToAcquirerData": null
},
"POIData": {
"POITransactionID": null,
"POIReconciliationID": null
},
"PaymentBrand": null,
"PaymentInstrumentData": {
"PaymentInstrumentType": null,
"ProtectedCardData": null,
"CardData": {
"PaymentBrand": "VISA",
"MaskedPAN": "463237******6050",
"PaymentAccountRef": null,
"EntryMode": "ICC",
"CardCountryCode": "0356",
"ProtectedCardData": null,
"SensitiveCardData": {
"PAN": null,
"CardSeqNumb": null,
"ExpiryDate": null,
"TrackData": null
},
"AllowedProductCode": null
}
},
"LoyaltyAccount": null,
"CustomerOrder": null
}
}
Rate this article:
