Optimize Evaluate
Developer Documents‣Optimize‣Optimize Evaluate

Optimize Evaluate is our new feature-rich risk management solution operating in real time during payment authorisation, as well as providing all the necessary tools for your fraud team to manage risk. For more information about our Optimize suite please follow this link.

Enabling Optimize Evaluate allows you to make informed decisions about whether to send the transaction for bank authorisation, decline it or defer it for manual review. We will return back to you the result of the fraud check and the summary of rules that were triggered via our API. Additional detail can be viewed in the Risk Management section in the merchant portal.

Optimize Evaluate is available to use on the following transaction types:

  • Payments
  • Authorisations
  • Payouts
  • Repeats

It is important to send as much as accurate data as possible on your API requests in order to make the most effective use of the Optimize products.

The API description below indicates which fields can be used in Optimize Fraud Evaluate and Optimize Investigate. Note for Optimize Investigate certain fields which are normally optional are mandatory and this is clearly highlighted below.

You can find more information on all our Optimize services here.

APIHosted
API Request & Response Examples
Card Payment with Optimize Evaluate and overall decision result is DEFER

POST /acceptor/rest/transactions/{instId}/payment
{
  "transaction" : {
    "currency" : "GBP",
    "amount" : 100.0,
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "ECOM"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "9902000000000018",
      "cv2" : "123",
      "expiryDate" : "0199",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412",
    "displayName" : "Mr Test",
    "email" : "[email protected]",
    "dateOfBirth" : "1995-11-20",
    "telephone" : "0123 456 789",
    "ip" : "212.58.253.67"
  }
}

HTTP/1.1 201
{
  "processing" : {
    "model" : "MANAGE",
    "authResponse" : {
      "acquirerName" : "Chase Paymentech",
      "gatewayReference" : "101gbp4e6ff96d228d0d4FMeee100z00",
      "gatewayCode" : "000.000.000",
      "gatewayMessage" : "Transaction succeeded",
      "avsAddressCheck" : "FULL_MATCH",
      "avsPostcodeCheck" : "FULL_MATCH",
      "cv2Check" : "MATCHED",
      "status" : "AUTHORISED"
    },
    "decision" : {
      "decisionResult" : "DEFER",
      "decisionSource" : "RULE",
      "requestedType" : "PAYMENT",
      "decidedType" : "PREAUTH",
      "rulesTriggered" : [ {
        "name" : "Test rule",
        "action" : "DEFER",
        "description" : "Test rule",
        "deferParameter" : "DECLINE"
      } ],
      "decisionReason" : "DERIVED_BY_TRIGGERED_RULE_ACTION"
    },
    "route" : "PAYON"
  },
  "paymentMethod" : {
    "registered" : true,
    "card" : {
      "cardToken" : "MT_k_6Z0JNfQ06zc8tVCso-zQ",
      "cardFingerprint" : "Q1MtNzQ5MjlhYmUtNGQ5Yi00MGM3LTg2ZGYtYWFmODg5NDg1NjRm",
      "new" : false,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "DEBIT",
      "maskedPan" : "990200******0018",
      "expiryDate" : "0199",
      "issuer" : "PAY360 TESTING",
      "issuerCountry" : "GBR",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD",
    "reuse" : {
      "storage" : "NEW",
      "agreement" : "ADHOC",
      "originalSchemeReference" : "111gbp59d4d2c2f3dd0e9FMeee100z00",
      "receivedSchemeReference" : "101gbp4e6ff96d228d0d4FMeee100z00"
    }
  },
  "customFields" : {
    "fieldState" : [ ]
  },
  "customer" : {
    "id" : "10503",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "12591054231",
    "deferred" : true,
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "SUCCESS",
    "stage" : "AUTHORISATION",
    "type" : "PREAUTH",
    "amount" : 100.00,
    "consumerSpend" : 0,
    "currency" : "GBP",
    "transactionTime" : "2021-05-27T14:38:11.538+01:00",
    "receivedTime" : "2021-05-27T14:38:11.538+01:00",
    "customerInitiated" : true
  },
  "outcome" : {
    "status" : "SUCCESS",
    "reasonCode" : "S100",
    "reasonMessage" : "Authorised"
  },
  "trace" : "T4MBF065XETGQ3eb6jddl7g",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://secure.mite.pay360.com/acceptor/rest/transactions/111111/12591054231"
  } ]
}
Card Payment with Optimize Evaluate and overall decision result is BLOCK

