En esta sección se encuentran los campos mandatorios y el formato a validar en el Customer Aggregation Service, en cada request por cada endpoint.
Template para mensajes de validación:
Campo requerido:
{fieldName} is required
Campo válido
{fieldName} must be valid
Solo valores numéricos
{fieldName} must contain only numbers
Ejemplo de respuesta con error en validación
REST
gRPC
POST /v1/customers
Request Schema
Campo | Descripción | Información adicional |
|---|---|---|
logo | Imagen de spin | Type: String |
address | Dirección del cliente | Type: String Longitudes sugeridas por fiserv: Example: 1574 Lynn Ogden Lane |
houseNumber | Número de casa | Type: String Longitudes sugeridas por fiserv: Example: 204 |
externalNumber | Número exterior | Type: String |
colony | Colonia de residencia | Type: String |
city | Ciudad de residencia | Type: String Longitudes sugeridas por fiserv: Example: Houston |
state | Estado de residencia | Type: String Longitudes sugeridas por fiserv:
Example: TX |
postalCode | Código postal | Type: String Longitudes sugeridas por fiserv: Example: H0M 1A2 |
dateOfBirth | Fecha de nacimiento | Type: String |
stateOfBirth | Estado de nacimiento | Type: String |
Correo electrónico | Type: String Longitudes sugeridas por fiserv:
Example: Required | |
genderCode | Código de género | Type: Integer Longitudes sugeridas por fiserv:
Example: 1 |
firstName | Nombre de pila | Type: String Longitudes sugeridas por fiserv:
Example: Juan |
lastName | Apellido Paterno | Type: String
|
maternalLastName | Apellido materno | Type: String Longitudes sugeridas por fiserv: Example: Gonzalez |
mobilePhoneNumber | Teléfono móvil | Type: String Required |
identificationNumberFlag | Indicador de num. de identidad | Type: Integer
Example: 2 |
identificationNumber | Número de identificación | Type: String Longitudes sugeridas por fiserv:
Example: 123456 |
ine | INE (Instituto Nacional Electoral) | Type: String |
occupation | Ocupación | Type: String |
user4 | Información adicional (User4) | Type: String Longitudes sugeridas por fiserv: Example: U |
PUT /v1/customers
Request Schema
Campo | Descripción | Información adicional |
|---|---|---|
Correo electrónico | Type: String
Example: | |
numberType | Tipo de número | Type: Integer Default value: 1 |
customerNumber | Número de cliente | Type: string, Pattern: "^[0-9]+$" |
address | Dirección del cliente | Type: String
Example: 1574 Lynn Ogden Lane |
dateOfBirth | Fecha de nacimiento | Type: String |
city | Ciudad de residencia | Type: String
Example: Houston |
countryCode | Código de país del cliente | Type: string
|
county | Condado de residencia | Type: String Longitudes sugeridas por fiserv: Example: USA |
colony | Colonia de residencia | Type: String |
externalNumber | Número exterior | Type: String |
firstName | Nombre de pila | Type: String Example: Juan |
genderCode | Código de género | Type: Integer Longitudes sugeridas por fiserv: Example: 1 |
houseNumber | Número de casa | Type: String Longitudes sugeridas por fiserv: Example: 204 |
ine | INE (Instituto Nacional Electoral) | Type: String |
lastName | Apellido | Type: String Longitudes sugeridas por fiserv: Example: 204 |
maritalStatus | Estado civil | Type: String Longitudes sugeridas por fiserv: Example: 1 |
maternalLastName | Apellido materno | Type: String Longitudes sugeridas por fiserv: Example: 204 |
middleName | Segundo nombre | Type: String Longitudes sugeridas por fiserv: Example: Juan |
mobilePhoneIndicator | Indicador de teléfono móvil | Type: Integer |
mobilePhoneNumber | Número de teléfono móvil | Type: String Longitudes sugeridas por fiserv: Example: 323-456-7890 |
occupation | Ocupación | Type: String Longitudes sugeridas por fiserv: Example: 123456 |
ownOrRentResidenceFlag | Indicador de propiedad o alquiler | Type: Integer Longitudes sugeridas por fiserv: Example: 2 |
postalCode | Código postal | Type: Integer Longitudes sugeridas por fiserv: Example: 01640 |
stateOfBirth | Estado de nacimiento | Type: String |
PUT /v1/customers/account
Request schema
Campo | Descripción | Información Adicional |
|---|---|---|
accountNumber | Número de cuenta del cliente | Type: String Pattern: "^[0-9]+$" Required |
alternateCustomer | Información de cliente alternativo | Referencia a |
customerNumber | Número de cliente | Type: String Pattern: "^[0-9]+$" Required |
qualification | Calificación del cliente | Type: String |
customerTypeIndicator | Indicador de tipo de cliente | Type: Integer |
foreignUseIndicator | Indicador de uso extranjero | Type: Integer |
AlternateCustomerRequestDTO
Campo | Descripción | Información adicional |
|---|---|---|
expirationDate | Fecha de vencimiento del cliente alternativo | Type String Format: date yyyy/mm/dd |
status | Estado del cliente alternativo | Type: String |
0 Comments