Deposit Fields

1 min

POST

https://icnow01.accertify.net/icNowImport/{importerIdDeposit}

Path Parameters

importerIdDepositstringrequired

Body Parameters

depositobject
Description
The inputs to record the deposit event
- eventSourcestring<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>required
  Description
  [REQUIRED] Required. Where or how the event originated.
  Allowed
  agentPhoneagentStoreaffiliatekioskmobileAppotherweb
- accountIDstringrequired
  Example
  799676969
  Description
  [REQUIRED] Required. User's unique identifier you assigned.
- successbooleanrequired
  Description
  [REQUIRED] Required. Whether the event was successful or not.
  
  Options are:
  
  true
  
  false
  
  This field should be the result of the payment attempt up until your risk assessment. Meaning:
  
  If you would have accepted this payment, you send "success": true
  
  If you would not have accepted this payment, you send "success": false
  
  This may differ pre-auth and post-auth.
  
  Pre-Auth Example: You are not allowed to sell to IP Addresses in Iran.
  
  A customer attempted 10 payments and you denied them because they were all from Iran, you would send "success": false
  
  On the 11th try they spoofed their IP to the US and you accepted it pre-fraud check, you would send "success": true
  
  Post-Auth Example:
  
  A customer's payment authorization failed, you would send "success": false
  
  A customer's payment authorization succeeded and fraud scoring said to allow, you would send "success": true
  Allowed
  truefalse
- isMobileAppInstalledbooleanrequired
  Description
  [REQUIRED] Required. Whether the deposit was made with a mobile application.
  
  Options are:
  
  true
  
  false
  Allowed
  truefalse
- depositobjectrequired
  Description
  [REQUIRED] Object introducing deposit fields.
  - depositIDstringrequired
    Description
    [REQUIRED] Required. Unique ID associated with the deposit.
    
    Note: In the event a payment fails you may not have a depositID. If this happens:
    
    If applicable, send the same depositID being sent to the Interceptas Platform today.
    
    Send an auditable ID if your system generates one.
    
    Send a time stamp.
  - depositTypestring<preAuthorization | postAuthorization>required
    Description
    [REQUIRED] Required. The timing of the deposit.
    
    Options are:
    
    preAuthorization
    
    postAuthorization
    Allowed
    preAuthorizationpostAuthorization
  - depositDateTimestring<datetime>required
    Example
    2020-08-28 19:00:00-04:00
    Description
    [REQUIRED] Required. Date and time the deposit was authorized formatted in yyyy-MM-dd'T'HH:mm
    . This cannot be a future date.
    Format
    datetime
  - depositTotalAmountnumber<decimal>required
    Example
    450
    Description
    [REQUIRED] Required. Total amount, including taxes, of all deposits made in the currency specified by the currencyCode field.
    Format
    decimal
  - taxAmountnumber<decimal>
    Example
    1.23
    Description
    [REQUIRED] Optional. Tax amount associated with the transaction in local currency.
    Format
    decimal
  - currencyCodestringrequired
    Example
    USD
    Description
    [REQUIRED] Required. Consumer's local three-character currency code in ISO 4217 format. This applies to all amounts in the API.
  - salesRepIDstring
    Example
    SR#46k90
    Description
    [REQUIRED] Optional. Your identifier associated with the sales representative that may have completed this transaction.
  - websiteURLstring
    Example
    www.google.com
    Description
    [REQUIRED] Optional. The website that captured the transaction. Maximum length=2048 characters.
  - referralCodestring
    Example
    CFB2022
    Description
    [REQUIRED] Optional. Affiliate website or code through which the customer came to your site.
- ipAddressstring
  Example
  192.168.41.17
  Description
  [IMPERATIVE] Imperative. User's IP Address you captured. Maximum field length = 45 characters.
- userAgentstring
  Example
  Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0
  Description
  [IMPERATIVE] Imperative. User Agent of the user's browser and operating system captured by the site owner. Maximum field length = 250 characters.
- devicePayloadstring
  Example
  afklasdjlasdjl3l23j23423klj
  Description
  [IMPERATIVE] Imperative. From Accertify Device, the user's device data sent by our Collector script. You will take the devicePayload from the script and add additional server-side properties to it as described in our "Device Payload via the Interceptas Platform" section of our Accertify Data Collector Script Implementation document. Maximum field length = 150,000 characters.
  
  Note: We recommend this field for high volume, low latency clients. You can send this instead of the deviceTransactionID.