POST /acceptor/rest/transactions/{instId}/payment
{
  "transaction" : {
    "currency" : "GBP",
    "amount" : 100.0,
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "ECOM"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "9902000000000018",
      "cv2" : "123",
      "expiryDate" : "0199",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412",
    "displayName" : "Mr Test",
    "email" : "[email protected]",
    "dateOfBirth" : "1995-11-20",
    "telephone" : "0123 456 789",
    "ip" : "212.58.253.67"
  }
}

HTTP/1.1 201
{
  "processing" : {
    "model" : "MANAGE",
    "decision" : {
      "decisionResult" : "BLOCK",
      "decisionSource" : "RULE",
      "requestedType" : "PAYMENT",
      "decidedType" : "PAYMENT",
      "rulesTriggered" : [ {
        "name" : "Test rule",
        "action" : "BLOCK",
        "description" : "Test rule"
      } ],
      "decisionReason" : "DERIVED_BY_TRIGGERED_RULE_ACTION"
    }
  },
  "paymentMethod" : {
    "registered" : false,
    "card" : {
      "cardFingerprint" : "Q1MtNzQ5MjlhYmUtNGQ5Yi00MGM3LTg2ZGYtYWFmODg5NDg1NjRm",
      "new" : true,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "DEBIT",
      "maskedPan" : "990200******0018",
      "expiryDate" : "0199",
      "issuer" : "PAY360 TESTING",
      "issuerCountry" : "GBR",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD",
    "reuse" : {
      "storage" : "NEW",
      "agreement" : "ADHOC"
    }
  },
  "customFields" : {
    "fieldState" : [ ]
  },
  "customer" : {
    "id" : "10503",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "12591054229",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "FAILED",
    "stage" : "FRAUD_RULES",
    "type" : "PAYMENT",
    "amount" : 100.00,
    "consumerSpend" : 0,
    "currency" : "GBP",
    "transactionTime" : "2021-05-27T14:36:20.523+01:00",
    "receivedTime" : "2021-05-27T14:36:20.523+01:00",
    "customerInitiated" : true
  },
  "outcome" : {
    "status" : "FAILED",
    "reasonCode" : "A136",
    "reasonMessage" : "Rejected by fraud rules service"
  },
  "trace" : "T2hw4lerBg90eaUu9rqSvrg",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://secure.mite.pay360.com/acceptor/rest/transactions/111111/12591054229"
  } ]
}
Card Payment with Optimize Evaluate and overall decision result is PROCEED

POST /acceptor/rest/transactions/{instId}/payment
{
  "transaction" : {
    "currency" : "GBP",
    "amount" : 100.0,
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "ECOM"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "9902000000000018",
      "cv2" : "123",
      "expiryDate" : "0199",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412",
    "displayName" : "Mr Test",
    "email" : "[email protected]",
    "dateOfBirth" : "1995-11-20",
    "telephone" : "0123 456 789",
    "ip" : "212.58.253.67"
  }
}

