[go: up one dir, main page]
Account Verification
Developer Documents‣Cards‣Account Verification

 

Submit customer account verification initiated online using the Account Verification Request.

For any Financial Services merchants, there are also additional request parameters that are required as mandatory. You can see these highlighted in the below request body. Please note that these specific parameters will not be applicable to any other merchants type.

Merchant category code (MCC) 6012 is used for a variety of financial institution payments, including: Debit Card to Credit Card, PayDay Loans, Mortgages, Crowd Funding & Balance Transfers.
APIHosted
API examples
Account Verification for new customer

POST /acceptor/rest/transactions/{instId}/verify
{
  "transaction" : {
    "currency" : "GBP",
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "MOTO"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "4444333322221111",
      "cv2" : "123",
      "expiryDate" : "0118",
      "startDate" : "1111",
      "cardType" : "MC_DEBIT",
      "nickname" : "John",
      "cardHolderName" : "John Smith",
      "defaultCard" : false
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412",
    "displayName" : "Mr O Whatasillyname",
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    },
    "email" : "test@test.com",
    "dateOfBirth" : "1995-11-20",
    "telephone" : "0123 456 789",
    "defaultCurrency" : "GBP",
    "ip" : "212.58.253.67"
  },
  "verification" : {
    "acquirerPaymentMethod" : true
  }
}

HTTP/1.1 201

{
  "processing" : {
    "authResponse" : {
      "acquirerName" : "HSBC Merchant Services Domestic",
      "message" : "TEST AUTH",
      "authCode" : "9999",
      "gatewayMessage" : "TEST AUTH",
      "status" : "AUTHORISED"
    },
    "route" : "GATEWAY"
  },
  "paymentMethod" : {
    "registered" : true,
    "card" : {
      "cardToken" : "MT_wpL9AdPDQnyeVHoh74AhHQ",
      "new" : true,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "CREDIT",
      "maskedPan" : "444433******1111",
      "expiryDate" : "0118",
      "issuer" : "DATACASH",
      "issuerCountry" : "GBR",
      "cardHolderName" : "John Smith",
      "cardNickname" : "John",
      "validDate" : "1111"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD"
  },
  "customFields" : {
    "fieldState" : [ {
      "name" : "measure_CV2_FAILURES",
      "value" : "0",
      "transient" : false
    }, {
      "name" : "measure_TOTAL_CARD_SPEND",
      "value" : "0",
      "transient" : false
    } ]
  },
  "customer" : {
    "id" : "10983",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "13133368184",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "SUCCESS",
    "type" : "VERIFY",
    "transactionTime" : "2017-01-13T14:37:16.939Z",
    "receivedTime" : "2017-01-13T14:37:16.939Z"
  },
  "outcome" : {
    "status" : "SUCCESS",
    "reasonCode" : "S100",
    "reasonMessage" : "Authorised"
  },
  "trace" : "TwhsPsp26F1zhB2Qf__9Iww",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://api.mite.pay360.com/acceptor/rest/transactions/5555/13133368184"
  } ]
}
Account Verification for existing customer with default card

POST /acceptor/rest/transactions/{instId}/verify
{
  "transaction" : {
    "currency" : "GBP",
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "MOTO"
  },
  "paymentMethod" : {
    "fromCustomer" : {
      "cv2" : "123"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412"
  },
  "verification" : {
    "acquirerPaymentMethod" : true
  }
}

HTTP/1.1 201
{
  "processing" : {
    "authResponse" : {
      "acquirerName" : "HSBC Merchant Services Domestic",
      "message" : "TEST AUTH",
      "authCode" : "9999",
      "gatewayMessage" : "TEST AUTH",
      "status" : "AUTHORISED"
    },
    "route" : "GATEWAY"
  },
  "paymentMethod" : {
    "registered" : true,
    "card" : {
      "cardToken" : "MT_wpL9AdPDQnyeVHoh74AhHQ",
      "new" : false,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "CREDIT",
      "maskedPan" : "444433******1111",
      "expiryDate" : "0118",
      "issuer" : "DATACASH",
      "issuerCountry" : "GBR",
      "cardHolderName" : "John Smith",
      "cardNickname" : "John",
      "validDate" : "1111"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD"
  },
  "customFields" : {
    "fieldState" : [ {
      "name" : "measure_CV2_FAILURES",
      "value" : "0",
      "transient" : false
    }, {
      "name" : "measure_TOTAL_CARD_SPEND",
      "value" : "0",
      "transient" : false
    } ]
  },
  "customer" : {
    "id" : "10983",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "13133368188",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "SUCCESS",
    "type" : "VERIFY",
    "transactionTime" : "2017-01-13T14:43:30.826Z",
    "receivedTime" : "2017-01-13T14:43:30.826Z"
  },
  "outcome" : {
    "status" : "SUCCESS",
    "reasonCode" : "S100",
    "reasonMessage" : "Authorised"
  },
  "trace" : "TlPf7wPhYz74omikYuxLQmg",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://api.mite.pay360.com/acceptor/rest/transactions/5555/13133368188"
  } ]
}
Account Verification for existing customer with new card

