You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Available for integration with Braintree Payments and Eway. For more information on this integration, go to the Accertify website.

On this page:

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


Data Fields

Request 

FieldCV fieldFormatDescriptionValue

R, O or CR

transactionId
stringGuid generated to identify transaction.
R
transactionType
string

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

Note: only post-authorisation available.

Default: Post-Authorization

R

transactionDateTime
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:00R
cartIdSoOrderNostringOrder number generated on website that can be used as additional identifier of transaction. 
O
transactionTotalAmountorder.OrderTotalAmountdecimalTotal amount of transaction, including shipping and taxes.
R
taxAmountOrderTotalTaxdecimalTax amount included in transaction.  
O
salesChannelSalesChannel.WebstringWay/path transaction occurred

Options: Call Centre, Kiosk, Web, Mobile App, Other

Default: Web

R
websiteURLSystemControl.Live.WebSiteURLstringURL of your ecommerce website
O
ipAddressUtil.RequestIpAddressstring

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
currencyCodeorder.Customer.CurrencyCodeToUsestringUser's local currency in ISO 4217 format.  Example: AUDR
isGift

Is purchase a gift?Default: FalseO

Billing (object)

These fields generate the. 

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

DataCV FieldFormatDescriptionValueR, O or  CR
billing

n/a

objectArray that contains the purchaser's name, billing address, order delivery address and captured payment details
R
billingFirstName

order.SoOrderingUser.FirstName

Fallback: PSO.GetNamesForOrder()

stringBilling 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
stringCompany name if entered.

billingEmailAddressorder.EmailAddressForGuestUser / user.ValidEmailAddressstringEmail address entered for guest user order; for logged in user, new or saved email address.
R
billingAddressorder.SoBillAddr2 → order.SoDelAddr2 → user.SoBillAddr2stringStreet 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

string


billingCityorder.SoBillSuburb → order.SoDelSuburb → user.SoBillSuburbstringBilling 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
billingStateCodeorder.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, WACR
billingPostalCodeorder.SoBillPostcode → order.SoDelPostcode → user.SoBillPostcodestringFour digit postcode.
R
billingCountryCodeCurrently hard-coded.stringTwo digit (ISO-3166-1) country code for billing address. Example: AU
R
billingPhoneNumber

Note: Currently hard-coded.

order.ContactPhoneNumber → order.DelPhone → user.PhoneNumber

integerBilling phone number entered. Must exclude Phone country code. Numeric only. No spaces (max=25) No spaces or special characters.
R
billingPhoneNumberCountryCodeCurrently hard-coded.stringCountry code of billing phone number.

Example: '0061'

R
primaryPaymentType
stringPurchaser's primary method of payment.Credit Card, Debit Card, Virtual Card, Gift Card, eWalletR
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, OtherR






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"

FieldCV fieldFormatDescriptionValueR, O or CR
cardsn/aobjectArray with one or more card arrays for required fields for this payment type.
CR
cardn/aarray

An array introducing card fields. data from an object returned by Braintree  Part of the cards fields on page 14 of the API Document.  


CR
cardholderName-D
stringCardholder'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: 512127CR
cardAuthorizedAmount-DPaymentAmountDecimalAmount authorised for payment in the currency specified in the transaction's currencyCode field. 
CR
cardExpireDate-DExpirationMonth + "-" + ExpirationYearDateTimeCredit card expiry date (MM-YY)Example: 08-22CR
cardAuthorizationDate-DCreatedAtDateTimeCard authorisation request date and time.Example: 2022-07-04T04:47:14ZO
isPre-AuthorizationReject-D
stringPre-Authorisation is not currently used so the value will always be False.Default value: FalseO
cardAvsResponse-DCardAvsResponseD.MatchedstringWhether card expiry date user entered matches the card.Options: Matched, Not Matched CR
cardCvvResponse-DCardCvvResponseD.MatchedstringWhether CVV user entered matches the card.  Options: Matched, Not Matched CR

If PrimaryPaymentType = eWallet

Relevant fields when eWallet payment types are used.


FieldCV fieldFormatDescriptionValueR, O or CR
walletsn/aobjectArray with one or more ewallet arrays for required fields for this payment type.
CR
walletn/aarray

An array introducing ewallet fields. data from an object returned by Braintree.  


CR
walletType-D n/astring

Type of wallet used for payment. 

Note: required only for eWallet

Options: Venmo, Google Pay, PaypalCR
walletAccountHolderName-D 
  • Paypal: PayerFirstName + PayerLastName 
  • Apple Pay: CardholderName 
  • Google Pay: FirstName + LastName
string

Name of the person who owns the wallet account.


CR

walletAccountNumber-D
  • Paypal: PayerId 
  • Apple Pay: GlobalId
  • Google Pay: GlobalId
string

Account number of the wallet account.


CR
walletEmailAddress-D
  • Paypal: PayerEmail
  • Apple Pay: EmailAddress
  • Google Pay: EmailAddress
stringEmail address associated with the wallet account. 
CR
walletAmount-D PaymentAmountdecimalAmount paid using the wallet account in the currency specified by the transaction currencyCode field.
CR
walletStatus-DPaymentStatusstring

Status of the wallet account.  

Note: required only if eWallet

Options: Active, Pending, InactiveCR

If PrimaryPaymentType = Giftcard

Relevant fields when giftcards are used.


FieldCV fieldFormatDescriptionValueR, O or CR

n/aobject

CR

n/aarray



CR

n/astring



CR

string



CR


string



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"}]},

FieldMandatoryDescriptionValue
itemNumber-D
Product number.
itemDescription-D

Product description.


itemAmount-D
Product amount.
itemQuantity-D
Product quantity.
itemBrandName-DOProduct 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"}]},

FieldCV fieldDescriptionValue
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"}}

FieldCV fieldDescriptionValue
deviceTransactionIdn/aToken Id generated to make a call to Accertify to verify device information. 

Accertify Results

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

FieldCV fieldDescriptionValue
actionCode
Decision response returned from Accertify.'Accept', 'Review', 'Reject'






Additional Information



Minimum Version Requirements


4.37.00

Prerequisites


**

Self Configurable


Yes

Business Function


Security

BPD Only?


Yes

B2B/B2C/Both


Both

Third Party Costs


yes


Related help



  • No labels