HTTP/1.1 201
{
  "processing" : {
    "model" : "MANAGE",
    "authResponse" : {
      "acquirerName" : "Chase Paymentech",
      "gatewayReference" : "111gbp22241e4dfc6eab6FMeee100z00",
      "gatewayCode" : "000.000.000",
      "gatewayMessage" : "Transaction succeeded",
      "avsAddressCheck" : "FULL_MATCH",
      "avsPostcodeCheck" : "FULL_MATCH",
      "cv2Check" : "MATCHED",
      "status" : "AUTHORISED"
    },
    "decision" : {
      "decisionResult" : "PROCEED",
      "decisionSource" : "RULE",
      "requestedType" : "PAYMENT",
      "decidedType" : "PAYMENT",
      "rulesTriggered" : [ {
        "name" : "Test rule",
        "action" : "FORCE_ACCEPT",
        "description" : "Test rule"
      } ],
      "decisionReason" : "DERIVED_BY_TRIGGERED_RULE_ACTION"
    },
    "route" : "PAYON"
  },
  "paymentMethod" : {
    "registered" : true,
    "card" : {
      "cardToken" : "MT_k_6Z0JNfQ06zc8tVCso-zQ",
      "cardFingerprint" : "Q1MtNzQ5MjlhYmUtNGQ5Yi00MGM3LTg2ZGYtYWFmODg5NDg1NjRm",
      "new" : false,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "DEBIT",
      "maskedPan" : "990200******0018",
      "expiryDate" : "0199",
      "issuer" : "PAY360 TESTING",
      "issuerCountry" : "GBR",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD",
    "reuse" : {
      "storage" : "NEW",
      "agreement" : "ADHOC",
      "originalSchemeReference" : "111gbp59d4d2c2f3dd0e9FMeee100z00",
      "receivedSchemeReference" : "111gbp22241e4dfc6eab6FMeee100z00"
    }
  },
  "customFields" : {
    "fieldState" : [ ]
  },
  "customer" : {
    "id" : "10503",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "12591054232",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "SUCCESS",
    "stage" : "COMPLETE",
    "type" : "PAYMENT",
    "amount" : 100.00,
    "consumerSpend" : 100.00,
    "currency" : "GBP",
    "transactionTime" : "2021-05-27T14:38:48.719+01:00",
    "receivedTime" : "2021-05-27T14:38:48.719+01:00",
    "customerInitiated" : true
  },
  "outcome" : {
    "status" : "SUCCESS",
    "reasonCode" : "S100",
    "reasonMessage" : "Authorised"
  },
  "trace" : "TpDQB_5Z63d5QpGMmL5mbgg",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://secure.mite.pay360.com/acceptor/rest/transactions/111111/12591054232"
  } ]
}
Card Payment with Optimize Evaluate and multiple rules triggered with different actions

POST /acceptor/rest/transactions/{instId}/payment
{
  "transaction" : {
    "currency" : "GBP",
    "amount" : 100.0,
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "ECOM"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "9902000000000018",
      "cv2" : "123",
      "expiryDate" : "0199",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412",
    "displayName" : "Mr Test",
    "email" : "[email protected]",
    "dateOfBirth" : "1995-11-20",
    "telephone" : "0123 456 789",
    "ip" : "212.58.253.67"
  }
}

