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

Customer id assigned by the payment platform.

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

Example: CP-91ec-509a-3899-4f4f-a4ad-67fb

UpdateProfileRequestCustomerIdentification

customerIdentification stringrequired

Customer id assigned by you.

Possible values: non-empty and <= 36 characters

Example: my-id-620fa70b-cc34-4bbb-8d66-3670d3ea24f2

customerData

object

required

firstName stringrequired

First name of customer.

Possible values: <= 50 characters

Example: Alex

lastName string

Last name of customer.

Possible values: <= 50 characters

Example: Smith

birthDate string

Birthdate of customer.

RFC 3339 Internet Date/Time Format full-date.

Example: 1970-01-01

gender string

Gender of the customer.

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

Example: M

billingAddress1 string

Line one of the customer's billing address.

Possible values: <= 50 characters

billingAddress2 string

Line two of the customer's billing address.

Possible values: <= 50 characters

billingCity string

City of the customer's billing address.

Possible values: <= 50 characters

billingPostcode string

Postal code of the customer's billing address.

Possible values: <= 16 characters

billingState string

State of the customer's billing address.

Possible values: <= 30 characters

billingCountry string

Country of the customer's billing address.

ISO 3166-1 alpha-2 country code.

Possible values: <= 2 characters

billingPhone string

Phone number of the billed customer.

Possible values: <= 20 characters

Example: +XX 1234567890

company string

Company of the customer.

Possible values: <= 50 characters

email string

E-mail address of the customer.

Possible values: <= 255 characters

ipAddress string

IPv4 or IPv6 address of the customer.

Possible values: <= 50 characters

Example: 198.51.100.123

nationalId string

National id of the customer.

Possible values: <= 14 characters

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.

Example: +XX 1234567890

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.

Example: Alex

gender string

Gender of the customer.

ipAddress string

IPv4 or IPv6 address of the customer.

Example: 198.51.100.123

lastName string

Last name of customer.

Example: Smith

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...