This site requires javascript to be enabled.

  • Search AI-powered

Results for

xxx

Get Device Fingerprint details

GET https://{domainname}/v1/{merchantId}/payments/{paymentId}/devicefingerprint

Payments

The payments REST services allow you to initiate a payment, retrieve the payment details or perform specific actions like refunding or requesting capture of a payment. A payment is identified by its paymentId. Some payment products allow a two step approach allowing you to control when the authorization takes place separate from when the funds are actually captured.

Request

Retrieves the detailed information that was collected the using the Device Fingerprint collector based on the ID of the payment. The details are returned as a string in the rawDeviceFingerprintOutput property. The structure will be different depending on the collection method and device fingerprint partner used. Please contact us if you want more information on the details that are returned in this string.

Request example

SDK: PHP

This scenario you will probably use the most

  • $response = $client->v1()->merchant('merchantId')->payments()->devicefingerprint('paymentId');
    

Responses

The detailed information that was collected using the Device Fingerprint collector based on the ID of the payment.

Response 200 - OKDeviceFingerprintDetails

The response contains the Device Fingerprint data which has been collected

Properties
Property Type Required Details
close

Description

The ID of the payment that is linked to the Device Fingerprint data.
close

Description

The detailed data that was collected during the Device Fingerprint collection. The structure will be different depending on the collection method and device fingerprint partner used. Please contact us if you want more information on the details that are returned in this string.

Response example

SDK: PHP

This scenario you will probably use the most

  • {
        "paymentId" : "000000170100000100030000100001",
        "rawDeviceFingerprintOutput" : "{...}"
    }
    

Response 404 - Not foundErrorResponse

In case the Device Fingerprint data is not available, a HTTP 404 response is returned

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: PHP

This scenario you will probably use the most

  • {
        "errorId" : "6c3711a9b48a7483433aa2b5a289c95d",
        "errors" : [
            {
                "code" : "320404100",
                "id" : "DEVICE_FINGERPRINT_UNAVAILABLE",
                "category" : "CONNECT_PLATFORM_ERROR",
                "propertyName" : "paymentId",
                "message" : "Device Fingerprint data unavailable",
                "httpStatusCode" : 404
            }
        ]
    }