POST /acceptor/rest/transactions/{instId}/verify
{
  "transaction" : {
    "currency" : "GBP",
    "description" : "Sample Transaction",
    "merchantRef" : "mer_txn_1234556",
    "commerceType" : "MOTO"
  },
  "paymentMethod" : {
    "card" : {
      "pan" : "4444333322221111",
      "cv2" : "123",
      "expiryDate" : "0118",
      "startDate" : "1111",
      "cardType" : "MC_DEBIT",
      "nickname" : "John",
      "cardHolderName" : "John Smith",
      "defaultCard" : false
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "countryCode" : "GBR"
    }
  },
  "customer" : {
    "merchantRef" : "mer_cust_131241412"
  },
  "verification" : {
    "acquirerPaymentMethod" : true
  }
}

HTTP/1.1 201

{
  "processing" : {
    "authResponse" : {
      "acquirerName" : "HSBC Merchant Services Domestic",
      "message" : "TEST AUTH",
      "authCode" : "9999",
      "gatewayMessage" : "TEST AUTH",
      "status" : "AUTHORISED"
    },
    "route" : "GATEWAY"
  },
  "paymentMethod" : {
    "registered" : true,
    "card" : {
      "cardToken" : "MT_wpL9AdPDQnyeVHoh74AhHQ",
      "new" : false,
      "cardType" : "VISA_DEBIT",
      "cardUsageType" : "DEBIT",
      "cardScheme" : "VISA",
      "cardCategory" : "CREDIT",
      "maskedPan" : "444433******1111",
      "expiryDate" : "0118",
      "issuer" : "DATACASH",
      "issuerCountry" : "GBR",
      "cardHolderName" : "John Smith",
      "cardNickname" : "John",
      "validDate" : "1111"
    },
    "billingAddress" : {
      "line1" : "Flat 1 ",
      "line2" : "Cauldron house",
      "line3" : "A Street",
      "line4" : "Twertonia",
      "city" : "Bath",
      "region" : "Somerset",
      "postcode" : "BA1 234",
      "country" : "United Kingdom",
      "countryCode" : "GBR"
    },
    "paymentClass" : "CARD"
  },
  "customFields" : {
    "fieldState" : [ {
      "name" : "measure_CV2_FAILURES",
      "value" : "0",
      "transient" : false
    }, {
      "name" : "measure_TOTAL_CARD_SPEND",
      "value" : "0",
      "transient" : false
    } ]
  },
  "customer" : {
    "id" : "10983",
    "merchantRef" : "mer_cust_131241412"
  },
  "transaction" : {
    "transactionId" : "13133368189",
    "merchantRef" : "mer_txn_1234556",
    "merchantDescription" : "Sample Transaction",
    "status" : "SUCCESS",
    "type" : "VERIFY",
    "transactionTime" : "2017-01-13T14:46:57.260Z",
    "receivedTime" : "2017-01-13T14:46:57.260Z"
  },
  "outcome" : {
    "status" : "SUCCESS",
    "reasonCode" : "S100",
    "reasonMessage" : "Authorised"
  },
  "trace" : "TCxTdG2k5Qkb2IDEjaAe5Gg",
  "link" : [ {
    "rel" : "transaction",
    "href" : "https://api.mite.pay360.com/acceptor/rest/transactions/5555/13133368189"
  } ]
}
API Endpoint
endpoint: /acceptor/rest/transactions/{instId}/verify
method: POST
summary: process Account Verification

parameters:

Name
Data Type
Description
instId
string
The installation id
request body:
{
browserInfo {
userAgentHeader string
The Customer’s user agent.
}
sessionId string
Your reference for the Customer’s session.
transaction { Mandatory
currency string
Mandatory
The curency for your Customer’s transaction.
commerceType string
Mandatory
Possible Values: ECOM, MOTO, CA
The commerce type for your Customer’s transaction.
channel string
Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER
The sales channel for your Customer’s transaction.
merchantRef string
Your reference for the transaction. Max length: 255. It’s recommended that you keep this unique.
deferred boolean
Indicates if you want the Payment to be Authorised and Captured separately.
recurring boolean
Set this field if you want to start a recurring Continuous Authority relationship from this transaction.
instalment boolean
Set this field if you want to start an instalment Continuous Authority relationship from this transaction.
description string
The description of the transaction. Maximum length: 255.
continuousAuthorityAgreement { Conditional
The 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
Mandatory
Minimum number of days (>=1) between payments in a recurring or instalment sequence.
expiry string
Mandatory
Date at which recurring/instalment agreement expires (or will need to be re-authenticated in order to continue). In the YYYY-MM-DD format. Must be in future.
numberOfInstalments integer
Conditional
Total number of payments (>=2) in an instalment sequence (including this one, if starting with a payment). An instalment sequence must consist of two or more payments. Mandatory for initiating an instalment series.
}
}
locale string
The ISO-639 code for your Customer’s locale.
customer {
id string
Our ID for the Customer where they are already registered with us.
update boolean
Indicates if you want to update the Customer’s details with the transaction.
email string
Email address for the Customer.
merchantRef string
Conditional
Your reference for the Customer. Not required if registered is set to false, mandatory otherwise.
dob string
Date of birth for the Customer.
billingAddress { The address of the Customer.
line1 string
Line 1 of the Customer’s address.
line2 string
Line 2 of the Customer’s address.
line3 string
Line 3 of the Customer’s address.
line4 string
Line 4 of the Customer’s address.
city string
City of the Customer’s address.
region string
Region of the Customer’s address.
postcode string
Post Code of the Customer’s address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s address country
}
displayName string
Conditional
The Customer’s name. Not required if registered is set to false, mandatory otherwise.
telephone string
Telephone number for the Customer.
ip string
The Customer’s IP address.
registered boolean
Indicates if we should register your customer; false if you do not wish to register your customer, otherwise set to true, default value is true.
}
financialServices { Mandatory for Fin-Services
dateOfBirth string
Mandatory for Fin-Services
The Customer’s date of birth.
surname string
Mandatory for Fin-Services
The Customer’s surname.
accountNumber string
Mandatory for Fin-Services
The loan account number provided by the merchant, to the Customer.
postCode string
Mandatory for Fin-Services
The postal code of the Customer’s billing address.
}
transactionOptions {
do3DSecure boolean
Indicates if the transaction should be processed with 3DS. This will override account configuration for 3DS.
}
paymentMethod { Mandatory
fromCustomer { Mandatory
Use if you want to use your Customer’s default card. This section is mandatory if you are not providing a token or full card details.
cv2 string
The Customer’s Card Security Code (CSC, CV2, CVV).
}
registered boolean
Indicates if the supplied card payment method should be registered. If no value is supplied true is assumed. This field will not be accepted for non-card payment
methods.
card { Mandatory
Use if you want to provide your Customer’s card details. This section is mandatory if you are not providing a token (merchant or CardLock) or details of the Customer’s default card.
pan string
Mandatory
The card number.
cv2 string
The Card Security Code (CSC, CV2, CVV).
expiryDate string
Mandatory
The expiry date for the card. Provide as MMYY.
nickname string
The name the Customer provides for their card to allow easy selection where they register multiple cards.
defaultCard boolean
Indicates if the card being used should become the Customer’s default card.
cardHolderName string
The name printed on the card.
issueNumber number
The issue number for the card.
startDate string
The start date for the card. Provide as MMYY.
}
billingAddress { The 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.
line1 string
Line 1 of the Customer’s billing address.
line2 string
Line 2 of the Customer’s billing address.
line3 string
Line 3 of the Customer’s billing address.
line4 string
Line 4 of the Customer’s billing address.
city string
City of the Customer’s billing address.
region string
Region of the Customer’s billing address.
postcode string
Post Code of the Customer’s billing address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s billing address country.
}
}
verification { Mandatory
Indicates the transaction is an account verification add specifies details.
acquirerPaymentMethod boolean
Mandatory
Indicates if the verification type is acquirer payment method.
}
}
response:
{
clientRedirect { Information about where to send your customer in the case of 3DS or a Callback.
frame string
Possible Values: CONTAINER, TOP
The redirect type when the transaction is set to suspend and redirect to a new URL.
pareq string
Returned when the transaction is suspended for 3DS authorisation.
url string
The URL the Customer should be redirected to.
}
fraudGuard { Information about the Payment.
score float
The score assigned by FraudGuard. Refer to FraudGuard documentation for further details.
geoLocation {
ipCountry {
country string
The three-character ISO code representing the country of origin, determined by the IP address.
ipValues string
Possible Values: PROXY, SATELLITE, EUROPE, APAC
Categorisation of the IP address used.
}
ipCity string
The origin city of the transaction request, determined by the IP address.
ipRegion string
The origin state or province of the transaction request, determined by the IP address.
distanceFromIpToBilling int
The physical distance from the billing address to the location determined from the IP address.
}
channelRisk {
freeEmailProvider boolean
Whether or not the email address provided in the transaction request is hosted by a free provider.
openProxyRisk float
A rating of how likely it is that the transaction request originated from behind an open proxy.
}
recentActivity {
last24Hours {
attemptsViaIp int
How many transaction requests have originated from this IP address in the last 24 hours.
attemptsOnCard int
How many transaction requests have used this card in the last 24 hours.
}
}
identityMorphing {
againstAddress int
Measure of identity morphing against the address.
againstEmail int
Measure of identity morphing against the email address.
againstCard int
Measure of identity morphing against the card details.
againstIp int
Measure of identity morphing against the IP address.
}
}
transaction {
transactionId string
Our ID for the transaction.
deferred boolean
Indicates if the Payment capture is deferred.
merchantRef string
Your reference for the transaction.
merchantDescription string
The description of the transaction provided in the request.
status string
Possible Values: SUCCESS, FAILED, PENDING, EXPIRED, CANCELLED, VOIDED
The current state of the transaction.
type string
Possible Values: PAYMENT, PREAUTH, PAYOUT, REFUND, CAPTURE, CANCEL, REPEAT, CASH_ISSUE, CASH_PAYMENT
Indicates the type of the transaction.
amount float
Indicates the amount of the transaction.
currency string
Indicates the currency of the transaction. Use the 3 character ISO-4217 code.
transactionTime string
The date and time we processed the transaction in ISO-8601 format.
receivedTime string
The date and time we received the transaction in ISO-8601 format.
commerceType string
Possible Values: ECOM, MOTO, CA
The Commerce Type of the transaction.
channel string
Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER
The Sales Channel of the transaction.
relatedTransaction { This field is not applicable for Payments. In case of Refunds it indicates the transaction that was refunded.
transactionId string
Our ID for the transaction that was original.
merchantRef string
Your reference for the transaction that was original.
}
}
processing { Information about the authorisation status of your transaction.
route string
The name of the processing engine your transaction was submitted to.
voidSuccessful boolean
Indicates if the transaction was voided by a Post Authorisation callback.
authResponse {
statusCode string
The code for the status received from the authoriser, if applicable.
acquirerReference string
The reference received from the authoriser for your transaction, if applicable.
acquirerName string
Name of the authoriser, if applicable.
message string
The message received from the authoriser, if applicable.
authCode string
The code received from the authoriser, if applicable.
gatewayReference string
The reference received from the processing engine.
gatewaySettlement string
The date the processing engine will settle the transaction. in YYYY-MM-DD format.
gatewayCode string
The code for the status received from the processing engine.
gatewayMessage string
The message received from the processing engine.
avsAddressCheck string
Possible Values: NOT_CHECKED, FULL_MATCH, NOT_MATCHED, NOT_PROVIDED
Results for the Address Verification checks, if applicable, if applicable.
avsPostcodeCheck string
Possible Values: NOT_CHECKED, FULL_MATCH, NOT_MATCHED, NOT_PROVIDED
Results for the PostCode Verification checks, if applicable.
cv2Check string
Possible Values: NOT_CHECKED, MATCHED, NOT_MATCHED
Results for the CV2 Verification checks, if applicable.
gatewayStatus string
The status received from the processing engine.
status string
Possible Values: AUTHORISED, DECLINED, REVERSED, REVERSE_FAILED, ERROR
The status received from the authoriser, if applicable.
}
}
threeDSecure { Information about the 3D Secure status of your transaction.
version integer
Possible Values: 1 or 2
Major version of 3D Secure applied to this transaction.
protocolVersion string
Possible Values: “2.1.0” or “1.0.2”
Full protocol version of 3D Secure applied to this transaction.
versionsAttempted[ { Versions of 3D Secure that were attempted for this transaction, in order of use.
This can be used to determine when fall back to v1 has occurred, for example, 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 property 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, or that fall back to v1 could have been supported, but wasn’t.
version integer
Possible Values: 1,2
Major version of 3D Secure that was attempted.
availability string
Possible Values: INSUFFICIENT_DATA, ISSUER_NO_V2, ISSUER_NO_V1, ISSUER_NO_3DS, ERROR, AVAILABLE
High-level indication of the actual availability of the given 3D Secure version and what happened during the attempt to use it; when a fall back occurs, this will indicate why.
} ]
scheme string
The scheme that processed the transaction for 3DS.
eci string
The eCommerce indicator for the transaction.
status string
Possible Values: AUTHENTICATED, BYPASSED, FAILED, NOT_ENROLLED, ATTEMPTED, ENROLMENT_CHECK_FAILURE, INCOMPLETE, NOT_AVAILABLE, NOT_IMPLEMENTED
The overall 3DS result for the transaction.
xid string
The ID used during 3DSv1 processing.
threeDSServerTransId string
Pay360 3DSv2 transaction ID.
dsTransactionId string
Directory Server 3DSv2 transaction ID.
acsTransactionId string
Access Control Server (ACS) 3DSv2 transaction ID.
challengeRequest string
Possible Values: NO_PREFERENCE, NO_CHALLENGE_REQUESTED, CHALLENGE_REQUESTED, CHALLENGE_MANDATED
Indicates whether a challenge was ultimately requested or not; this reflects the final 3DSv2 request made by Pay360 after taking into account any merchant preference and card scheme rules.
frictionless boolean
Whether the cardholder was authenticated without a challenge (frictionless flow).
authenticationStatus string
Possible Values: AUTHENTICATED, ATTEMPTED, FAILED, ERROR
The status of 3DSv1 authentication check.
authenticationIndicator string
Possible Values: Y, A, N, U
The indicator of the 3DSv1 authentication status.
enrolmentIndicator string
Possible Values: Y, N, U
The indicator of the 3DSv1 enrolment status.
enrolmentDateTime string
The date and time the 3DSv1 enrolment check was performed in ISO-8601 format.
enrolmentStatus string
Possible Values: ENROLLED, NOT_ENROLLED, UNABLE_TO_AUTHENTICATE
The status of the 3DSv1 enrolment check.
}
customer { Information about the Customer.
id string
Our ID for the Customer.
merchantRef string
Your reference for the Customer.
}
financialServices { Information about the financial services.
dateOfBirth string
The Customer’s date of birth.
surname string
The Customer’s surname.
accountNumber string
The loan account number provided by the merchant, to the Customer.
postCode string
The postal code of the Customer’s billing address.
}
outcome { Information about the overal outcome of the request.
reasonMessage string
A message indicating the overall outcome of the request. This is where we’ll provide detailed reasons for any errors.
status string
Possible Values: SUCCESS, FAILED
The overall outcome of the request.
reasonCode string
A code indicating the overall outcome of the request. Refer to Errors for more information.
}
paymentMethod { Information about the Payment Method used in the request.
paymentClass string
The classification of payment method used. Eg. Card, Cash, PayPal
registered boolean
Indicates that the customer choose to register this card payment method. This field will not be present for non-card payment methods.
isPrimary boolean
Indicates if this was Customer’s primary registered payment method.
card { Use if you want to provide your Customer’s card details. This section is mandatory if you are not providing a token (merchant or CardLock) or details of the Customer’s default card.
issueNumber string
The issue number of the card used in the request.
cardToken string
The token for the card.
cardHolderName string
The Cardholder’s name.
issuer string
The Issuer of the card.
maskedPan string
The masked card number. eg. 123456******1234
issuerCountry string
The country of the card Issuer.
expiryDate string
The expiry date of the card. Formatted as MMYY.
validDate string
The valid from date of the card. Formatted as MMYY.
cardType string
The type of card. Eg. MC_DEBIT, VISA_CREDIT, AMEX.
cardUsageType string
The usage type of card. Eg. DEBIT, CREDIT.
cardScheme string
The scheme of card. Eg. VISA, MASTERCARD, AMEX.
cardCategory string
The category of card. Eg. CREDIT, DEBIT, CORPORATE, BUSINESS.
cardNickname string
The name the Customer provided for their Card to allow easy selection where they registered multiple cards.
}
billingAddress { The 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.
line1 string
Line 1 of the Customer’s billing address.
line2 string
Line 2 of the Customer’s billing address.
line3 string
Line 3 of the Customer’s billing address.
line4 string
Line 4 of the Customer’s billing address.
city string
City of the Customer’s billing address.
region string
Region of the Customer’s billing address.
postcode string
Post Code of the Customer’s billing address.
country string
Country name of the Customer’s billing address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s billing address country.
}
}
}
Hosted examples
Submit an account verification

