Post-Authorisation Flow
Fraud Check Request Data
Data Fields
Transaction
Field | CV field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
transactionId | TransactionID | string | Guid generated to identify Accertify transaction. | R | |
transactionType | n/a | string | Send transaction to Accertify before or after authorisation with payment provider/bank. Note: only post-authorisation available. | Default: Post-Authorization | R |
transactionDateTime | FraudCheckedDate | datetime | Generated date and time of transaction. In RFC3339 format: yyyy-MM-dd'T'HH:mm:ssXXX Note: does not accept future dates | Example: 2022-03-11T17:07:24-07:00 | R |
cartId | SoOrderNo | string | Order number generated on website that can be used as additional identifier of transaction. | O | |
transactionTotalAmount | order.OrderTotalAmount | decimal | Total amount of transaction, including shipping and taxes. | R | |
taxAmount | OrderTotalTax | decimal | Tax amount included in transaction. | O | |
salesChannel | SalesChannel.Web | string | Sales channel where transaction took place. | Options: Call Centre, Kiosk, Web, Mobile App, Other Default: Web | R |
websiteURL | SystemControl.Live.WebSiteURL | string | URL of your ecommerce website | O | |
ipAddress | Util.RequestIpAddress | string | User's IP captured in IPv4 or IPv6 formats. Required for channels: Kiosk, Mobile App, Web, Other | Examples:
| CR |
currencyCode | order.Customer.CurrencyCodeToUse | string | User's local currency in ISO 4217 format. | Example: AUD | R |
isGift | ? | Default: False | O |
Billing (object)
These fields generate data required.
{"billingFirstName":"Andrew","billingLastName":"Chia","billingCompanyName":"ACEX Consulting Engineers","billingEmailAddress":"info@acexeng.com.au","billingAddress":"24 Oakwood Avenue","billingCity":"Dandenong North","billingStateCode":"VIC","billingPostalCode":"3175","billingCountryCode":"AU","billingPhoneNumber":"0430924122","billingPhoneNumberCountryCode":"0061","primaryPaymentType":"Credit Card","purchaseType":"Physical Items","cards":{"card":[{"cardholderName-D":"Andrew Chia","cardNumber-D":"512127******1518","binIin-D":"512127","cardAuthorizedAmount-D":1347.91,"cardExpireDate-D":"07-25","cardAuthorizationDate-D":"2022-09-15T11:03:46Z","isPre-AuthorizationReject-D":"False","cardAvsResponse-D":"Matched","cardCvvResponse-D":"Matched"
Data | CV Field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
billing | n/a | object | Array that contains the purchaser's name, billing address, order delivery address and captured payment details | R | |
billingFirstName | order.SoOrderingUser.FirstName Fallback: PSO.GetNamesForOrder() | string | Billing first name entered for the order. If unavailable, ? | R | |
billingLastName | order.SoOrderingUser.Surname Fallback: order.GetNamesForOrder | string | Billing last name entered for the order. If not available, ? | R | |
billingCompanyName | string | Company name if entered. | |||
billingEmailAddress | order.EmailAddressForGuestUser / user.ValidEmailAddress | string | Email address entered for guest user order; for logged in user, new or saved email address. | R | |
billingAddress | order.SoBillAddr2 → order.SoDelAddr2 → user.SoBillAddr2 | 30 cha string | Street number and name of billing address entered. If no billing address, falls back to delivery address, then user's saved address. | R | |
billingAddressLine2 | Fall back in ascending order: order.SoBillAddr2 → order.SoDelAddr2 → user.SoBillAddr2 | 30 cha string | |||
billingCity | order.SoBillSuburb → order.SoDelSuburb → user.SoBillSuburb | string | Billing city, town or suburb entered. If data from this field is unavailable or invalid, falls back to that entered for delivery address, then user's saved suburb/town. | R | |
billingStateCode | order.SoBillState → order.SoDelState → user.SoBillState | string | State, territory or region code in ISO 3166-2. From 2-5 characters. Note: Required if used in the billing CountryCode. | For Australia: ACT. NSW, NT, QLD, SA, TAS, VIC, WA | CR |
billingPostalCode | order.SoBillPostcode → order.SoDelPostcode → user.SoBillPostcode | string | R | ||
billingCountryCode | Currently hard-coded. | string | Two digit (ISO-3166-1) country code for billing address. Example: AU | R | |
billingPhoneNumber | Note: Currently hard-coded. order.ContactPhoneNumber → order.DelPhone → user.PhoneNumber | integer | Billing phone number entered. Must exclude Phone country code. Numeric only, max. = 25, no spaces or special characters. | R | |
billingPhoneNumberCountryCode | Currently hard-coded. | string | Country code of billing phone number. | Example: '0061' | R |
primaryPaymentType | string | Purchaser's primary method of payment. | Credit Card, Debit Card, Virtual Card, Gift Card, eWallet | R | |
purchaseType | string | Type of items purchased. If order contains a mixture, 'Physical Items' will default. Note: currently only 'Physical Items' and 'Digital Items' supported. | Options: Physical Items, Digital Items, Services, Other | R |
If PrimaryPaymentType = Credit Card, Debit Card, Virtual Card
Relevant fields when these payment types are used.
,"cards":{"card":[{"cardholderName-D":"Andrew Chia","cardNumber-D":"512127******1518","binIin-D":"512127","cardAuthorizedAmount-D":1347.91,"cardExpireDate-D":"07-25","cardAuthorizationDate-D":"2022-09-15T11:03:46Z","isPre-AuthorizationReject-D":"False","cardAvsResponse-D":"Matched","cardCvvResponse-D":"Matched"
Field | CV field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
cards | n/a | object | Array with one or more card arrays for required fields for this payment type. | CR | |
card | n/a | array | An array introducing card fields. data from an object returned by Braintree/Eway. Part of the cards fields on page 14 of the API Document. | CR | |
cardholderName-D | string | Cardholder's name. | CR | ||
cardNumber-D | integer | Masked credit card number. Includes tokenised card number. | Example: 512127******1518 | CR | |
binIin-D | bin | Leading six to eleven digits of the card number. Note: For 6 - 11 digit BIN lookups, Accertify will query the full/encrypted Payment Card Number (PAN) | Example: 512127 | CR | |
cardAuthorizedAmount-D | PaymentAmount | Decimal | Amount authorised for payment in the currency specified in the transaction's currencyCode field. | CR | |
cardExpireDate-D | ExpirationMonth + "-" + ExpirationYear | DateTime | Credit card expiry date (MM-YY) | Example: 08-22 | CR |
cardAuthorizationDate-D | CreatedAt | DateTime | Card authorisation request date and time. | Example: 2022-07-04T04:47:14Z | O |
isPre-AuthorizationReject-D | string | Whether the transaction is sent to Accertify for checking before or after bank/payment provider confirmation. Pre-Authorisation is not currently used so the value will always be 'False'. | Default value: False | O | |
cardAvsResponse-D | CardAvsResponseD.Matched | string | Whether card expiry date user entered matches the card. | Options: Matched, Not Matched | CR |
cardCvvResponse-D | CardCvvResponseD.Matched | string | Whether CVV user entered matches the card. | Options: Matched, Not Matched | CR |
If PrimaryPaymentType = eWallet
Relevant fields when eWallet payment types are used.
Field | CV field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
wallets | n/a | object | Array with one or more ewallet arrays for required fields for this payment type. | CR | |
wallet | n/a | array | An array introducing ewallet fields. data from an object returned by Braintree. | CR | |
walletType-D | n/a | string | Type of wallet used for payment. Note: required only for eWallet | Options: Venmo, Google Pay, ApplePay, Paypal | CR |
walletAccountHolderName-D |
| string | Name of the person who owns the wallet account. | CR | |
walletAccountNumber-D |
| string | Account number of the wallet account. | CR | |
walletEmailAddress-D |
| string | Email address associated with the wallet account. | CR | |
walletAmount-D | PaymentAmount | decimal | Amount paid using the wallet account in the currency specified by the transaction currencyCode field. | CR | |
walletStatus-D | PaymentStatus | string | Status of the wallet account. Note: required only if eWallet | Options: Active, Pending, Inactive | CR |
If PrimaryPaymentType = Giftcard
Required fields when giftcards are used.
Field | CV field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
giftCards | n/a | block | Array introducing one or more giftCard arrays. | CR | |
giftCard | n/a | block | Array introducing giftCard fields. | CR | |
giftCardAmount-D | n/a | decimal | Amount applied against the gift card in the currency specified by the transaction currencyCode field. | CR |
Items Purchased
,"items":{"item":[{"itemNumber-D":"584213","itemDescription-D":"BOSE - SOUNDBAR 900 BLACK","itemAmount-D":1347.91,"itemQuantity-D":1.0000,"itemBrandName-D":"","itemCategory-D":"Soundbars","productCondition-D":"New","isGiftCardPurchased-D":"False"}]},
Field | CV Field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
items | Object | Object containing arrays of products purchased. | R | ||
item | Array | An array containing details of a product in the order. | R | ||
itemNumber-D | orderLine.StockCode | string | Product number. | ||
itemDescription-D | orderLine.Description | string | Product description. | ||
itemAmount-D | orderLine.OrderLineAmount | decimal | Product amount. | ||
itemQuantity-D | orderLine.OrderedQty | decimal | Product quantity. | ||
itemBrandName-D | orderLine.Product.BrandText | string | Product brandname. | ||
itemCategory-D | orderLine.Product.categoryDescription | string | Product category. | ||
productCondition-D | n/a | string | Product condition. | Options: New | |
isGiftCardPurchased-D | line.Product.IsGiveXGiftCard | string | Was a gift card used? | Options: True, False |
Shipping
"shippings":{"shipping":[{"shippingFirstName-D":"Andrew","shippingLastName-D":"Chia","shippingBusinessName-D":"ACEX Consulting Engineers","shippingLocationType-D":"Business","shippingAddress-D":"24 Oakwood Avenue","shippingCity-D":"Dandenong North","shippingStateCode-D":"VIC","shippingPostalCode-D":"3175","shippingCountryCode-D":"AU","shippingPhoneNumber-D":"0430924122","shippingPhoneNumberCountryCode-D":"0061","shippingEmailAddress-D":"info@acexeng.com.au","shippingCompany-D":"CNC_5","shippingMethod-D":"Other","deliveryFeeType-D":"Other","pickupVerificationMethod-D":"ID Card"}]},
Field | CV field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
shippings | n/a | ||||
shipping | n.a | ||||
shippingFirstName-D | From PSO.GetNamesForOrder(): order.ContactFirstName → user.FirstName → extracted from order.SoBillAddr1 | string | First name of the person entered for receiving the shipment. Data from first name entered for order. Falls back to saved first name of user, then first billing address field. Note: Required if purchaseType=Physical Items | CR | |
shippingLastName-D | From PSO.GetNamesForOrder(): order.ContactLastName → user.Surname → extracted from order.SoBillAddr1 | string | Last name of the person entered for receiving the shipment. Note: Required if purchaseType=Physical Items | CR | |
shippingBusinessName-D | order.SoDelAddr1 → order.SoBillAddr1 → user.DeliveryAddress1 | string | Name of the company receiving the shipment if the recipient is a company and not an individual. Note: Required if shippingLocationType= Business or Site-to-Store | CR | |
shippingLocationType-D | Business | string | |||
shippingAddress-D | order.SoDelAddr2 → order.SoBillAddr2 → user.DeliveryAddress2 | 30 cha string | Address, street name, and building number as applicable to the person receiving the shipment. Note: Required if purchaseType=Physical Items | CR | |
shippingCity-D | order[AddressRuleSets.AssignmentsSuburbField] → order.SoDelAddr5 → order.SoDelSuburb → user.DeliverySuburb | string | Customer city, town, or locality as applicable of the person receiving the shipment. Note: Required if shippingAddress-D exists. | CR | |
shippingStateCode-D | order[AddressRuleSets.AssignmentsStateField] → order.SoDelAddr4 → order.SoDelState → user.DeliveryState Note: This value is converted into the state code using a mapping list from SystemControl.Live.StateCodeAndNameMapping (eg. Queensland → QLD) | string | State, province, or region code of the receiving address entered in ISO 3166-2. Note: Required if shippingCountry has them and shippingAddress exists. | CR | |
shippingPostalCode-D | order[AddressRuleSets.AssignmentsPostcodeField] → order.SoDelAddr7 → order.SoDelPostcode → user.DeliveryPostCode | string | Postal code of receiving address validated against the GeoPostcodes database. Note: Required if the shippingCountry | CR | |
shippingCountryCode-D | Currently hard-coded. | Two-letter ISO 3166-1 code for country of shipment address. Note: Required if shippingAddress exists. | CR | ||
shippingPhoneNumber-D | order.ContactPhoneNumber → order.SoDelPhone → user.PhoneNumber | integer | Phone number entered for the shipment excluding country prefix. Note: Required if purchaseType = Physical Items. | CR | |
shippingPhoneNumberCountryCode-D | Currently hard-coded. | integer | Country code for the phone number entered for the shipment. Note: Required if shippingPhoneNumber exists. | CR | |
shippingEmailAddress-D | order.EmailAddressForGuestUser → user.ValidEmailAddress | string | Email address of the shipment recipient. Note: Required if purchaseType = Physical Items. | CR | |
shippingCompany-D | order.CarrierCode | string | Name of shipping company for merchant-to-consumer initial delivery. Note: Required if purchaseType = Physical Items. | CR | |
shippingMethod-D | Order.FreightLine.SolLineDescription | string | Type of shipping method used as found in SolLineDescription where a value can only be 'Standard' or 'Express'. If neither is found, 'Other' is used. Note: Required if shippingCompany-D exists. | Options: Standard, Express, Other | CR |
deliveryFeeType-D | string | Delivery fee type | Default: Other | CR | |
pickupVerificationMethod-D | Currently hard-coded. | string | Verification method if pickup selected. | Default: ID card | CR |
Device Info
Field | CV field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
deviceInfo | n/a | block | Array introducing the deviceInfo fields | R | |
deviceTransactionId | n/a | Token Id generated to make a call to Accertify to verify device information. Example: DID-b49aa724-bba4-4e48-bea5-8359ce8203d3 | DID_ + new Guid | R |
Accertify Results
Field | CV field | Format | Description | Value | R, O or CR |
---|---|---|---|---|---|
actionCode | n/a | Decision response returned from Accertify. | 'Accept', 'Review', 'Reject' | R |
Success and Error Messages
Below are the Fraud API responses.
Message | Description | Displayed Customer Message |
---|---|---|
200 | Success: We accepted your message and created or updated a transaction. | Success! Your transaction has been completed successfully. |
400 | Validation Failed: We could not process the API. Please try again. | Sorry, We could not process your transaction at this time. Please try again. |
500 | Internal Server Error: We could not process the API due to internal error, such as username or password is wrong. | Sorry, We could not process your transaction due to internal error, Please contact [ email address ] for further information. Note: This email address can be edited in the CMS. |
Additional Information
Minimum Version Requirements |
|
---|---|
Prerequisites |
|
Self Configurable |
|
Business Function |
|
BPD Only? |
|
B2B/B2C/Both |
|
Third Party Costs |
|
Related help