- deviceTransactionIDstring
  Example
  e1a1aade06e2557f34036eeb06173faf1fa05c64959383
  Description
  [IMPERATIVE] Imperative. From Accertify Device, the device Transaction ID from the Collector JS or SDK file captured by the site or application owner. Maximum field length = 100 characters.
  
  Notes:
  
  We recommend you send devicePayload instead of deviceTransactionID. We are leaving this here for backward compatibility.
  
  You do not have to put in logic to account for deviceTransactionID returning blank. This can happen if JavaScript is blocked or if it is an event taken over the phone.
- ubaIDstring
  Example
  3143e969395de649c48c1c9f3e363a3e7ae7
  Description
  [IMPERATIVE] Imperative. From Accertify UBA, the ID used to reference behavior data already captured by Accertify. Maximum field length = 100 characters.
  
  This value is retrieved from:
  
  Browser from the JavaScript function getToken
  
  iOS/Android from the SDK?function getUbaId()
  
  Note: You do not have to put in logic to account for ubaID returning blank. This can happen if JavaScript is blocked or if it is an event taken over the phone.
- emailAddressstring
  Example
  [email protected]
  Description
  [IMPERATIVE] Imperative. Either the email address associated with their account, inventory hold, or with this payment (for guest checkout). Maximum field length = 100 characters.
- ubaEventsstring
  Example
  lasjdlkfdsljelkrrjwl3kl324j32k432
  Description
  [IMPERATIVE] Imperative. From Accertify UBA, a payload of the most recent fields. This is used to make sure we have up to the second information.
- pageIDstring
  Example
  lk32j4lk324lkj324
  Description
  [IMPERATIVE] Imperative. From Accertify UBA, the unique page ID defined from the Collector script.
- usernamestring
  Example
  erlichb
  Description
  [IMPERATIVE] Imperative. User's username if your site allows logging in using username. Maximum field length = 100 characters.
- authenticationMethodstring<appAuthenticator | appPush | FIDO | other | password | magicLink | SMS>
  Description
  [IMPERATIVE] Imperative. How the user authenticated onto your site.
  Allowed
  appAuthenticatorappPushFIDOotherpasswordmagicLinkSMS
- latitudenumber
  Example
  Numbers with up to 8 decimals, 58.99993333
  Description
  [OPTIONAL] Optional. The HTML 5 or GPS based latitude location of the user in decimal degrees format without letters. Maximum field length = 10 characters.
- longitudenumber
  Example
  Numbers with up to 8 decimals, 58.99993333
  Description
  [OPTIONAL] Optional. The HTML 5 or GPS based longitude location of the user in decimal degrees format without letters. Maximum field length = 10 characters.
- brandstring
  Example
  Acme
  Description
  [OPTIONAL] Optional. The brand submitting the event. Maximum field length = 50 characters.
  
  Note: For clients with multiple brands under one corporate entity.
- sessionIDstring
  Example
  961b521892e68f6c4d1c8459dfb530466eed
  Description
  [OPTIONAL] Optional. From Accertify UBA, the user's Session ID defined by you for the user's web browsing activity. Maximum field length = 250 characters.
- ubaSessionIDstring
  Example
  961b521892e68f6c4d1c8459dfb530466eed
  Description
  [OPTIONAL] Optional. From Accertify UBA, the user's Session ID defined by Accertify for the user's web browsing activity. Maximum field length = 50 characters.
  
  Note: Ideally you would send this or your sessionID.

Responses

200Success response

successResponse
Example
```
{
  "transaction-results": {
    "transaction-id": "23",
    "cross-reference": "f85b9ed2-fe5a-425a-9ff5-a9988e56110b",
    "rules-tripped": "5237260000001680431:obsrv_Transaction Total Amount Greater Than 500:500;",
    "total-score": 500,
    "recommendation-code": "ACCEPT",
    "remarks": ""
  },
  "validation_response": {
    "warnings": {
      "ipAddress": "ipAddress is invalid"
    },
    "originalValues": {
      "ipAddress": "1"
    },
    "status": "true"
  }
}
```
Description
Success response
- transaction-resultsobject
  Description
  A block indicating the results of your successful call.
  - transaction-idstring
    Description
    Transaction's unique identifier. Typically, this is your order number.
    
    Note: This is the transactionID field.
  - cross-referencestring
    Description
    Unique identifier Accertify assigns to this transaction. It is a cross reference to the transactionID field.
  - rules-trippedstring
    Description
    Identifier, description, and score of the rules that tripped on this transaction.
    
    Example: 5237260000001628419
    Between IP Postal Code and Billing Postal Code Greater Than 1000
    Where:
    
    Identifier: 5237260000001628419
    
    Description: apir_Distance Between IP Postal Code and Billing Postal Code Greater Than 1000
    
    Score: 500
  - total-scoreinteger
    Description
    The accumulated fraud score of this transaction.
  - recommendation-codestring
    Description
    Our transaction recommendation.
    
    ACCEPT
    
    REJECT
    
    REVIEW
    
    ACCEPT_POLICY
    
    REJECT_POLICY
    
    REVIEW_POLICY
  - remarksstring
    Description
    Details left by an analyst if they resolve the transaction.
    
    Example: AT: 5/5/21 1:04
    PM CDT