HTTP/1.1 201
{
  "processing" : {
    "model" : "MANAGE",
    "authResponse" : {
      "acquirerName" : "Chase Paymentech",
      "gatewayReference" : "111gbp802513d2a2eb50fFMeee100z00",
      "gatewayCode" : "000.000.000",
      "gatewayMessage" : "Transaction succeeded",
      "avsAddressCheck" : "FULL_MATCH",
      "avsPostcodeCheck" : "FULL_MATCH",
      "cv2Check" : "MATCHED",
      "status" : "AUTHORISED"
    },
    "decision" : {
      "decisionResult" : "PROCEED",
      "decisionSource" : "RULE",
      "requestedType" : "PAYMENT",
      "decidedType" : "PAYMENT",
      "rulesTriggered" : [ {
        "name" : "Test rule",
        "action" : "BLOCK",
        "description" : "Test rule"
      }, {
        "name" : "Test rule 3",
        "action" : "DEFER",
        "description" : "Test rule 3",
        "deferParameter" : "DECLINE"
      }, {
        "name" : "Test rule 2",
        "action" : "FORCE_ACCEPT",
        "description" : "test rule 2"
      } ],
      "decisionReason" : "DERIVED_BY_TRIGGERED_RULE_ACTION"
    },
    "route" : "PAYON"
  },
  "paymentMethod" : {
    "registered" : true,
    "card" : {
      "cardToken" : "MT_k_6Z0JNfQ06zc8tVCso-zQ",
      "cardFingerprint" : "Q1MtNzQ5MjlhYmUtNGQ5Yi00MGM3LTg2ZGYtYWFmODg5NDg1NjRm",
      "new" : false,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "DEBIT",
      "maskedPan" : "990200******0018",
      "expiryDate" : "0199",
      "issuer" : "PAY360 TESTING",
      "issuerCountry" : "GBR",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD",
    "reuse" : {
      "storage" : "NEW",
      "agreement" : "ADHOC",
      "originalSchemeReference" : "111gbp59d4d2c2f3dd0e9FMeee100z00",
      "receivedSchemeReference" : "111gbp802513d2a2eb50fFMeee100z00"
    }
  },
  "customFields" : {
    "fieldState" : [ ]
  },
  "customer" : {
    "id" : "10503",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "12591054234",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "SUCCESS",
    "stage" : "COMPLETE",
    "type" : "PAYMENT",
    "amount" : 100.00,
    "consumerSpend" : 100.00,
    "currency" : "GBP",
    "transactionTime" : "2021-05-27T14:41:57.105+01:00",
    "receivedTime" : "2021-05-27T14:41:57.105+01:00",
    "customerInitiated" : true
  },
  "outcome" : {
    "status" : "SUCCESS",
    "reasonCode" : "S100",
    "reasonMessage" : "Authorised"
  },
  "trace" : "Tj9tBUjGWkE8IJSaJn2x_4A",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://secure.mite.pay360.com/acceptor/rest/transactions/111111/12591054234"
  } ]
}
Card Payment with Optimize Evaluate and Negative list triggered

POST /acceptor/rest/transactions/{instId}/payment
{
  "transaction" : {
    "currency" : "GBP",
    "amount" : 100.0,
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "ECOM"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "9902000000000018",
      "cv2" : "123",
      "expiryDate" : "0199",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412",
    "displayName" : "Mr Test",
    "email" : "[email protected]",
    "dateOfBirth" : "1995-11-20",
    "telephone" : "0123 456 789",
    "ip" : "212.58.253.67"
  }
}

HTTP/1.1 201
{
  "processing" : {
    "model" : "MANAGE",
    "decision" : {
      "decisionResult" : "BLOCK",
      "decisionSource" : "NEGATIVE_LIST",
      "requestedType" : "PAYMENT",
      "decidedType" : "PAYMENT",
      "rulesTriggered" : [ {
        "name" : "Email Negative List",
        "action" : "NEGATIVE_LIST",
        "description" : "Negative List for Email values"
      }, {
        "name" : "Test rule 2",
        "action" : "FORCE_ACCEPT",
        "description" : "test rule 2"
      } ],
      "decisionReason" : "DERIVED_BY_TRIGGERED_RULE_ACTION"
    }
  },
  "paymentMethod" : {
    "registered" : false,
    "card" : {
      "cardFingerprint" : "Q1MtNzQ5MjlhYmUtNGQ5Yi00MGM3LTg2ZGYtYWFmODg5NDg1NjRm",
      "new" : false,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "DEBIT",
      "maskedPan" : "990200******0018",
      "expiryDate" : "0199",
      "issuer" : "PAY360 TESTING",
      "issuerCountry" : "GBR",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD",
    "reuse" : {
      "storage" : "NEW",
      "agreement" : "ADHOC",
      "originalSchemeReference" : "111gbp59d4d2c2f3dd0e9FMeee100z00"
    }
  },
  "customFields" : {
    "fieldState" : [ ]
  },
  "customer" : {
    "id" : "10503",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "12591054239",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "FAILED",
    "stage" : "FRAUD_RULES",
    "type" : "PAYMENT",
    "amount" : 100.00,
    "consumerSpend" : 0,
    "currency" : "GBP",
    "transactionTime" : "2021-05-27T14:47:43.006+01:00",
    "receivedTime" : "2021-05-27T14:47:43.006+01:00",
    "customerInitiated" : true
  },
  "outcome" : {
    "status" : "FAILED",
    "reasonCode" : "A136",
    "reasonMessage" : "Rejected by fraud rules service"
  },
  "trace" : "TmCRwjVcjEwAGqk4BL-44bw",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://secure.mite.pay360.com/acceptor/rest/transactions/111111/12591054239"
  } ]
}
Card Payment with Optimize Evaluate and Positive list triggered

