Skip to main content

Update Account

PATCH 
/accounts/:customerAccountId

This endpoint updates an existing account, previously created through a checkout API call, using the provided customerAccountId input parameter.

Request​

Path Parameters

    customerAccountId stringrequired

    Possible values: <= 255 characters

    Customer identifier

Header Parameters

    Content-Type stringrequired

    Must be application/json

    Accept-Language stringrequired

    Must be be en-US

    Origin stringrequired

    The origin of the request

    User-Agent stringrequired

    The client making the request

Body

required

    billingAddress

    object

    required

    Consumer's billing address data. See Address in Data model.

    addressLine1 stringrequired

    Possible values: <= 60 characters

    Street name.

    addressLine2 string

    Possible values: <= 60 characters

    Apartment, suite, unit, building, floor or other secondary address information.

    addressLine3 string

    Possible values: <= 60 characters

    Specific delivery instructions, department names, or additional floor information.

    city stringrequired

    Possible values: <= 50 characters

    The city or localitly of the address.

    countryCode stringrequired

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

    ISO-3 code of the address country (e.g., DEU for Germany).

    number string

    Possible values: <= 10 characters

    The house or building number corresponding to the street address.

    postCode stringrequired

    Possible values: <= 10 characters

    The postal or ZIP code of the address.

    state string

    Possible values: <= 3 characters

    3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.

    consumer

    object

    required

    Consumer's personal data, in case the consumer is a physical person. See consumer in Data model.
    Conditional. Can be present if businessConsumer is missing from the request.

    culture string

    Possible values: <= 5 characters

    Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g., en-de). This field is not case sensitive.

    dateOfBirth date

    Possible values: <= 10 characters, Value must match regular expression ^\d{4}-\d{2}-\d{2}$

    Date of birth. Format - YYYY-MM-DD. Mandatory for payment option registration flow. Minimum date allowed is 1900-01-01

    emailAddress emailrequired

    Possible values: <= 255 characters

    Customer email address for any notification

    firstName stringrequired

    Possible values: <= 60 characters

    Person first name

    gender string

    Possible values: <= 6 characters

    Person gender

    homePhone string

    Possible values: <= 30 characters

    Person's home phone number (including the country code)

    lastName stringrequired

    Possible values: <= 60 characters

    Person last name

    merchantCustomerId string

    Possible values: <= 255 characters

    Consumer/Customer Account Id in the merchant system. When provided into the Create Checkout API, SmartPay will request e-wallet account creation which will have external account reference equals to the given merchantCustomerId value.

    middleName string

    Possible values: <= 60 characters

    The customer's middle name

    mobilePhone string

    Possible values: <= 30 characters

    Person's mobile phone number (including the country code)

    taxId string

    Possible values: <= 30 characters

    Person's tax identification number

    timezone string

    Possible values: <= 50 characters

    Preferred timezone name

    title string

    Possible values: <= 3 characters

    Person title

    workPhone string

    Possible values: <= 30 characters

    Person's work phone number (including the country code)

    businessConsumer

    object

    required

    Company data, in case the consumer is a business or a legal entity. See businessConsumer in Data model.
    Conditional. Can be present if consumer is missing from the request.

    companyName stringrequired

    Possible values: <= 100 characters

    Name of the legal entity

    companyRegistrationCountryCode string

    Possible values: >= 2 characters and <= 3 characters

    Company registration country ISO2 or ISO3 code

    companyRegistrationNumber string

    Possible values: <= 50 characters

    Company registration number

    companyType stringrequired

    Possible values: <= 100 characters

    culture string

    Possible values: <= 5 characters

    Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g., en-de). This field is not case sensitive.

    emailAddress stringrequired

    Possible values: <= 255 characters

    Customer email address for any notification

    taxId string

    Possible values: <= 30 characters

    Person's tax identification number

Responses​

Successful response

Schema

    partnerReference string

    Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z0-9_-]+$

    Partner service call identifier.

    statusCode string

    Possible values: [ACTIVE, CLOSED, INACTIVE, REJECTED]

    Status code of the account. Possible values are: ACTIVE, CLOSED, INACTIVE or REJECTED.

    accFlowStatusCode string

    Possible values: <= 10 characters

    Status code of the account flow.

    twoFAStatusCode string

    Possible values: [2FADIS, 2FANOTCONF, 2FAINPROC, 2FACONF]

    Two Factor Authentication Status Code. Possible values are:

    • 2FADIS - Two Factor Authentication is disabled.
    • 2FANOTCONF- Two Factor Authentication is activated but not configured.
    • 2FAINPROC - Two Factor Authentication is activated and configuration is in process.
    • 2FACONF - Two Factor Authentication is activated and configured.
    isTwoFASetupCodeRequired boolean

    Whether a confirmation of Two-Factor Authentication setup with a verification code is required or not (this code is sent to the user email).

    providerResponse

    object

    External provider data.

    complianceData

    object[]

    Compliance data.

  • Array [

    • archiveId string

    Possible values: <= 50 characters

    Archived check result identifier.

    trafficLight string

    Possible values: [RED, YELLOW, GREEN]

    The following options are possible:
    RED" - hit,<br/> YELLOW- unsure hit,<br/>GREEN` - no hit.

    hitType string

    Possible values: [SL, BL, PEP]

    The following options are possible:
    SL – sanctions list,
    BL – black list,
    PEP – publicly exposed person.
    Due to regulatory requirements, a person or company must not be part of this list.

    manualReview boolean

    Whether a manual review is required or not.

    details

    object[]

    List of compliance check details.

  • Array [

    • name string
    birthdate date

  • ]

  • ]

    • requestDateTime date-time

    Timestamp of the request in the format defined by ISO 8601.

    responseCode string

    Possible values: <= 4 characters

    The response code.

    responseDescription string

    Possible values: <= 512 characters

    The response description.

Loading...
 Imprint
|
Data protection and privacy
© 2025 J.P. Morgan Mobility Payments Systems GmbH. All rights reserved.