Page History

Post-Authorisation Flow

{"transaction":{"transactionId":"9e03603e-0b1a-41dc-b1e4-b169b0f27a00","transactionType":"Post-Authorization","transactionDateTime":"2022-09-15T21:03:47+10:00","cartId":"100446361","transactionTotalAmount":1347.91,"taxAmount":122.54,"salesChannel":"Web","websiteUrl":"https://www.jbhifi.business","ipAddress":"121.200.6.25","currencyCode":"AUD","isGift":"False","billing":{"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"}]}},"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"}]},"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"}]},"deviceInfo":{"deviceTransactionId":"DID-f09a967a-7c2b-437a-9f96-09a49192f7e4"},"actionCode":"Review"}}

List of Data Fields

Request

Field	CV field	Format	Description	Value	R, O or CR
transactionId

M

string

Unique

Identifier

guid id generated for transaction

generated from payment system

.		R
transactionType

M

string

Which Accertify fraud check module is used

Send transaction to Accertify before or after authorisation with payment provider/bank.

Note: only post-authorisation available.

Default: Post-Authorization

R

transactionDateTime

M

datetime

Date and time transaction occurred 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

McurrencyCodeCurrency of transaction in three characters. Example: AUD

string			O
transactionTotalAmount	order.OrderTotalAmount	decimal	Total amount of transaction, including shipping and taxes.		R
taxAmount	OrderTotalTax	decimal	Tax amount in transaction		O
salesChannel	SalesChannel.Web	string	Way/path transaction occurred	Options: Call Centre, Kiosk, Web, Mobile App, Other Default: Web	R
websiteURL	SystemControl.Live.WebSiteURL	string	URL of ecommerce website		O
ipAddress

IP address of your ecommerce site. Example: 100.100.8.20.

Util.RequestIpAddress

string

User's IP captured in IPv4 or IPv6 formats.

Required for channels: Kiosk, Mobile App, Web, Other

Examples:

IPv4: 10.12.12.123
IPv6: 2001:0db8:85a3:0000:0000:8a2e:0370:7334

CR

currencyCode

order.Customer.CurrencyCodeToUse

string

User's local currency in ISO 4217 format.

Example: AUD

R

isGift

Is purchase a gift?

'True' or 'False'

Billing

Default: False

O

Billing (object)

These fields generate the purchaser's name, billing address, order delivery address and captured payment details.