POST /acceptor/rest/transactions/{instId}/payment
{
  "transaction" : {
    "currency" : "GBP",
    "amount" : 100.0,
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "ECOM"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "9902000000000018",
      "cv2" : "123",
      "expiryDate" : "0199",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412",
    "displayName" : "Mr Test",
    "email" : "[email protected]",
    "dateOfBirth" : "1995-11-20",
    "telephone" : "0123 456 789",
    "ip" : "212.58.253.67"
  }
}

HTTP/1.1 201
{
  "processing" : {
    "model" : "MANAGE",
    "authResponse" : {
      "acquirerName" : "Chase Paymentech",
      "gatewayReference" : "111gbp45882bd5c426682FMeee100z00",
      "gatewayCode" : "000.000.000",
      "gatewayMessage" : "Transaction succeeded",
      "avsAddressCheck" : "FULL_MATCH",
      "avsPostcodeCheck" : "FULL_MATCH",
      "cv2Check" : "MATCHED",
      "status" : "AUTHORISED"
    },
    "decision" : {
      "decisionResult" : "PROCEED",
      "decisionSource" : "POSITIVE_LIST",
      "requestedType" : "PAYMENT",
      "decidedType" : "PAYMENT",
      "rulesTriggered" : [ {
        "name" : "Test rule",
        "action" : "BLOCK",
        "description" : "Test rule"
      }, {
        "name" : "Email Positive List",
        "action" : "POSITIVE_LIST",
        "description" : "Positive List for Email values"
      } ],
      "decisionReason" : "DERIVED_BY_TRIGGERED_RULE_ACTION"
    },
    "route" : "PAYON"
  },
  "paymentMethod" : {
    "registered" : true,
    "card" : {
      "cardToken" : "MT_k_6Z0JNfQ06zc8tVCso-zQ",
      "cardFingerprint" : "Q1MtNzQ5MjlhYmUtNGQ5Yi00MGM3LTg2ZGYtYWFmODg5NDg1NjRm",
      "new" : false,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "DEBIT",
      "maskedPan" : "990200******0018",
      "expiryDate" : "0199",
      "issuer" : "PAY360 TESTING",
      "issuerCountry" : "GBR",
      "cardHolderName" : "Mr Test"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD",
    "reuse" : {
      "storage" : "NEW",
      "agreement" : "ADHOC",
      "originalSchemeReference" : "111gbp59d4d2c2f3dd0e9FMeee100z00",
      "receivedSchemeReference" : "111gbp45882bd5c426682FMeee100z00"
    }
  },
  "customFields" : {
    "fieldState" : [ ]
  },
  "customer" : {
    "id" : "10503",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "12591054238",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "SUCCESS",
    "stage" : "COMPLETE",
    "type" : "PAYMENT",
    "amount" : 100.00,
    "consumerSpend" : 100.00,
    "currency" : "GBP",
    "transactionTime" : "2021-05-27T14:46:33.553+01:00",
    "receivedTime" : "2021-05-27T14:46:33.553+01:00",
    "customerInitiated" : true
  },
  "outcome" : {
    "status" : "SUCCESS",
    "reasonCode" : "S100",
    "reasonMessage" : "Authorised"
  },
  "trace" : "T1NhGqkiBhch_HqtNcnCKXw",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://secure.mite.pay360.com/acceptor/rest/transactions/111111/12591054238"
  } ]
}
API Endpoint
endpoint: /acceptor/rest/transactions/{instId}/payment
method: POST
summary: process Payment

