En esta sección se encuentran los campos mandatorios y el formato a validar en el Account Aggregation Service, en cada request por cada endpoint.
Template para mensajes de validación:
Campo requerido
{fieldName} is required
Longitud del campo
{fieldName} must be between {min} and {max} characters long {fieldName} must be {n} characters long
{fieldName} must be 1 character long
Rangos enteros permitidos
{fieldName} must be at least {value} {fieldName} must be at most {value}
Expresión regular (fechas, email)
{fieldName} must be valid, expected format: {regular expression or suggested format}
Ejemplo de respuesta con error en validación REST Controller
{
"message": "Invalid requests",
"code": "INVALID_PARAMETERS",
"description": "Invalid requests",
"args": [
{
"arg": "REASON",
"value": "accountNumber must be 19 characters long"
}
],
"status": "400 BAD_REQUEST"
}
{
"message": "Invalid requests",
"code": "INVALID_PARAMETERS",
"description": "Invalid requests",
"args": [
{
"arg": "REASON",
"value": "blockCodeIndicator is required|foreignUse must be at most 1|functionCode must be 1 charac
}
],
"status": "400 BAD_REQUEST"
}
gRPC
Endpoints
Block Code
POST /v1/accounts/blocks
Request Schema
Campo | Formato |
|---|---|
accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
functionCode | string mandatory minLength: 0 maxLength: 1 example: B enum: U, B |
blockCodeIndicator | integer mandatory example: 1 Min Length = 1 Max Length = 1 Values: 0 = Tests both block code 1 and 2 to determine and use the one that fits best relative to priority settings (not allowed for unblock) 1 = Block code 1 2 = Block code 2 |
foreignUse | string mandatory minLength: 0 maxLength: 1 example: 0 Values: 0 1 |
Account Details / Sync
POST /v1/accounts/details
POST /v1/accounts/syncs
Request Schema
Campo | Formato |
|---|---|
accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
Transfer Peer to Peer
PUT /v1/balances/transfers-p2p
Request Schema
Campo | Formato |
|---|---|
to.accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
to.actionCode | String mandatory minLenght=4 string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
from.accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
from.actionCode | String mandatory minLenght=4 maxLength=4 example=8008 |
transactionAmount | Long mandatory |
xTransactionId | String mandatory |
effectiveDate | String mandatory YYYY-MM-DD |
Account Balance / Sync POST
/v1/balances
POST /v1/balances/syncs
Request Schema
Campo | Formato |
|---|---|
accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
Transfer Balance
PUT /v1/balances/transfers
Request Schema
Campo | Formato |
|---|---|
accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
ransactionData.transactionAmount | mandatory |
transactionData.actionCode | mandatory |
transactionData.effectiveDate | mandatory |
transactionData.description | mandatory |
transactionData.paidConcept | mandatory |
transactionData.n1n2ByPass | mandatory |
transactionData.identifier | mandatory |
transactionData.box | mandatory |
transactionData.crPlaza | mandatory |
transactionData.crStore | mandatory |
transactionData.keyTracking | mandatory |
transactionData.beneficiaryAccount | mandatory |
transactionData.senderAccount | mandatory |
transactionData.counterpartInstitution | mandatory |
transactionData.operatingInstitution | mandatory |
ransactionData.frcUprkBeneficiary | mandatory |
transactionData.orderingFrcUprk | mandatory |
transactionData.device | mandatory |
transactionData.ip | mandatory |
transactionData.latitude | mandatory |
transactionData.longitude | mandatory |
transactionData.recipientName | mandatory |
transactionData.orderingName | mandatory |
transactionData.paymentSourceId X- | mandatory |
Transaction-ID memoPostedIndicator | mandatory |
suppressMonetaryTransaction | mandatory |
Frozen Balance
PUT /v1/balances/transfers-qr
Request Schema
Campo | Formato |
|---|---|
accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
Pre Auth
POST /v1/accounts/preauth
Request Schema
Campo | Formato |
|---|---|
accountNumber | string mandatory minLength: 19 maxLength: 19 example: 1234567891234567891 |
action | string mandatory minLength: 1 maxLength: 1 |
operation | string mandatory minLength: 1 maxLength: 1 |
logo | string mandatory numeric regular expression |
transactionAmount | long mandatory must be at least 0 |
0 Comments