{"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"

Field	CV

field

Field	Format	Description	Value
billingFirstName	order.SoOrderingUser.FirstName Fallback: PSO.GetNamesForOrder()	string	First name entered for purchaser.	R
billingLastName	order.SoOrderingUser.Surname Fallback: order.GetNamesForOrder	string	Last name entered for purchaser.	R
billingCompanyName		string	Company name if entered.
billingEmailAddress	order.EmailAddressForGuestUser / user.ValidEmailAddress	string	Billing email address entered for purchaser.	R
billingAddress	order.SoBillAddr2 → order.SoDelAddr2 → user.SoBillAddr2	string	Street number and name of billing address entered	R
billingAddressLine2	Fall back in ascending order: order.SoBillAddr2 → order.SoDelAddr2 → user.SoBillAddr2	string
billingCity		string	Billing city, town, suburb entered.	R
billingStateCode

Three alphanumeric state code.billingPostalCode

	order.SoBillState → order.SoDelState → user.SoBillState	string	State, territory or region code in ISO 3166-2. 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	Four digit postcode.		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. No spaces (max=25) No spaces or special characters.		R
billingPhoneNumberCountryCode	Currently hard-coded.	string	Country code of billing phone number.	Example: '0061'	R
primaryPaymentType

Credit card, PayPal, ApplePay or GooglePay.purchaseTypeValues: 'Physical Items'

Credit Cards

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

PrimaryPaymentType = Credit Card, Debit Card, Virtual Card

Cards object - array with one or more card arrays.

,"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	Format	Description	Value
cards	object	Array introducing one or more card arrays Part of the cards fields on page 14 of the API Document. This is a required field if primaryPaymentType=credit, debit virtual or card
cardholderName-D		Cardholder's name.
cardNumber-D		Credit card number.
binIin-D
cardAuthorizedAmount-D		Amount authorised for payment.
cardExpireDate-D		Credit card expiry date (YYYYMM)
cardAuthorizationDate-D		Card authorisation request date and time.
isPre-AuthorizationReject-D		True or False.	Default value:
cardAvsResponse-D		Whether card expiry date user entered matches the card.	Values: 'Matched' ??
cardCvvResponse-D		Whether CVV user entered matches the card.	Values: 'Matched' ??

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	Mandatory	Description	Value
itemNumber-D		Product number.
itemDescription-D		Product description.
itemAmount-D		Product amount.
itemQuantity-D		Product quantity.
itemBrandName-D	O	Product brandname.
itemCategory-D		Product category.
productCondition-D		Product condition.	'New'
isGiftCardPurchased-D		Was a gift card used?	'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	Description	Value
shippingFirstName-D
shippingLastName-D			Default: Post-Authorization
shippingBusinessName-D
shippingLocationType-D
shippingAddress-D
shippingCity-D
shippingStateCode-D
shippingPostalCode-D
shippingCountryCode-D
shippingPhoneNumber-D
shippingPhoneNumberCountryCode-D
shippingEmailAddress-D
shippingCompany-D
shippingMethod-D
deliveryFeeType-D
pickupVerificationMethod-D

Device Info

"deviceInfo":{"deviceTransactionId":"DID-f09a967a-7c2b-437a-9f96-09a49192f7e4"},"actionCode":"Review"}}

Field	CV field	Description	Value
deviceTransactionId	n/a	Token Id generated to make a call to Accertify to verify device information.

Accertify Results

"deviceInfo":{"deviceTransactionId":"DID-f09a967a-7c2b-437a-9f96-09a49192f7e4"},"actionCode":"Review"}}

Field	CV field	Description	Value
actionCode		Decision response returned from Accertify.	'Accept', 'Review', 'Reject'

Additional Information

Multiexcerpt

hidden	true
MultiExcerptName	Additional Info

Integrate Accertify's credit card fraud check solution to the Braintree Payments gateway.

Multiexcerpt

hidden	true
MultiExcerptName	Feature Title

Accertify Fraud Check API

Minimum Version Requirements

Multiexcerpt

MultiExcerptName	Minimum Version Requirements

4.37.00

Prerequisites

Multiexcerpt

MultiExcerptName	Pre reqs

**

Self Configurable

Multiexcerpt

MultiExcerptName	Self Configurable

Yes

Business Function

Multiexcerpt

MultiExcerptName	Business Function

Security

BPD Only?

Multiexcerpt

MultiExcerptName	BPD Only

Yes

B2B/B2C/Both

Multiexcerpt

MultiExcerptName	B2B/B2C/Both

Both

Third Party Costs

Multiexcerpt

MultiExcerptName	Third Party Costs

yes

Related help

Content by Label

showLabels	false
max	5
spaces	KB
showSpace	false
sort	modified
reverse	true
type	page
cql	label = "payment" and type = "page" and space = "KB" and title ~ "'Braintree credit card'"
labels	user accounts

Content by Label

showLabels	false
max	5
spaces	KB
showSpace	false
sort	modified
reverse	true
title	Related widgets
type	page
excludeCurrent	true
cql	label = "widget" and type = "page" and space = "KB" and title ~ "'review notes'"
labels	user accounts

Space shortcuts

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Post-Authorisation Flow

List of Data Fields

Request

Billing (object)

PrimaryPaymentType = Credit Card, Debit Card, Virtual Card

Items Purchased

Shipping

Device Info

Accertify Results

Additional Information

Minimum Version Requirements

Related help