Get customer details

POST https://{domainname}/v1/{merchantId}/products/{paymentProductId}/customerDetails

Products

Products is your entry on all things related to payment products. You will be able to retrieve all relevant payment products, based on your configuration and provided filters, their associated fields and potential directories. You can retrieve all of the information in one call or do calls on individual payment products. The data returned is designed to give you all the required information to build up your interface towards your consumers in a dynamic fashion. By doing it like that you know that you will be ready for future changes and new payment products without much effort.

Request

Which fields are required depend on the country code. This can determined by performing a getPaymentProduct call and supplying the country code. Each payment product field with the property usedForLookup set to true should be submitted in the request with a valid value.

PayloadGetCustomerDetailsRequest

Input for the retrieval of a customer's details.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
countryCode	string	yes	read close
close Description The code of the country where the customer should reside.
values	array of object	yes	read close
close Description A list of keys with a value used to retrieve the details of a customer. Depending on the country code, different keys are required. These can be determined with a getPaymentProduct call and using payment product properties with the property usedForLookup set to true.
items	object	no	read close
close SDK Object type KeyValuePair
key	string	no	read close
close Description Name of the key or property
value	string	no	read close
close Description Value of the key or property

Request example

SDK: Ruby

This scenario you will probably use the most

values = []

value1 = Domain::KeyValuePair.new
value1.key = 'fiscalNumber'
value1.value = '01234567890'

values << value1

body = Domain::GetCustomerDetailsRequest.new
body.country_code = 'SE'
body.values = values

response = client.v1.merchant('merchantId').products.customer_details(9000, body)

Responses

Please find below an overview of the possible responses.

Response 200 - OKGetCustomerDetailsResponse

Personal information and address data related to the data in the request is returned.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
city	string	no	read close
close Description The city in which the customer resides.
country	string	no	read close
close Description The country in which the customer resides.
emailAddress	string	no	read close
close Description The email address registered to the customer.
firstName	string	no	read close
close Description The first name of the customer
fiscalNumber	string	no	read close
close Description The fiscal number (SSN) for the customer.
languageCode	string	no	read close
close Description The code of the language used by the customer.
phoneNumber	string	no	read close
close Description The phone number registered to the customer.
street	string	no	read close
close Description The street on which the customer resides.
surname	string	no	read close
close Description The surname or family name of the customer.
zip	string	no	read close
close Description The ZIP or postal code for the area in which the customer resides.

Response example

SDK: Ruby

This scenario you will probably use the most

{
    "fiscalNumber" : "01234567890",
    "city" : "Stockholm",
    "street" : "Gustav Adolfs torg 22",
    "zip" : "111 52",
    "firstName" : "Gustav",
    "surname" : "Adolfs",
    "emailAddress" : "gustav.adolfs@stockholm.se",
    "phoneNumber" : "0123456789",
    "languageCode" : ""
}

Response 400 - Bad requestErrorResponse

The request is missing required values or no information could be found with the input data.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
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.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
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
propertyName	string	no	read close
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'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes

Response example

SDK: Ruby

This scenario you will probably use the most

{
    "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-00000312",
    "errors" : [
        {
            "code" : "1214",
            "id" : "CUSTOMER_DETAILS_NOT_FOUND",
            "message" : "No customer details could be found with the provided data."
        }
    ]
}

Response 404 - Not foundErrorResponse

The paymentProductId you submitted does not exist.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
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.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
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
propertyName	string	no	read close
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'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes

Response example

SDK: Ruby

This scenario you will probably use the most

{
    "errorId" : "657b10da-d2f9-4088-a948-bf190ef516b1-00000312",
    "errors" : [
        {
            "code" : "1070",
            "message" : "UNKNOWN_PAYMENT_PRODUCT_ID"
        }
    ]
}

Get customer details

Products

Request

PayloadGetCustomerDetailsRequest

Description

Description

Description

Description

Request example

Responses

Response 200 - OKGetCustomerDetailsResponse

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Response example

Response 400 - Bad requestErrorResponse

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Response example

Response 404 - Not foundErrorResponse

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Response example