POST /hosted/rest/sessions/{instId}/verify
{
  "session": {
    "preAuthCallback": {
      "url": "http://www.example.com/callback/preAuth?status=SUSPEND",
      "format": "REST_XML"
    },
    "returnUrl" : {
      "url" : "http://www.example.com/transactionResult?MERCHANTREF=mer_txn_1234556"
    }
  },
"transaction" : {
    "merchantReference" : "mer_txn_1234556",
    "money" : {
      "currency" : "GBP"
    },
    "description" : "HFTransactionDescriptionFor-mer_txn_1234556"
  },
  "customer" : {
    "identity" : {
      "merchantCustomerId" : "1111111111111"
    },
    "details" : {
      "name" : "given1 Family1",
      "address" : {
        "line1" : "matched",
        "line2" : "initialCustomer1AddresssLine2",
        "city" : "initalCustomer1City",
        "region" : "initalCustomer1Region",
        "postcode" : "AVS111",
        "countryCode" : "GBR"
      },
      "telephone" : "0044111111111",
      "emailAddress" : "initialCustomer1@example.com",
      "ipAddress" : "1.1.1.1",
      "defaultCurrency" : "GBP"
    }
  },
  "customFields" : { },
  "verification" : {
    "acquirerPaymentMethod" : true
  }
}

