Payment Fields
1 min
POST
https://adi.accertify.net/api/identity/v1/payment
Body Parameters
- paymentobjectDescription
- eventSourcestring<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>requiredDescriptionAllowedagentPhoneagentStoreaffiliatekioskmobileAppotherweb
- transactionIDstringrequiredDescription
- paymentAmountnumberrequiredDescription
- currencyCodestringrequiredDescription
- successbooleanrequiredDescriptionAllowedtruefalse
- ipAddressstringExampleDescription
- userAgentstringExampleDescription
- devicePayloadstringExampleDescription
- deviceTransactionIDstringExampleDescription
- ubaIDstringExampleDescription
- emailAddressstringExampleDescription
- ubaEventsstringExampleDescription
- pageIDstringExampleDescription
- usernamestringExampleDescription
- authenticationMethodstring<appAuthenticator | appPush | FIDO | other | password | magicLink | SMS>DescriptionAllowedappAuthenticatorappPushFIDOotherpasswordmagicLinkSMS
- accountIDstringDescription
- failureCodestring<authFailed | other>DescriptionAllowedauthFailedother
- latitudenumberExampleDescription
- longitudenumberExampleDescription
- brandstringExampleDescription
- sessionIDstringExampleDescription
- ubaSessionIDstringExampleDescription
- isGuestCheckoutbooleanDescriptionAllowedtruefalse
- firstNamestringDescription
- middleNamestringDescription
- lastNamestringDescription
- listingIDstringDescription
- loyaltyNumberstringDescription
- taxAmountnumber<float>DescriptionFormatfloat
- transactionTypestring<**preAuthorization** | **postAuthorization** | **update**>DescriptionAllowed**preAuthorization****postAuthorization****update**
- transactionDateTimestring<date-time>ExampleDescriptionFormatdate-time
- accountStatusstring<active | blocked | dormant | good | other | passwordChangeRequired | passwordExpired | suspended | terminated | trial>DescriptionAllowedactiveblockeddormantgoodotherpasswordChangeRequiredpasswordExpiredsuspendedterminatedtrial
- paymentobjectDescription
- cartIDstringExampleDescription
- salesRepIDstringExampleDescription
- websiteURLstringExampleDescription
- referralCodestringExampleDescription
- isGiftbooleanDescriptionAllowedtruefalse
- giftMessagestringExampleDescription
- deliveryFeenumberExampleDescription
- deliveryFeeTypestring<free | consumerPaid | subscription | other>DescriptionAllowedfreeconsumerPaidsubscriptionother
- isPaymentInInstallmentsbooleanDescriptionAllowedtruefalse
- isPaymentRecurringbooleanDescriptionAllowedtruefalse
- totalFailedTransactionsintegerExampleDescription
- isTravelPackagePurchasedbooleanDescriptionAllowedtruefalse
- accountobjectDescription
- isEnrolledInLoyaltyProgrambooleanDescriptionAllowedtruefalse
- isMobileAppInstalledbooleanDescriptionAllowedtruefalse
- accountLocalestringExampleDescription
- accountLevelstringExampleDescription
- accountTypestring<individual | business | family | other>DescriptionAllowedindividualbusinessfamilyother
- accountReferralCodestringExampleDescription
- accountRegistrationDateTimestring<date-time>ExampleDescriptionFormatdate-time
- accountEmailUpdatedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- accountEmailVerifiedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- accountPasswordUpdatedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- dateOfBirthstringExampleDescription
- totalCreditCardsOnFileintegerExampleDescription
- totalInactiveCreditCardsOnFileintegerExampleDescription
- totalPurchasesintegerDescription
- totalRefundsintegerDescription
- totalOrdersAmountnumberDescription
- loyaltyProgramNamestringExampleDescription
- loyaltyNumberStartDateTimestring<date-time>ExampleDescriptionFormatdate-time
- loyaltyNumberLastUsedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- loyaltyLastUsedPointsintegerExampleDescription
- loyaltyPointsBalanceintegerExampleDescription
- loyaltyLastEarnedPointsintegerExampleDescription
- loyaltyLastEarnedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- loyaltyPromotionMessageTypestring<postalMail | email | smsText | none>DescriptionAllowedpostalMailemailsmsTextnone
- addressesobject[]Description
- addressIDstringExampleDescription
- addressTypestring<account | billing | bopis | curbside | departure | destination | fulfillment | listing | lodging | pickup | return | shipping | venue | other>DescriptionAllowedaccountbillingbopiscurbsidedeparturedestinationfulfillmentlistinglodgingpickupreturnshippingvenueother
- primaryFlagbooleanDescriptionAllowedtruefalse
- isAddressOnFilebooleanExampleDescriptionAllowedtruefalse
- firstNamestringExampleDescription
- middleNamestringExampleDescription
- lastNamestringExampleDescription
- emailAddressstringExampleDescription
- phonestringExampleDescription
- phoneCountryCodestringExampleDescription
- address1stringExampleDescription
- address2stringExampleDescription
- citystringExampleDescription
- regionstringExampleDescription
- postCodestringExampleDescription
- countrystringExampleDescription
- companyNamestringExampleDescription
- locationTypestring<business | redirect | residence | siteToStore | other>DescriptionAllowedbusinessredirectresidencesiteToStoreother
- addressCreatedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- addressUpdatedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- paymentMethodsobject[]Description
- paymentTypestringrequiredDescription
- paymentMethodIDstringExampleDescription
- paymentMethodAmountnumberExampleDescription
- isPaymentStoredOnFilebooleanDescriptionAllowedtruefalse
- emailAddressstringExampleDescription
- nameOnAccountstringExampleDescription
- accountTypestring<checking | saving | moneyMarket | other>DescriptionAllowedcheckingsavingmoneyMarketother
- cardNumberstringExampleDescription
- expirationMonthintegerExampleDescription
- expirationYearintegerExampleDescription
- expirationDayintegerExampleDescription
- nameOnCreditCardstringExampleDescription
- cardBinintegerExampleDescription
- cardLastFourintegerExampleDescription
- avsResultstring<matched | partialMatch | notMatched | notChecked | systemError | other>DescriptionAllowedmatchedpartialMatchnotMatchednotCheckedsystemErrorother
- cvvResultstring<matched | notMatched>DescriptionAllowedmatchednotMatched
- cardAuthorizationCodestringExampleDescription
- cardAuthorizationDateTimestring<date-time>ExampleDescriptionFormatdate-time
- isPre-AuthorizationRejectbooleanDescriptionAllowedtruefalse
- post-AuthorizationRejectReasonstring<creditReject | fraudReject | otherReject>DescriptionAllowedcreditRejectfraudRejectotherReject
- eciIndicatorstring<successful | unsuccessfulOrNotAttempted | attemptedButNotCompleted | other>DescriptionAllowedsuccessfulunsuccessfulOrNotAttemptedattemptedButNotCompletedother
- totalFailedAttemptsnumberExampleDescription
- paymentMethodCreatedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- paymentMethodUpdatedDateTimestring<date-time>ExampleDescriptionFormatdate-time
- giftCardNumberstringExampleDescription
- giftCardLastFourstringExampleDescription
- giftCardBINstringExampleDescription
- paymentMethodBalanceAmountnumberExampleDescription
- pointsintegerExampleDescription
- loyaltyProgramNamestringExampleDescription
- walletTypestringExampleDescription
- walletStatusstring<active | pending | inactive>DescriptionAllowedactivependinginactive
- isWalletProtectionEligiblebooleanDescriptionAllowedtruefalse
- promotionsobject[]Description
- promoCodestringExampleDescription
- promoAmountnumberExampleDescription
- promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>DescriptionAllowedbogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother
- itemsobject[]Description
- isUpsellbooleanDescriptionAllowedtruefalse
- itemTypestring<giftCard | parking | physicalGood | reservation | subscription | ticket | other>DescriptionAllowedgiftCardparkingphysicalGoodreservationsubscriptionticketother
- brandNamestringExampleDescription
- categorystringExampleDescription
- descriptionstringExampleDescription
- itemIDstringExampleDescription
- pricenumberExampleDescription
- faceValueAmountnumberExampleDescription
- quantitynumberExampleDescription
- addressIDstringExampleDescription
- productConditionstring<new | openPackage | other | refurbished | used>DescriptionAllowednewopenPackageotherrefurbishedused
- shippingCompanystring<dhl | fedex | ups | usps | other>DescriptionAlloweddhlfedexupsuspsother
- shippingMethodstring<digital | ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>DescriptionAlloweddigitalgroundinternationalothernextDaysameDaystorePickuptwoDaythreeDay
- shippingTrackingNumberstringExampleDescription
- isLargeItemDeliverybooleanDescriptionAllowedtruefalse
- promoCodestringExampleDescription
- promoAmountnumberExampleDescription
- promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>DescriptionAllowedbogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother
- pickupLocationstring<curbside | dropBox | inStore | other>DescriptionAllowedcurbsidedropBoxinStoreother
- pickupLocationDescriptionstringExampleDescription
- pickupPersonFirstNamePrimarystringExampleDescription
- pickupPersonLastNamePrimarystringExampleDescription
- pickupPersonFirstNameAlternatestringExampleDescription
- pickupPersonLastNameAlternatestringExampleDescription
- pickupVerificationMethodstring<idCard | signature | other>DescriptionAllowedidCardsignatureother
- pickupDateTimestring<date-time>ExampleDescriptionFormatdate-time
- pickupVerificationSignatureImagestringDescription
- pickupVerificationIDCardImagestringDescription
Responses
200
- successResponseExample
{ "eventID": "GK76NPO=zaeit1di9+DCJEDYUAvu90hLEvc", "eventDetails": { "deviceDetails": { "browserSpoofRisk": "noRisk", "deviceIDConfidence": 100, "deviceIDNew": false, "browserIsMobile": false, "mobileIsRooted": false, "deviceIDFirstSeen": 1629754353000, "browserNewCookie": false, "deviceIDTimesSeen": 14, "mobileApp": "false", "browserReplayTagStatus": "VALID", "deviceID": "c3e67da3-2eaa-4d40-a7ce-74f8118ba5d9" }, "connectionDetails": { "hostingIndicator": false, "isTor": false, "hostingIndicatorReal": false, "realIPMatch": "true", "countryCode": "US", "countryCodeReal": "US", "isProxy": false } }, "messages": { "warning": [], "error": [], "info": [] }, "results": { "riskScore": { "score": 0, "recommendationCode": "Deny", "degenerateObject": { "objectType": "ipAddress", "objectValue": "192.111.111.19" }, "insights": [ "emailAliased" ] } }, "status": true }Description- statusbooleanDescription
- eventIDstringDescription
- eventDetailsobjectDescription
- deviceDetailsobjectDescription
- browserSpoofRiskstring<noRisk | mediumRisk | highRisk | browsersOnly>DescriptionAllowednoRiskmediumRiskhighRiskbrowsersOnly
- deviceIDConfidencenumberDescription
- deviceIDNewbooleanDescriptionAllowedtruefalse
- browserIsMobilebooleanDescriptionAllowedtruefalse
- mobileIsRootedbooleanDescriptionAllowedtruefalse
- deviceIDFirstSeennumberDescription
- browserNewCookiebooleanDescriptionAllowedtruefalse
- deviceIDTimesSeennumberDescription
- mobileAppstring<true | false | null>DescriptionAllowedtruefalsenull
- browserReplayTagStatusstring<valid | invalidReplay | invalidExpired | invalidTampered | missing>DescriptionAllowedvalidinvalidReplayinvalidExpiredinvalidTamperedmissing
- deviceIDstringDescription
- connectionDetailsobjectDescription
- realIPMatchstring<true | false | NA>DescriptionAllowedtruefalseNA
- isProxybooleanDescription
- isTorbooleanDescription
- carrierCodestringDescription
- carrierCodeRealstringDescription
- connectionTypestringDescription
- connectionTypeRealstringDescription
- hostingIndicatorbooleanDescriptionAllowedtruefalse
- hostingIndicatorRealbooleanDescriptionAllowedtruefalse
- regOrgCodestringDescription
- regOrgCodeRealstringDescription
- countryCodestringDescription
- countryCodeRealstringDescription
- routingTypestringDescription
- routingTypeRealstringDescription
- resultsobjectDescription
- riskScoreobject
- scorenumberDescription
- recommendationCodestring<approve | challenge | deny | flag | notify | deferred>DescriptionAllowedapprovechallengedenyflagnotifydeferred
- recommendationDetailstringDescription
- magicLinkstringDescription
- degenerateObjectobjectDescription
- objectTypestringDescription
- objectValuestringDescription
- insightsstring[]Description
- listHitsobjectDescription
- negativeValuesobject[]Description
- positiveValuesobject[]Description
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
400
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
401
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
403
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
405
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
412
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
429
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
500
- errorResponseExample
{ "messages": { "warning": [], "error": [ "card number appears to be plaintext" ], "info": [] }, "status": false }Description- statusbooleanDescription
- messagesobject
- errorstring[]
- warningstring[]
- infostring[]
curl
curl --request POST \
--url https://adi.accertify.net/api/identity/v1/payment \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"eventSource": "",
"transactionID": "",
"paymentAmount": "",
"currencyCode": "",
"success": "",
"paymentMethods": [
{
"paymentType": ""
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"eventSource": "",
"transactionID": "",
"paymentAmount": "",
"currencyCode": "",
"success": "",
"paymentMethods": [
{
"paymentType": ""
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://adi.accertify.net/api/identity/v1/payment", 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://adi.accertify.net/api/identity/v1/payment")
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": "",
"transactionID": "",
"paymentAmount": "",
"currencyCode": "",
"success": "",
"paymentMethods": [
{
"paymentType": ""
}
]
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://adi.accertify.net/api/identity/v1/payment"
payload = json.dumps({
"eventSource": "",
"transactionID": "",
"paymentAmount": "",
"currencyCode": "",
"success": "",
"paymentMethods": [
{
"paymentType": ""
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success response
{
"status": false,
"eventID": "",
"eventDetails": {
"deviceDetails": {
"browserSpoofRisk": "",
"deviceIDConfidence": 0,
"deviceIDNew": false,
"browserIsMobile": false,
"mobileIsRooted": false,
"deviceIDFirstSeen": 0,
"browserNewCookie": false,
"deviceIDTimesSeen": 0,
"mobileApp": "",
"browserReplayTagStatus": "",
"deviceID": ""
},
"connectionDetails": {
"realIPMatch": "",
"isProxy": false,
"isTor": false,
"carrierCode": "",
"carrierCodeReal": "",
"connectionType": "",
"connectionTypeReal": "",
"hostingIndicator": false,
"hostingIndicatorReal": false,
"regOrgCode": "",
"regOrgCodeReal": "",
"countryCode": "",
"countryCodeReal": "",
"routingType": "",
"routingTypeReal": ""
}
},
"results": {
"riskScore": {
"score": 0,
"recommendationCode": "",
"recommendationDetail": "",
"magicLink": "",
"degenerateObject": {
"objectType": "",
"objectValue": ""
},
"insights": [
""
]
},
"listHits": {
"negativeValues": [
{}
],
"positiveValues": [
{}
]
}
},
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}400
// Bad Request. Usually indicates a message that cannot be parsed or fails validation.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}401
// Unauthorized. Invalid credentials.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}403
// Forbidden. Event was stopped by Gatekeeper checks.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}405
// Method Not Allowed. Indicates an HTTP request method other than POST.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}412
// Precondition Failed. Exceeded event rate limit for test API configurations.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}429
// Too Many Requests. Rate limit exceeded.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}500
// Internal Server Error.
{
"status": false,
"messages": {
"error": [
""
],
"warning": [
""
],
"info": [
""
]
}
}