This site requires javascript to be enabled.

  • Search AI-powered
    Search results are AI-generated and are not guaranteed to be accurate, complete, or up-to-date. They are not a substitute for legal or professional advice. Refer to our terms of use for more details.
    Search AI-powered

Results for

xxx

Get device fingerprint

POST https://{domainname}/v1/{merchantId}/productgroups/{paymentProductGroupId}/deviceFingerprint

Product Groups

Through this API you can retrieve payment product groups. A payment product group has a collection of payment products that can be grouped together on a payment product selection page, and a set of fields to render on the payment product details page that allow to determine which payment product of the group the consumer wants to select. We currently support one payment product group named cards that has every credit card we support (and every debit card that behaves like a credit card). Its cardNumber field allows to determine the right payment product through a Get IIN details call.

Request

In case you use your own payment pages and you want to use device fingerprinting to assess the risk based on the device that the consumer is using you will need to include a piece of JavaScript in your page. Using this API you retrieve a transaction specific JavaScript snippet that you need to include in your payment page. The snippet returned in html already contains the deviceFingerprintTransactionId that is specific to one single transaction.

Depending on the provider used for the device fingerprinting it might be possible to execute another JavaScript function in the collectorCallback property that will be executed after the request.

PayloadDeviceFingerprintRequest

Properties
Property Type Required Details
close

Description

You can supply a JavaScript function call that will be called after the device fingerprint data collecting using the provided JavaScript snippet is finished. This will then be added to the snippet that is returned in the property html.

Request example

SDK: Node.js

This scenario you will probably use the most

  • var body = { };
const sdkResponse = await client.v1.productgroups.deviceFingerprint("merchantId", "cards", body);
// sdkResponse has the following properties:
// - status: the HTTP status code
// - body: the response body
// - isSuccess: true if the call was successful,
//              or false if the Worldline Global Collect platform returned an error response

Responses

Please find below an overview of the possible responses.

Response 200 - OKDeviceFingerprintResponse

Returns html containing a transaction specific code snippet for injecting into your own payment page. This snippet already contains the deviceFingerprintTransactionId which must be submitted again when you submit the payment request through CreatePayment.fraudFields.deviceFingerprintTransactionId. It is also possible to submit the deviceFingerprintTransactionId in the Risk Assessment calls.

Properties
Property Type Required Details
close

Description

Contains the unique id which is used by the device fingerprint collector script. This must be used to set the property fraudFields.deviceFingerprintTransactionId in either in the CreatePayment.order.customer.device.deviceFingerprintTransactionId, the CreateRiskAssessmentCards.order.customer.device.deviceFingerprintTransactionId or the CreateRiskAssessmentBankaccounts.order.customer.device.deviceFingerprintTransactionId.
close

Description

Contains the ready-to-use device fingerprint collector script. You have to inject it into your page and call it when the customer presses the final payment submit button. You should only call it once per payment request.

Response example

SDK: Node.js

This scenario you will probably use the most

  • {
    "html" : "<DEVICE FINGERPRINT HTML SCRIPT TAG>",
    "deviceFingerprintTransactionId" : "2f6a0ceb-4ab4-44e0-b76b-cf4b8f2afcdd"
}

Response 400 - Bad requestErrorResponse

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Node.js

This scenario you will probably use the most

  • {
    "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
    "errors" : [
        {
            "code" : "20000000",
            "propertyName" : "bankAccountBban.accountNumber",
            "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
        }
    ]
}

Response 404 - Not foundErrorResponse

The paymentProductGroupId you submitted does not exist or does not have device fingerprint enabled.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Node.js

This scenario you will probably use the most

  • {
    "errorId" : "3caa7750-a076-48b2-9402-3cb9eea613a6-00001532",
    "errors" : [
        {
            "code" : "1424",
            "message" : "DEVICE_FINGERPRINT_NOT_ENABLED"
        }
    ]
}