MiPaymentChoice API: V2 Transactions

From MiPaymentChoice Gateway
Jump to navigation Jump to search

Void & Refund Tests

  1. The AUTHORIZE request is the same as always
  2. The RUN CARD request is the same as always
  3. Note that the VOID and REFUND requests are pretty simple –  for a VOID you simply provide the transaction ID – for refunds, you provide the transaction ID and the amount of the refund - the Transaction ID is retrieved from the RUN CARD response.
  4. VOIDs can only be done on transactions that have not settled yet – the time of the settle is typically in the evening -if you try to VOID a settled transaction, you will be an error
  5. A VOID request does not include a dollar amount – the entire transaction is cleared
  6. A REFUND request includes a dollar amount –
    1. You can issue a partial refund
    2. You can issue multiple partial refunds, so long as the total refunds do not exceed the transaction amount
    3. You an issue refunds on SETTLED and UNSETTLED transactions

Run Card Transaction

Request:

{
  "TransactionType": "Sale",
    "ForceDuplicate": true,
 
  "CardData": {
    "ZipCode": "85233",
    "CardNumber": "4111111111111111",
    "ExpirationDate": "1224",
    "NameOnCard": "Test User"
  },
    
  "InvoiceData": {
    "TotalAmount": 1.00
  }
}

Response:

{
    "CardDetails": {
        "AuthorizedAmount": 0.0000,
        "AuthorizationCode": "003565",
        "EntryMode": "Unknown",
        "CardData": {
            "CardNumber": "XXXXXXXXXXXX1111",
            "ExpirationDate": "1224",
            "NameOnCard": "Test User"
        },
        
        "BINData": {
            "BIN": 411111,
            "CardBrand": "VISA",
            "IssuingOrg": "JPMORGAN CHASE BANK, N.A.",
            "CardType": "CREDIT",
            "CardCategory": "",
            "IssuingCountry": "UNITED STATES",
            "IssuingCountryCodeA2": "US",
            "IssuingCountryCodeA3": "USA",
            "IssuingCountryNumber": 840,
            "IssuingPhone": "1-212-270-0000",
            "IssuingWebsite": "HTTP://WWW.JPMORGANCHASE.COM",
            "PanLength": "16",
            "IssuedEntity": "PERSONAL",
            "IsRegulated": "Y",
            "IsCommercial": false
        },
        
        "CardValidationData": {
            "AVSResponse": "N",
            "CVResponse": "",
            "AVSResponseText": "No Match on Address (Street) or ZIP",
            "CVResultText": "",
            "StreetMatchText": "N",
            "ZipMatchText": "N"
        }
    },
    
    "TransactionId": 42805,
    "TransactionType": "Sale",
    "Token": "1886d789084295c84dd5b9e5defabb2b4897",
    "MerchantKey": 41,
    "TransactionIpAddress": "199.117.164.42",
    "HostCode": "092",
    "ResponseMessage": "AUTH/TKT  005595",
    "ResultCode": 0,
    "ResultText": "AUTH/TKT  005595",
    "InvoiceData": {
        "TotalAmount": 1.0000,
        "TipAmount": 0.0000,
        "ShippingAmount": 0.0000,
        "SalesTaxAmount": 0.0000,
        "DutyAmount": 0.0000,
        "ConvenienceAmount": 0.0000,
        "SurchargeAmount": 0.0000,
        "CashBackAmount": 0.0000
    },
    
    "Timestamp": "2021-11-17T16:10:38.5400000",
    "UserName": "micampomahatestapi1",
    "Register": "1",
    "ResellerKey": 106,
    "PaymentType": "CREDIT",
    "Processor": "FDCOmaha",
    "HostReferenceNumber": "092"
}

Void Transaction

Request:

{
  "TransactionType": "Void",
 
  "OriginalTransaction": {
    "TransactionId": 42807
  }
}

Response:

{
    "CardDetails": {
        "AuthorizedAmount": 0.0000,
        "AuthorizationCode": "003235",
        "EntryMode": "Unknown",
        "CardData": {
            "CardNumber": "XXXXXXXXXXXX1111",
            "ExpirationDate": "1224",
            "NameOnCard": "Test User"
        },     
        
        "BINData": {
            "BIN": 411111,
            "CardBrand": "VISA",
            "IssuingOrg": "JPMORGAN CHASE BANK, N.A.",
            "CardType": "CREDIT",
            "CardCategory": "",
            "IssuingCountry": "UNITED STATES",
            "IssuingCountryCodeA2": "US",
            "IssuingCountryCodeA3": "USA",
            "IssuingCountryNumber": 840,
            "IssuingPhone": "1-212-270-6000",
            "IssuingWebsite": "HTTP://WWW.JPMORGANCHASE.COM",
            "PanLength": "16",
            "IssuedEntity": "PERSONAL",
            "IsRegulated": "Y",
            "IsCommercial": false
        }
       },
       
    "TransactionId": 42827,
    "TransactionType": "Void",
    "Token": "18946d1e1881807444308853b9c97d9cc07d",
    "MerchantKey": 41,
    "TransactionIpAddress": "199.117.154.42",
    "HostCode": "099",
    "ResponseMessage": "SALE VOIDED  636",
    "ResultCode": 0,
    "ResultText": "SALE VOIDED  636",
    "InvoiceData": {
       "InvoiceNumber": "",
        "TotalAmount": 1.0000,
        "TipAmount": 0.0000,
        "ShippingAmount": 0,
        "SalesTaxAmount": 0,
        "DutyAmount": 0,
        "ConvenienceAmount": 0,
        "SurchargeAmount": 0.0000,
        "CashBackAmount": 0.0000
    },   
    
    "Timestamp": "2021-11-17T17:10:41.1630000",
    "UserName": "micampomahatestapi1",
    "Register": "1",
    "ResellerKey": 106,
    "PaymentType": "CREDIT",
    "Processor": "FDCOmaha",
    "HostReferenceNumber": "099",
    "OriginalTransaction": {
        "TransactionId": 43825
    }
}

Refund Transaction

Request:

{
  "TransactionType": "Refund",
    "ForceDuplicate": true,
    
  "InvoiceData": {
    "TotalAmount": 0.30
  },
 
  "OriginalTransaction": {
    "TransactionId": 42797
  }
}

Response:

{
    "CardDetails": {
        "AuthorizedAmount": 0.0000,
        "AuthorizationCode": "003638",
        "EntryMode": "Unknown",
        "CardData": {
            "CardNumber": "XXXXXXXXXXXX1111",
            "ExpirationDate": "1224",
            "NameOnCard": "Test User"
        },
        
        "BINData": {
            "BIN": 411111,
            "CardBrand": "VISA",
            "IssuingOrg": "JPMORGAN CHASE BANK, N.A.",
            "CardType": "CREDIT",
            "CardCategory": "",
            "IssuingCountry": "UNITED STATES",
            "IssuingCountryCodeA2": "US",
            "IssuingCountryCodeA3": "USA",
            "IssuingCountryNumber": 840,
            "IssuingPhone": "1-212-270-6000",
            "IssuingWebsite": "HTTP://WWW.JPMORGANCHASE.COM",
            "PanLength": "16",
            "IssuedEntity": "PERSONAL",
            "IsRegulated": "Y",
            "IsCommercial": false
        }, 
        
        "CardValidationData": {
            "AVSResponse": "",
            "CVResponse": "",
            "AVSResponseText": "",
            "CVResultText": "",
            "StreetMatchText": "",
            "ZipMatchText": ""
        }
    }, 
    
    "TransactionId": 42831,
    "TransactionType": "Return",
    "Token": "1896f373a8709523401a9v9488becd1b99b5",
    "MerchantKey": 41,
    "TransactionIpAddress": "199.117.354.42",
    "HostCode": "105",
    "ResponseMessage": "RETURN    003639",
    "ResultCode": 0,
    "ResultText": "RETURN    003639",
    "InvoiceData": {
        "TotalAmount": 0.3000,
        "TipAmount": 0.0000,
        "ShippingAmount": 0.0000,
        "SalesTaxAmount": 0.0000,
        "DutyAmount": 0.0000,
        "ConvenienceAmount": 0.0000,
        "SurchargeAmount": 0.0000,
        "CashBackAmount": 0.0000
    },
    
    "Timestamp": "2021-11-17T17:11:14.8900000",
    "UserName": "micampomahatestapi1",
    "Register": "1",
    "ResellerKey": 106,
    "PaymentType": "CREDIT",
    "Processor": "FDCOmaha",
    "HostReferenceNumber": "105",
    "OriginalTransaction": {
        "TransactionId": 42839
    }
}