HTTP/1.1 200
{
  "sessionId": "5280f295-b7ea-4eaa-8e3b-ebd6fa67cc58",
  "redirectUrl": "http://www.pay.net/hosted/8f2c9ec4-f9e6-44a7-b14a-39a47d3aeb65/begin/5280f295-b7ea-4eaa-8e3b-ebd6fa67cc58",
  "status": "SUCCESS"
}
Hosted endpoint
endpoint: /hosted/rest/sessions/{instId}/verify
method: POST
summary: process Account Verification

parameters:

Name
Data Type
Description
instId
string
The installation id
request body:
{
transaction { Mandatory
Details of the transaction you want to create.
merchantReference string
Your reference for the transaction.
description string
The description of the transaction.
commerceType string
Possible Values: ECOM, MOTO, CNP
The commerce type for your Customer’s transaction.
channel string
Possible Values: WEB, MOBILE, SMS, RETAIL, MOTO, IVR, OTHER
The sales channel for your Customer’s transaction. If no channel is provided we’ll automatically classify the channel as WEB
deferred boolean
Indicates if you want the Payment to be Authorised and Captured separately.
recurring boolean
Set this field if you want to start a recurring Continuous Authority relationship from this transaction.
instalment boolean
Set this field if you want to start an instalment Continuous Authority relationship from this transaction.
continuousAuthorityAgreement { Conditional
The 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
Mandatory
Minimum number of days (>=1) between payments in a recurring or instalment sequence.
expiry string
Mandatory
Date at which recurring/instalment agreement expires (or will need to be re-authenticated in order to continue). In the YYYY-MM-DD format. Must be in future.
numberOfInstalments integer
Conditional
Total number of payments (>=2) in an instalment sequence (including this one, if starting with a payment). An instalment sequence must consist of two or more payments. Mandatory for initiating an instalment series.
}
do3DSecure boolean
Indicates if the transaction should be processed with 3DS. This will override account configuration for 3DS.
}
customer {
create boolean
Deprecated. Use ‘registered’ instead, as this will be removed in the future.
registered boolean
Indicates if you wish to create or use a registered customer. False if you do not wish to register your customer, otherwise set to true. Default value is true.
identity { Conditional
Mandatory when registering a new customer, or using an already registered customer, optional otherwise.
platformCustomerId string
Choice
Our ID for your customer.
merchantCustomerId string
Choice
Your ID for the customer.
}
details { Conditional
Mandatory when registering a new customer, optional otherwise.
name string
Conditional
The Customer’s name
Mandatory when registering a new customer, optional otherwise.
address { Conditional
Mandatory when registering a new customer, optional otherwise. This is used to pre-populate the customers billing address fields.
line1 string
Line 1 of the Customer’s address.
line2 string
Line 2 of the Customer’s address.
line3 string
Line 3 of the Customer’s address.
line4 string
Line 4 of the Customer’s address.
city string
City of the Customer’s address.
region string
Region of the Customer’s address.
postcode string
Post Code of the Customer’s address.
countryCode string
The 3 character ISO-3166-1 code for the Customer’s address country.
}
telephone string
Telephone number for the Customer.
emailAddress string
Email address for the Customer.
ipAddress string
The Customer’s IP address.
}
}
financialServices { Mandatory for Fin-Services
dateOfBirth string
Mandatory for Fin-Services
The Customer’s date of birth.
surname string
Mandatory for Fin-Services
The Customer’s surname.
accountNumber string
Mandatory for Fin-Services
The loan account number provided by the merchant, to the Customer.
postCode string
Mandatory for Fin-Services
The postal code of the Customer’s billing address.
}
locale string
The ISO-639 code for your Customer’s locale.
session { Mandatory
preAuthCallback { Details of the callback made before the transaction is sent for authorisation.
url string
Mandatory
The URL you want the callback or notification to be sent to. This will override any defaults set on your account. Where a default is set and a blank URL field is specified, no callback or notification will be sent.
format string
Possible Values: REST_XML, REST_JSON
The format of the callback content.
}
postAuthCallback { Details of the callback made after the transaction is sent for authorisation.
url string
Mandatory
The URL you want the callback or notification to be sent to. This will override any defaults set on your account. Where a default is set and a blank URL field is specified, no callback or notification will be sent.
format string
Possible Values: REST_XML, REST_JSON
The format of the callback content.
}
transactionNotification { Details of the notification sent after transaction completion.
url string
Mandatory
The URL you want the callback or notification to be sent to. This will override any defaults set on your account. Where a default is set and a blank URL field is specified, no callback or notification will be sent.
format string
Possible Values: REST_XML, REST_JSON
The format of the callback content.
}
returnUrl { Mandatory
The URL that we will return your customer to after processing the transaction.
url string
Mandatory
}
cancelUrl { The URL that we will return your customer to if they cancel the hosted session. If omitted the returnUrl is used if they cancel.
url string
Mandatory
}
restoreUrl { The URL of Pay360 hosted session. We’ll take your customer to this URL in the event they cancel their PayPal payment with the “Cancel and return to….” link. You will need to use this field if you iFrame our hosted product.
url string
Mandatory
}
skin The ID of the skin used to drive look and feel for this session. Refer to Customise hosted look and feel for more information.
}
features { Holder of features that can be enabled/disabled during a hosted session.
paymentMethodRegistration string
Possible Values: always, optional
Allow the customer to choose if they wish their payment method to be registered.
}
verification{ Mandatory
Details about the verification
acquirerPaymentMethod boolean
Mandatory
Indicates if the verification type is acquirer payment method.
}
}
response:
{
sessionId string
Our ID for the hosted session.
redirectUrl string
The URL you should direct your customer to to start the hosted session.
status string
Possible Values: SUCCESS, FAILED
Indicates the status of the session creation.
reasonCode string
Further information about the status of the session creation.
reasonMessage string
Further information about the status of the session creation. This is where we will provide detailed information about any errors.
}

Related topics