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 privacy policy

GET https://{domainname}/client/v1/{customerId}/services/privacypolicy

Services

Request

This call lets you request the privacy policy for a specific or all payment products in your account.

Query parameters

Query parameters for this method

Property Type Required Repeat Details
locale string no no read close
close

Description

Locale in which the privacy policy should be returned. Uses your default locale when none is provided.
paymentProductId integer no no read close
close

Description

ID of the payment product for which you wish to retrieve the privacy policy. When no ID is provided you will receive all privacy policies for your payment products.

Request example

SDK: Android

This scenario you will probably use the most

  • N/A

Responses

The response contains the HTML for the privacy policy.

Response 200 - OKGetPrivacyPolicyResponse

Your request was exectued successfully and the response contains any applicable privacy policy texts

Properties
Property Type Required Details
close

Description

HTML content to be displayed to the user

Response example

SDK: Android

This scenario you will probably use the most

  • {
    "htmlContent" : "<h1>Privacy Notice</h1>\n..."
}

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
  • 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: Android

This schenario you will probably use the most

  • {
    "errorId" : "5c6d4ec2ca444060d13f3ff2d0647fb1",
    "errors" : [
        {
            "code" : "1024",
            "id" : "SERVICE_NOT_ALLOWED",
            "category" : "CONNECT_PLATFORM_ERROR",
            "message" : "The requested service is not available.",
            "httpStatusCode" : 400
        }
    ]
}