parameters:

Name
Data Type
Description
instId
string
The installation id
request body:
{
browserInfo {
userAgentHeader string
The Customer’s user agent.
}
sessionId string
Your reference for the Customer’s session.
transaction { Mandatory
currency string
Mandatory
Can be used in Optimize Fraud Checks.
The currency of your Customer’s transaction. Use the 3 character ISO-4217 code.
amount float
Mandatory
Can be used in Optimize Fraud Checks.
The amount of your Customer’s transaction.
commerceType string
Mandatory
Can be used in Optimize Fraud Checks.
Possible Values: ECOM, MOTO, CA
The commerce type for your Customer’s transaction.
channel string
Can be used in Optimize Fraud Checks.
Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER
The sales channel for your Customer’s transaction.
merchantRef string
Your reference for the transaction. Max length: 255. It’s recommended that you keep this unique.
deferred boolean
Indicates if you want the Payment to be Authorised and Captured separately.
recurring boolean
Can be used in Optimize Fraud Checks.
Set this field if you want to start a Continuous Authority relationship from this transaction.
description string
The description of the transaction. Maximum length: 255.
}
locale string
The ISO-639-1 code for your Customer’s locale.
customer {
id string
Our ID for the Customer where they are already registered with us.
update boolean
Indicates if you want to update the Customer’s details with the transaction.
email string
Can be used in Optimize Fraud Checks.
Can be used to identify links between transactions in Optimize Investigate.
Email address for the Customer.
merchantRef string
Conditional
Mandatory if using Optimize Investigate
Your reference for the Customer; should be unique to the customer. This is used as the key identifier of the customer in Optimize Investigate particularly for visualising past trends and identifying links between this customer and other transactions. Mandatory if registered is set to true or if using Optimize Investigate, otherwise optional.
dob string
Can be used in Optimize Fraud Checks.
Date of birth for the Customer.
billingAddress { The address of the Customer.
line1 string
Line 1 of the Customer’s address.
line2 string
Line 2 of the Customer’s address.
line3 string
Line 3 of the Customer’s address.
line4 string
Line 4 of the Customer’s address.
city string
City of the Customer’s address.
region string
Region of the Customer’s address.
postcode string
Post Code of the Customer’s address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s address country.
}
displayName string
Conditional
The Customer’s name. Not required if registered is set to false, mandatory otherwise.
telephone string
Can be used in Optimize Fraud Checks.
Can be used to identify links between transactions in Optimize Investigate.
Telephone number for the Customer.
ip string
Can be used in Optimize Fraud Checks.
Can be used to identify links between transactions in Optimize Investigate.
The Customer’s IP address. Additional data derived from this field such as IP Country can also be used in Optimize Fraud Checks.
registered boolean
Indicates if we should register your customer; false if you do not wish to register your customer, otherwise set to true, default value is true. Whether or not a user is being registered for the first time can be used in Optimize Fraud Checks
}
transactionOptions {
do3DSecure boolean
Indicates if the transaction should be processed with 3DS. This will override account configuration for 3DS.
sendEmailReceipt boolean
If true, an email receipt will be sent for this transaction. If false, no receipt will be sent. If not present, your account configuration determines if an email is sent.
}
paymentMethod { Mandatory
fromCustomer { Mandatory
Use if you want to use your Customer’s default card. This section is mandatory if you are not providing a token or full card details.
cv2 string
The Customer’s Card Security Code (CSC, CV2, CVV).
}
registered boolean
Can be used in Optimize Fraud Checks.
Indicates if the supplied card payment method should be registered. If no value is supplied true is assumed. This field will not be accepted for non-card payment methods. Whether or a not a card is being registered for the first time can be used in Optimize Fraud Checks.
card { Mandatory
Use if you want to provide your Customer’s card details. This section is mandatory if you are not providing a token (merchant or CardLock) or details of the Customer’s default card.
pan string
Mandatory
Can be used in Optimize Fraud Checks.
Can be used to identify links between transactions in Optimize Investigate.
The card number. It is also used to derive additional data for example Issuing Bank that can be used in Optimize Fraud Checks.
cv2 string
The Card Security Code (CSC, CV2, CVV).
expiryDate string
Mandatory
The expiry date for the card. Provide as MMYY.
nickname string
The name the Customer provides for their card to allow easy selection where they register multiple cards.
defaultCard boolean
Can be used in Optimize Fraud Checks.
Indicates if the card being used should become the Customer’s default card.
cardHolderName string
Can be used in Optimize Fraud Checks.
The name printed on the card.
issueNumber number
The issue number for the card.
startDate string
The start date for the card. Provide as MMYY.
}
billingAddress Can be used in Optimize Fraud Checks.
Can be used to identify links between transactions in Optimize Investigate.
The billing address of the Customer. Will be used for AVS checks. We’ll save the billing address when the customer makes their first payment. Providing a billing address for subsequent payments will update the address we’ve saved if you send new, empty or no values for each field.
line1 string
Line 1 of the Customer’s billing address. Can be used indirectly in Optimize Fraud Checks as part of the normalised customer address.
line2 string
Line 2 of the Customer’s billing address.
line3 string
Line 3 of the Customer’s billing address.
line4 string
Line 4 of the Customer’s billing address.
city string
Can be used in Optimize Fraud Checks.
City of the Customer’s billing address.
region string
Region of the Customer’s billing address.
postcode string
Can be used in Optimize Fraud Checks.
Can be used to identify links between transactions in Optimize Investigate.
Post Code of the Customer’s billing address.
countryCode string
Can be used in Optimize Fraud Checks.
The 3 character ISO-3166-1 code for the Customer’s billing address country.
}
}
}
response:
{
clientRedirect { Information about where to send your customer in the case of 3DS or a Callback.
frame string
Possible Values: CONTAINER, TOP
The redirect type when the transaction is set to suspend and redirect to a new URL.
pareq string
Returned when the transaction is suspended for 3DS authorisation.
url string
The URL the Customer should be redirected to.
}
transaction {
transactionId string
Our ID for the transaction.
deferred boolean
Indicates if the Payment capture is deferred.
merchantRef string
Your reference for the transaction.
merchantDescription string
The description of the transaction provided in the request.
status string
Possible Values: SUCCESS, FAILED, PENDING, EXPIRED, CANCELLED, VOIDED
The current state of the transaction.
type string
Possible Values: PAYMENT, PREAUTH, PAYOUT, REFUND, CAPTURE, CANCEL, REPEAT, CASH_ISSUE, CASH_PAYMENT
Indicates the type of the transaction.
amount float
Indicates the requested amount of the transaction.
consumerSpend float
Indicates the actual amount of the transaction. This will be zero for any type of INITIALIZE transaction, deferred transactions, and rejected transactions.
currency string
Indicates the currency of the transaction. Use the 3 character ISO-4217 code.
transactionTime string
The date and time we processed the transaction in ISO-8601 format.
receivedTime string
The date and time we received the transaction in ISO-8601 format.
commerceType string
Possible Values: ECOM, MOTO, CA
The Commerce Type of the transaction.
channel string
Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER
The Sales Channel of the transaction.