Update profile

POST 
/:apiKey/updateProfile

Update a customer profile.

The response contains the updated customer data and information about the changed fields.

In case of any errors due to invalid requests, invalid configuration or any other unexpected reason, the system will answer with a generic error response.

Request

Path Parameters

apiKey stringrequired

API Key of Connector

application/json

Body

required

Update a customer profile

oneOf

UpdateProfileRequestGuid

profileGuid stringrequired

Possible values: >= 32 characters and <= 32 characters

Customer id assigned by the payment platform.

UpdateProfileRequestCustomerIdentification

customerIdentification stringrequired

Possible values: non-empty and <= 36 characters

Customer id assigned by you.

customerData

object

required

firstName stringrequired

Possible values: <= 50 characters

First name of customer.

lastName string

Possible values: <= 50 characters

Last name of customer.

birthDate string

Birthdate of customer.

RFC 3339 Internet Date/Time Format full-date.

gender string

Possible values: <= 1 characters, Value must match regular expression ^[MF]$

Gender of the customer.

billingAddress1 string

Possible values: <= 50 characters

Line one of the customer's billing address.

billingAddress2 string

Possible values: <= 50 characters

Line two of the customer's billing address.

billingCity string

Possible values: <= 50 characters

City of the customer's billing address.

billingPostcode string

Possible values: <= 16 characters

Postal code of the customer's billing address.

billingState string

Possible values: <= 30 characters

State of the customer's billing address.

billingCountry string

Possible values: <= 2 characters

Country of the customer's billing address.

ISO 3166-1 alpha-2 country code.

billingPhone string

Possible values: <= 20 characters

Phone number of the billed customer.

company string

Possible values: <= 50 characters

Company of the customer.

email string

Possible values: <= 255 characters

E-mail address of the customer.

ipAddress string

Possible values: <= 50 characters

IPv4 or IPv6 address of the customer.

nationalId string

Possible values: <= 14 characters

National id of the customer.

extraData

object

Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

property name* string
preferredInstrument string

Possible values: >= 24 characters and <= 24 characters

Responses

200

Update a customer profile

application/json

Schema

Schema

success boolean
profileGuid string

customer

object

_TYPE string

billingAddress1 string

Line one of the customer's billing address.

billingAddress2 string

Line two of the customer's billing address.

billingCity string

City of the customer's billing address.

billingCountry string

Country of the customer's billing address.

ISO 3166-1 alpha-2 country code.

billingPhone string

Phone number of the billed customer.

billingPostcode string

Postal code of the customer's billing address.

billingState string

State of the customer's billing address.

birthDate string

Birthdate of customer.

RFC 3339 Internet Date/Time Format full-date.

company string

Company of the customer.

email string

E-mail address of the customer.

extraData

object

Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

property name* string

firstName string

First name of customer.

gender string

Gender of the customer.

ipAddress string

IPv4 or IPv6 address of the customer.

lastName string

Last name of customer.

nationalId string

National id of the customer.

property name* any
changedFields string[]
property name* any

Example (from schema)

{
  "success": true,
  "profileGuid": "string",
  "customer": {
    "_TYPE": "string",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingCity": "string",
    "billingCountry": "string",
    "billingPhone": "+XX 1234567890",
    "billingPostcode": "string",
    "billingState": "string",
    "birthDate": "string",
    "company": "string",
    "email": "string",
    "extraData": {},
    "firstName": "Alex",
    "gender": "string",
    "ipAddress": "198.51.100.123",
    "lastName": "Smith",
    "nationalId": "string"
  },
  "changedFields": [
    "string"
  ]
}

Example

{
  "success": true,
  "profileGuid": "CP-0000-0000-0000-0000-0000-0000",
  "customerIdentification": "YOUR_CUSTOMER_ID",
  "customer": {
    "_TYPE": "customerData",
    "billingAddress1": "123 Main St.",
    "billingAddress2": "Apt. 4B",
    "billingCity": "Anytown",
    "billingCountry": "US",
    "billingPhone": "+XX 1234567890",
    "billingPostcode": "12345",
    "billingState": "AN",
    "birthDate": "1970-01-01",
    "company": "Alex's Artisan Goods",
    "email": "[email protected]",
    "extraData": [],
    "firstName": "Alex",
    "gender": "M",
    "ipAddress": "198.51.100.123",
    "lastName": "Smith",
    "nationalId": "1234"
  },
  "changedFields": [
    "firstName",
    "lastName"
  ]
}

default

Error response

application/json

Schema

Schema

success boolean

false if error.

errorMessage string

Error message.

While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

errorCode integer

Error code.

property name* any

Example (from schema)

{
  "success": true,
  "errorMessage": "string",
  "errorCode": 0
}

Loading...