All requests can be configured for notifications, regardless of the payment method or transaction type. This allows you to keep your back office systems in synch with your customer’s payments and transactions. Notifications are sent when transaction processing is completed.
We’ll send you everything we know about the transaction including custom fields you might have asked your customer to enter, 3D Secure information, PayPal Seller Protection information, the results of Optimize rules, data we’ve added through our third party data sources (for example, supplementary card information and GeoIP enrichments) as well as information from the authoriser that includes Authorisation responses, messages and codes, AVS and CV2 responses.
You can specify where you would like the notification to be sent on every request or you can tell us where you would like them to be sent for all transactions, by default. The latter we’ll enable on your account during boarding. Where a default is set, we’ll also send notifications of transactions initiated in the Merchant Portal (for example, manual Refunds) to the specified URL.
The URL must use a host name which can be resolved using a public DNS (excluding *.pay360.com), or a public routable IP address (nothing in RFC 1918). We support connecting to merchants on ports 80 or 8080 (for HTTP) and 443 or 8443 (for HTTPS).
The IP address space is 185.161.164.0/22, which covers 1024 addresses from 185.161.164.0 through 185.161.167.255 inclusive. Requests that we originate, including notifications, will come from an address within this range. The exact addresses we use may vary from time to time.
Our APIs are continuously evolving. We will not take any fields away without giving advanced notice, but we may add new fields at any time. Your integration must be able to cope with the appearance of new fields.
If we can’t successfully deliver the notification to you first time, we’ll keep trying. A notification is considered successfully delivered if a success response (HTTP 200) is received within 10 seconds.
The notification we send
Your endpoint receives the completed transaction, in this shape:
stringMandatoryThe ID assigned to the transaction by PayPal. In the event of a technical issue, PayPal will require this ID for investigation purposes.
} ]
recurringAdvice
stringPossible values: STOPOnly in the response when the Cardholder has advised their bank to stop this recurring or instalment payment.
}
authData {
advancedPayments/auth-data
acquirerName
string (≤ 255 chars)The name of the acquirer. Maximum of 255 characters.
acquirer
string (write-only)
}
decision {
advancedPayments/decision-detailInformation about the results of a Fraud check.
decisionResult
stringPossible values: DEFER, BLOCK, PROCEEDThe result of the Fraud check.
stringPossible values: PAYMENT, PREAUTH, PAYOUT, REFUND, CAPTURE, CANCEL, REPEAT, CASH_ISSUE, CASH_PAYMENT, CASH_EXPIRE, VERIFY, PAYMENT_INITIALIZE, PAYMENT_UPDATE, PAYMENT_COMPLETE, PAYOUT_INITIALIZE, PAYOUT_UPDATE, PAYOUT_COMPLETE, RETURN, IMPORTED_PAYMENT, IMPORTED_VERIFYThe type of transaction that was submitted to Access PaySuite Advanced Payments.
decidedType
stringPossible values: PAYMENT, PREAUTH, PAYOUT, REFUND, CAPTURE, CANCEL, REPEAT, CASH_ISSUE, CASH_PAYMENT, CASH_EXPIRE, VERIFY, PAYMENT_INITIALIZE, PAYMENT_UPDATE, PAYMENT_COMPLETE, PAYOUT_INITIALIZE, PAYOUT_UPDATE, PAYOUT_COMPLETE, RETURN, IMPORTED_PAYMENT, IMPORTED_VERIFYThe new transaction type for the transaction following the Fraud check. For example, a transaction submitted as a Payment may be updated to an Authorisation (PreAuth) to allow manual review before the transaction is approved for settlement.
rulesTriggered [ {
advancedPayments/rule-triggeredAn array containing information about the Optimize fraud rules triggered.
name
stringThe rule name.
action
stringThe action advised by the rule.
description
stringThe rule description.
deferParameter
string
} ]
decisionReason
stringPossible values: DERIVED_BY_TRIGGERED_RULE_ACTION, DECIDED_BY_RISK_CONTROLS, RULE_ENGINE_UNAVAILABLE, UNABLE_TO_DEFER_TRANSACTION, NO_RULES_TRIGGEREDThe reason for the decision.
}
route
string (≤ 255 chars)The name of the processing engine your transaction was submitted to.
routeData {
advancedPayments/route-data
funds
string (≤ 255 chars)
paymentDescriptor
string (≤ 255 chars)
}
voidSuccessful
booleanIndicates if the transaction was voided by a Post Authorisation callback.
}
customFields {
advancedPayments/custom-field-stateInformation about the custom fields you submitted in the request.
fieldState [ {
advancedPayments/field-state
name
string (≤ 255 chars)MandatoryThe name of the custom field.
value
string (≤ 255 chars)The value of the custom field.
transient
booleanIndicates if the custom field is transient and should not be stored as part of the transaction.
} ]
}
threeDSecure {
advancedPayments/three-d-secure-response-detailInformation about the 3D Secure status of your transaction.
version
integer (int32)Major version of 3D Secure applied to this transaction.
protocolVersion
string (≤ 255 chars)Full protocol version of 3D Secure applied to this transaction.
versionsAttempted [ {
advancedPayments/three-d-secure-version-attemptedVersions of 3D Secure that were attempted for this transaction, in order of use. This can be used to determine when 3DSv2 could not be used, and why. A version will only be included in this list if it was meaningfully attempted, which means that the transaction must have been eligible (e.g. type, channel, payment method etc.) and the merchant's account must have been capable (e.g. the corresponding 3D Secure version was enabled on the MID, etc.) This field may be populated even if no others in this section are, e.g. to indicate that the issuer didn't support any version of 3D Secure.
version
integer (int32, min 1, max 2)Major version of 3D Secure that was attempted.
availability
stringPossible values: INSUFFICIENT_DATA, ISSUER_NO_V2, ISSUER_NO_V1, ISSUER_NO_3DS, ERROR, AVAILABLEHigh-level indication of the actual availability of the given 3D Secure version and what happened during the attempt to use it.
} ]
scheme
string (≤ 255 chars)The scheme that processed the transaction for 3DS.
status
stringPossible values: AUTHENTICATED, BYPASSED, FAILED, NOT_ENROLLED, ATTEMPTED, ENROLMENT_CHECK_FAILURE, INCOMPLETE, NOT_AVAILABLE, NOT_IMPLEMENTEDThe overall 3DS result for the transaction.
eci
string (≤ 255 chars)Electronic Commerce Indicator (ECI) for this transaction; used by the card issuer/scheme/acquirer to describe the security (inc. authentication) that has been applied. This value reflects what was obtained from the 3D Secure process; it may be modified/transformed prior to submission to an acquirer. It is provided for informational purposes only; merchants do not need to use it as part of processing, and should rely on the status and other fields for a stable interpretation of the outcome.
Common values include:
01 - Attempted authentication (Mastercard)
02 - Authenticated (Mastercard)
05 - Authenticated (Visa, American Express)
06 - Attempted authentication (Visa, American Express)
07/00 - Not authenticated/no 3D Secure
Other values not listed here may be seen for some types of transaction, at the discretion of the card scheme and/or ACS operator.
string (≤ 255 chars)Directory Server 3DSv2 transaction ID.
acsTransactionId
string (≤ 255 chars)Access Control Server (ACS) 3DSv2 transaction ID.
challengeRequest
stringPossible values: NO_PREFERENCE, NO_CHALLENGE_REQUESTED, CHALLENGE_REQUESTED, CHALLENGE_MANDATEDIndicates whether a challenge was ultimately requested or not; this reflects the final 3DSv2 request made by Access PaySuite Advanced Payments after taking into account any merchant preference and card scheme rules.
frictionless
booleanWhether the cardholder was authenticated without a challenge (frictionless flow).
cardHolderMessage
stringMessage returned by the issuer containing instructions for the cardholder.
}
paymentMethod {
MandatoryadvancedPayments/payment-method-response-detailThe payment method a transaction was taken from, as returned on a response. Carries the details of whichever method was used, named by paymentClass, together with the billing address and whether the method was stored for reuse.
registered
booleanIndicates that the customer choose to register this card payment method. This field will not be present for non-card payment methods.
isPrimary
booleanIndicates if this was Customer's primary registered payment method.
paymentAccountFingerprint
stringMerchant defined unique identifier for the payment method.
billingAddress {
advancedPayments/postal-addressThe billing address of the Customer. Will be used for AVS checks. We'll save the billing address when the customer makes their first payment. Providing a billing address for subsequent payments will update the address we've saved if you send new, empty or no values for each field.
name
string (≤ 255 chars)
line1
string (≤ 255 chars)Line 1 of the address.
line2
string (≤ 255 chars)Line 2 of the address.
line3
string (≤ 255 chars)Line 3 of the address.
line4
string (≤ 255 chars)Line 4 of the address.
district
string (≤ 255 chars)
city
string (≤ 255 chars)City of the address.
state
string (≤ 255 chars)
region
string (≤ 255 chars)Region of the address.
postcode
string (≤ 255 chars)Post Code of the address.
country
string (≤ 255 chars)Country name of the Customer's billing address.
countryCode
string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
reuse {
advancedPayments/payment-method-reuse-response
storage
stringPossible values: NEW, EXISTING, NONESpecifies whether the payment credentials for this transaction will be stored, are being reused, or will not be stored. This will reflect any override in the request.
agreement
stringPossible values: RECURRING, INSTALMENT, ADHOCSpecifies the agreement under which stored credentials will be used/are being reused. This will reflect any override in the request.
originalSchemeReference
stringScheme reference corresponding to the transaction that first stored a payment credential, if available. This will reflect any value given in the request. Where Access PaySuite has stored and reused a value on behalf of the merchant, it will be shown here.
receivedSchemeReference
stringScheme reference corresponding to the transaction that has been created, if one was received. For the initial storage of payment credentials, this will be the value that Access PaySuite will store and reuse on behalf of the merchant when necessary. For transactions which reuse a stored payment credential, this value may or may not differ from that of originalSchemeReference.
}
paymentClass
string (≤ 255 chars)MandatoryThe classification of payment method used.
card {
ConditionaladvancedPayments/card-response-detailPresent when the payment method was a card. Only one payment method object is returned, indicated by paymentClass.
cardToken
stringThe token for the card.
cardFingerprint
stringAn identifier for the card number. If multiple customers register cards with the same PAN they will get different card tokens, but the card fingerprint will be the same for them all. When a saved card is backed by a Network Token rather than the original PAN, the field is not populated.
cardType
string (≤ 255 chars)The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
cardUsageType
stringPossible values: CREDIT, DEBITThe usage type of card. Eg. DEBIT, CREDIT.
string (≤ 255 chars)The masked card number. eg. 123456******1234. Where possible, this will include the first six and last four digits; in some cases, only the last four digits will be available.
expiryDate
string (≤ 255 chars)The expiry date of the card. Formatted as MMYY.
issuer
string (≤ 255 chars)The Issuer of the card.
issuerCountry
string (≤ 255 chars)The country of the card Issuer.
cardHolderName
string (≤ 255 chars)The Cardholder's name.
cardNickname
string (≤ 255 chars)The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
issueNumber
string (≤ 255 chars)The issue number of the card used in the request.
validDate
string (≤ 255 chars)The valid from date of the card. Formatted as MMYY.
source
stringPossible values: VISA_CHECKOUT, GOOGLEPAYThis will always be GOOGLEPAY.
networkToken {
advancedPayments/network-tokenOnly present if a network token was provisioned or used during this transaction, or if provisioning was attempted and failed
status
stringPossible values: ACTIVE, SUSPENDED, DELETED, EXPIRED, UNPROVISIONEDStatus of the token at the time of this transaction.
ACTIVE: active and usable.
SUSPENDED: temporarily suspended; may be reactivated.
DELETED: permanently deleted; cardholder re-engagement required.
EXPIRED: expired; should be refreshed.
UNPROVISIONED: no token exists.
usage
stringPossible values: PROVISIONED, PROVISIONED_AND_USED, PROVISION_FAILED, USED, RENEWEDWhat happened to the token during this transaction.
PROVISIONED: the network token was provisioned after authorisation.
PROVISIONED_AND_USED: the network token was provisioned and used for authorisation.
USED: an existing network token was used for authorisation.
PROVISION_FAILED: provisioning was attempted but failed.
tokenError
stringPossible values: CARD_TOKENISATION_NOT_ALLOWED, DECLINED, SERVICE_UNAVAILABLE, SYSTEM_ERRORReason for provisioning failure.
CARD_TOKENISATION_NOT_ALLOWED: card not supported (or not currently eligible).
DECLINED: the card scheme or issuer refused to provision a token.
SERVICE_UNAVAILABLE: the scheme token service is unavailable.
SYSTEM_ERROR: unspecified error during provisioning.
expiryDate
stringToken expiry date. Formatted as MMYY.
}
new
boolean
}
paypal {
ConditionaladvancedPayments/pay-pal-response-detailPresent when the payment method was PayPal. Only one payment method object is returned, indicated by paymentClass.
payerID
string (≤ 255 chars)PayPal's identifier for the payer.
email
string (≤ 255 chars)The email associated with the PayPal account.
accountVerified
booleanIndicates whether PayPal has verified the account.
checkoutToken
stringThe PayPal checkout token for the session the payment was taken in.
source
stringPossible values: PAYPAL, PAYPAL_ONE_TOUCHWhich PayPal integration took the payment - PAYPAL for Express Checkout, or PAYPAL_ONE_TOUCH.
bnCode
stringThe PayPal partner attribution code the payment was made under.
payeeAccount
stringThe PayPal account the funds were paid to.
}
applepay {
ConditionaladvancedPayments/apple-pay-response-detailPresent when the payment method was Apple Pay. Only one payment method object is returned, indicated by paymentClass.
displayName
string (≤ 255 chars)The display name Apple Pay uses for this card (e.g. VISA 1234)
transactionIdentifier
string (≤ 255 chars)
cardType
string (≤ 255 chars)Information about the type of card used by the Apple Pay transaction.
cardUsageType
stringPossible values: CREDIT, DEBITThe card usage type (credit or debit)
ConditionaladvancedPayments/google-pay-response-detailPresent when the payment method was Google Pay. Only one payment method object is returned, indicated by paymentClass.
displayName
string (≤ 255 chars)The display name Google Pay uses for this card (e.g. Visa •••• 1111)
string (≤ 255 chars)The unique token for the payment method, returned when a card is registered. A savedAccountToken will be returned for both Google Pay non-tokenized cards (FPAN) and Android device token (DPAN) payment methods and can be used to make subsequent payments of that type.
cardDetails
stringDescrptive details of the card as provided by Google Pay. This will always be the last 4 digits of the card number
cardHolderName
stringThe cardholder name for the Google Pay payment method
}
merchantDefined {
ConditionaladvancedPayments/merchant-defined-response-detailPresent when the payment method was merchant defined. Only one payment method object is returned, indicated by paymentClass.
accountHolderName
string (≤ 255 chars)The account holder name that was supplied in the request.
paymentMethodName
string (≤ 127 chars)The payment method name that was supplied in the request.
}
openbanking {
ConditionaladvancedPayments/open-banking-response-detailPresent when the payment method was Pay by Bank. Only one payment method object is returned, indicated by paymentClass.
remittanceReference
stringThe reference the payer's bank shows against the payment.
userInterfaceDetails
object (map)Details the payer's bank supplied for display, as name and value pairs. The members vary by bank.
account {
advancedPayments/open-banking-accountThe bank account the payment came from.
sortCode
stringSort code of the payer's bank account.
accountNumber
stringNumber of the payer's bank account.
bankName
stringName of the payer's bank.
}
multiAuthorisation
stringPossible values: AUTHORISED, INCOMPLETEWhere the payer's bank requires more than one person to authorise a payment, whether every authorisation has been given yet.
mode
stringPossible values: REDIRECTHow the payer was taken to their bank to authorise the payment.
}
}
customer {
advancedPayments/transaction-customer-details
merchantRef
string (≤ 255 chars)Your reference for the Customer.
id
string (≤ 255 chars)The ID given to the Customer by the processing engine.
displayName
string (≤ 255 chars)The Customer's name.
billingAddress {
advancedPayments/postal-address
name
string (≤ 255 chars)
line1
string (≤ 255 chars)Line 1 of the address.
line2
string (≤ 255 chars)Line 2 of the address.
line3
string (≤ 255 chars)Line 3 of the address.
line4
string (≤ 255 chars)Line 4 of the address.
district
string (≤ 255 chars)
city
string (≤ 255 chars)City of the address.
state
string (≤ 255 chars)
region
string (≤ 255 chars)Region of the address.
postcode
string (≤ 255 chars)Post Code of the address.
country
string (≤ 255 chars)Country name of the Customer's billing address.
countryCode
string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
email
string (≤ 255 chars)Email address for the Customer.
dob
string (≤ 255 chars)Date of birth for the Customer.
dateOfBirth
string (date)
telephone
string (≤ 255 chars)Telephone number for the Customer.
booleanMandatoryIndicates if the customer was registered.
}
financialServices {
advancedPayments/financial-servicesSupplementary data for Financial Services payments, including loan repayments and other credit-related activities, as submitted with the transaction.
dateOfBirth
string (pattern ^[0-9]{8}$)Date of birth of the recipient, in YYYYMMDD format. For example, for Jan 2nd, 1980, this would be "19800102".
surname
string (pattern ^\p{L}{1,6}$)Surname/family name of the recipient; up to six characters, excluding numbers or special characters. For example, for "Smith", this would be "Smith"; for "Williams", this would be "Willia".
accountNumber
string (pattern ^[a-zA-Z0-9]{1,10}$)Account number used to identify the recipient or loan. For a PAN, the first six and last four digits of the PAN; otherwise up to ten characters of the account number.
postCode
string (pattern ^[a-zA-Z0-9]{1,6}$)First part of the postal code of the recipient; up to six characters. For example, if the postal code is "EC2A 1AE", this would be "EC2A".
}
accountFunding {
advancedPayments/account-fundingSupplementary data for Account Funding Transactions (AFT), e.g. money transfers, as submitted with the transaction.
recipient {
advancedPayments/account-funding-recipient-detailsDetails about the funding recipient
givenName
string (≤ 255 chars, pattern ^[a-zA-Z0-9][A-Za-z0-9 ]*$)Recipient's given name
surname
string (≤ 255 chars, pattern ^[a-zA-Z0-9][A-Za-z0-9 ]*$)Recipient's surname/family name
string (≤ 255 chars, pattern ^[a-zA-Z0-9][A-Za-z0-9 ]*$)Recipient city
state
string (2–3 chars, pattern ^[A-Za-z0-9]+$)ConditionalOnly for recipients based in the US or Canada Recipient state/province code (2-3 characters), e.g. "CA", "DE", "MD", "TN" et al. in the US; "AB", "ON", "QC", "SK" et al. in Canada
countryCode
string (≤ 3 chars, pattern ^[A-Z]+$)Recipient country code (ISO-3166-alpha-3), e.g. "CAN", "GBR", "USA" et al.
booleanIndicates if the Payment capture is deferred.
deferralExpires
string (date-time)
recurring
booleanIndicates if the payment was a recurring payment.
instalment
booleanIndicates if the payment was an instalment.
merchantRef
string (≤ 255 chars)Your reference for the transaction.
merchantDescription
string (≤ 255 chars)The description of the transaction provided in the request.
status
stringPossible values: SUCCESS, FAILED, PENDING, EXPIRED, CANCELLED, VOIDEDThe current state of the transaction.
type
stringPossible values: PAYMENT, PREAUTH, PAYOUT, REFUND, CAPTURE, CANCEL, REPEAT, CASH_ISSUE, CASH_PAYMENT, CASH_EXPIRE, VERIFY, PAYMENT_INITIALIZE, PAYMENT_UPDATE, PAYMENT_COMPLETE, PAYOUT_INITIALIZE, PAYOUT_UPDATE, PAYOUT_COMPLETE, RETURN, IMPORTED_PAYMENT, IMPORTED_VERIFYIndicates the type of the transaction.
amount
floatIndicates the requested amount of the transaction.
consumerSpend
floatIndicates the actual amount of the transaction. This will be zero for any type of INITIALIZE transaction, deferred transactions, and rejected transactions.
currency
string (≤ 3 chars)Indicates the currency of the transaction. Use the 3 character ISO-4217 code.
transactionTime
string (date-time)The date and time we processed the transaction in ISO-8601 format.
receivedTime
string (date-time)The date and time we received the transaction in ISO-8601 format.
commerceType
stringPossible values: ECOM, MOTO, CNPThe Commerce Type of the transaction.
channel
stringPossible values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, VIRTUAL_TERMINAL, OTHERThe Sales Channel of the transaction.
relatedTransaction {
advancedPayments/related-transactionThis field is not applicable for Payments. In case of Refunds it indicates the transaction that was refunded.
transactionId
string (≤ 255 chars)MandatoryOur ID for the transaction that was original.
merchantRef
string (≤ 255 chars)Your reference for the transaction that was original.
}
billingDescriptor
string
customerInitiated
boolean
stage
stringPossible values: INITIALIZE, THREE_D_SECURE, FRAUD_RULES, AUTHORISATION, EXTERNAL_PROCESSING, COMPLETEThe logical stage the transaction has reached.
continuousAuthorityAgreement {
advancedPayments/continuous-authority-agreementThe continuous authority agreement established with the cardholder. Required if you want to process a transaction initiating a recurring or instalment series using 3DSv2.
minFrequency
integer (int32, min 1, max 9999)ConditionalMinimum number of days expected between payments in a recurring or instalment sequence. Must be >= 1.
expiry
string (date)ConditionalDate (YYYY-MM-DD) at which recurring/instalment agreement expires, or at which it will need to be re-authenticated in order to continue. Must be in the future.
numberOfInstalments
integer (int32, min 2, max 999)ConditionalTotal number of payments in an instalment sequence - including this one, if starting with a payment. Required only for instalments; must be >= 2.
}
}
paypalSellerProtection {
advancedPayments/paypal-seller-protection
sellerProtectionType
string (≤ 255 chars)Indicates the level of Seller Protection PayPal has assigned to this transaction. Please refer to PayPal's documentation for more information.
}
order {
advancedPayments/order
orderRef
string (≤ 255 chars)Your reference for the order. Maximum length: 255.
taxAmount
float
taxRate
float
shippingAddress {
advancedPayments/postal-address
name
string (≤ 255 chars)
line1
string (≤ 255 chars)Line 1 of the address.
line2
string (≤ 255 chars)Line 2 of the address.
line3
string (≤ 255 chars)Line 3 of the address.
line4
string (≤ 255 chars)Line 4 of the address.
district
string (≤ 255 chars)
city
string (≤ 255 chars)City of the address.
state
string (≤ 255 chars)
region
string (≤ 255 chars)Region of the address.
postcode
string (≤ 255 chars)Post Code of the address.
country
string (≤ 255 chars)Country name of the Customer's billing address.
countryCode
string (≤ 3 chars)The 3 character ISO-3166-1 code for the address country.
}
items [ {
advancedPayments/line-itemList of products/services in the order.
name
string (≤ 255 chars)MandatoryName of the item. Maximum length: 255.
description
string (≤ 255 chars)Description of the item. Maximum length: 255.
itemRef
string (≤ 255 chars)Your reference for the item. Maximum length: 255.
lineRef
string (≤ 255 chars)Your reference for the line item of the order. Maximum length: 255.
itemAmount
floatMandatoryThe individual amount of the item.
quantity
integer (int32)The quantity of items in the order. Defaults to 1 if not provided.
totalAmount
floatThe total amount of the items. Defaults to itemAmount × quantity if not provided.
itemTaxAmount
float
taxRate
float
totalTaxAmount
float
customFields [ {
advancedPayments/custom-field
name
string (≤ 255 chars)MandatoryThe name of the custom field.
value
string (≤ 255 chars)The value of the custom field.
} ]
} ]
}
sessionId
string (≤ 255 chars)ConditionalOur ID for the hosted session when the PaySuite Payment Page took the payment, or the sessionId you sent on the request. Absent otherwise.
installationId
stringThe installation the transaction was processed under.
strongCustomerAuthentication {
advancedPayments/strong-customer-authentication
transactionType
stringPossible values: GOODS_OR_SERVICES, CHECK_ACCEPTANCE, ACCOUNT_FUNDING, QUASI_CASH, PREPAID_ACTIVATIONDetailed classification of the transaction.
string (≤ 254 chars)For electronic delivery, the email address to which the merchandise was delivered.
deliveryTimeframe
stringPossible values: ELECTRONIC, SAME_DAY, OVERNIGHT, TWO_OR_MORE_DAYSTime frame for merchandise delivery.
giftCardPurchase {
advancedPayments/gift-card-purchase
totalAmount
integer (int32)Total value of gift cards being purchased (major units, e.g. for GBP 12.99, use 12).
currency
string (3 chars)Currency code of cards being purchased.
count
integer (int32, max 99)Total number of cards being purchased.
}
preorder
booleanWas this a pre-order of merchandise which will be available in the future?
preorderDate
string (date)For pre-orders, the date at which merchandise is expected to be available.
reorder
booleanWas the cardholder re-ordering merchandise previously purchased from this merchant?
shippingTo
stringPossible values: BILLING_ADDRESS, VERIFIED_ADDRESS, OTHER_ADDRESS, STORE, DIGITAL, TRAVEL_EVENT, OTHERIndicates the type of shipping address (or shipping method) for the merchandise.
}
accountInfo {
advancedPayments/account-information
accountOpened {
advancedPayments/account-opened
period
stringPossible values: GUEST_CHECKOUT, THIS_TRANSACTION, LESS_THAN_30_DAYS, BETWEEN_30_AND_60_DAYS, MORE_THAN_60_DAYSRelative time period when the account was opened.
date
string (date)Date the account was opened.
}
accountLastChanged {
advancedPayments/account-last-changed
period
stringPossible values: THIS_TRANSACTION, LESS_THAN_30_DAYS, BETWEEN_30_AND_60_DAYS, MORE_THAN_60_DAYSRelative time period when the account was last changed.
date
string (date)Date the account was last changed.
}
passwordLastChanged {
advancedPayments/password-last-changed
period
stringPossible values: NO_CHANGE, THIS_TRANSACTION, LESS_THAN_30_DAYS, BETWEEN_30_AND_60_DAYS, MORE_THAN_60_DAYSRelative time period when the password was last changed.
date
string (date)Date the password was last changed.
}
activity {
advancedPayments/activity
purchasesInLastSixMonths
integer (int32, max 9999)Number of purchases made with the account in the previous six months.
addCardAttemptsInLast24Hours
integer (int32, max 999)Number of attempts to add a payment card to the account in the previous 24 hours.
transactionAttemptsInLast24Hours
integer (int32, max 999)Number of transactions (successful and abandoned) for the account in the previous 24 hours.
transactionAttemptsInLastYear
integer (int32, max 999)Number of transactions (successful and abandoned) for the account in the previous year.
}
paymentAccountRegistered {
advancedPayments/payment-account-registered
period
stringPossible values: GUEST_CHECKOUT, THIS_TRANSACTION, LESS_THAN_30_DAYS, BETWEEN_30_AND_60_DAYS, MORE_THAN_60_DAYSRelative time period for the payment account registration.
date
string (date)Date the payment account was registered.
}
shippingAddressFirstUsed {
advancedPayments/shipping-address-first-used
period
stringPossible values: THIS_TRANSACTION, LESS_THAN_30_DAYS, BETWEEN_30_AND_60_DAYS, MORE_THAN_60_DAYSRelative time period for the first use of the shipping address.
date
string (date)Date the shipping address was first used.
}
shippingNameSameAsAccountName
booleanIs the name on the account identical to the recipient name in the shipping address?
suspiciousActivity
booleanHas suspicious activity (including fraud) previously occurred on this account?