- validation_responseobject
  - warningsobject
    Description
    Map of field names and warning messages that may impair fraud scoring if not resolved.
  - originalValuesobject
    Description
    Map of field names and input values present when warnings or errors are reported. The values here should be fixed to validate.
  - statusstring<true when there are no errors | false when there are errors>
    Description
    Whether the validation has errors.
    
    Options are:
    
    true when there are no errors.
    
    false when there are errors.
    Allowed
    true when there are no errorsfalse when there are errors

400Error response

errorResponse
Example
```
{
  "validation_response": {
    "errors": {
      "Transaction ID": "A unique transaction ID is required (max length = 40)",
      "ipAddress": "ipAddress is required"
    },
    "warnings": {},
    "originalValues": {
      "transaction-id": "23",
      "ipAddress": "1"
    },
    "status": "false"
  }
}
```
Description
Error response
- validation_responseobject
  - errorsobject
    Description
    Map of field names and error messages that have prevented processing of the transaction.
  - warningsobject
    Description
    Map of field names and warning messages that may impair fraud scoring if not resolved.
  - originalValuesobject
    Description
    Map of field names and input values present when warnings or errors are reported. The values here should be fixed to validate.
  - statusstring<true when there are no errors | false when there are errors>
    Description
    Whether the validation has errors.
    
    Options are:
    
    true when there are no errors.
    
    false when there are errors.
    Allowed
    true when there are no errorsfalse when there are errors

500

curl

curl --request POST \
     --url https://icnow01.accertify.net/icNowImport/{importerIdDeposit} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "eventSource": "",
     "accountID": 799676969,
     "success": "",
     "isMobileAppInstalled": "",
     "deposit": {
     "depositID": "",
     "depositType": "",
     "depositDateTime": "2020-08-28 19:00:00-04:00",
     "depositTotalAmount": 450,
     "currencyCode": "USD"
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "eventSource": "",
   "accountID": 799676969,
   "success": "",
   "isMobileAppInstalled": "",
   "deposit": {
      "depositID": "",
      "depositType": "",
      "depositDateTime": "2020-08-28 19:00:00-04:00",
      "depositTotalAmount": 450,
      "currencyCode": "USD"
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://icnow01.accertify.net/icNowImport/{importerIdDeposit}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://icnow01.accertify.net/icNowImport/{importerIdDeposit}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "eventSource": "",
   "accountID": 799676969,
   "success": "",
   "isMobileAppInstalled": "",
   "deposit": {
      "depositID": "",
      "depositType": "",
      "depositDateTime": "2020-08-28 19:00:00-04:00",
      "depositTotalAmount": 450,
      "currencyCode": "USD"
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://icnow01.accertify.net/icNowImport/{importerIdDeposit}"

payload = json.dumps({
   "eventSource": "",
   "accountID": 799676969,
   "success": "",
   "isMobileAppInstalled": "",
   "deposit": {
      "depositID": "",
      "depositType": "",
      "depositDateTime": "2020-08-28 19:00:00-04:00",
      "depositTotalAmount": 450,
      "currencyCode": "USD"
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Success response
{
  "transaction-results": {
    "transaction-id": "",
    "cross-reference": "",
    "rules-tripped": "",
    "total-score": 0,
    "recommendation-code": "",
    "remarks": ""
  },
  "validation_response": {
    "warnings": {},
    "originalValues": {},
    "status": ""
  }
}

400

// Error response
{
  "validation_response": {
    "errors": {},
    "warnings": {},
    "originalValues": {},
    "status": ""
  }
}

500