production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/payees/accounts/inter-banking/information
get /v1/customers/payees/accounts/inter-banking/information
interbank-payee-accounts-info
To retrieve and persist the inter bank payee account details.
The API helps to retrieve and persist the inter bank payee account details.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Optional in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/payees/accounts/inter-banking/information
/v1/customers/payees/accounts/intra-banking/information
get /v1/customers/payees/accounts/intra-banking/information
intrabank-payee-accounts-info
To retrieve and persist the intra bank payee account details.
The API helps to retrieve and persist the intra bank payee account details.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Optional in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/payees/accounts/intra-banking/information
/v1/customers/payees/accounts/own-accounts/information
get /v1/customers/payees/accounts/own-accounts/information
own-accounts-info
To retrieve and persist the own account details.
The API helps to retrieve and persist the own account details.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Optional in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/payees/accounts/own-accounts/information
put /v1/customers/payees/accounts/own-accounts/information
update-own-accounts-info
This API is used to update the details of the own accounts for the customer.
This API is used to update the details of the own accounts for the customer.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
updateOwnAccountsRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
PUT https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/payees/accounts/own-accounts/information
/v1/customers/payees/accounts/own-accounts/information/portability
get /v1/customers/payees/accounts/own-accounts/information/portability
own-accounts-data-portability
To retrieve and persist the own account details.
The API helps to retrieve and persist the own account details.
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Optional in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
GET https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/payees/accounts/own-accounts/information/portability
Definitions
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/PayeeAccount"
}
}
}
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
},
"accountNumber": {
"description": "The account associated to the customer",
"type": "string",
"example": "75767767555",
"maxLength": 18
},
"accountNickName": {
"description": "Account alias name",
"type": "string",
"example": "TDC Tía BVBV",
"maxLength": 20
},
"accountType": {
"description": "Type of the account",
"type": "integer",
"format": "int32",
"example": 61,
"maxLength": 2
},
"accountTypeDescription": {
"description": "Name of the type of the account",
"type": "string",
"example": "Clabe interbancaria",
"maxLength": 40
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "integer",
"format": "int32",
"example": 1,
"maxLength": 2
},
"currencyCodeDescription": {
"description": "Currency code of the account",
"type": "string",
"example": "Pesos Mexicanos",
"maxLength": 20
},
"displayAccountNumber": {
"description": "Tha last digits of the account or card",
"type": "string",
"example": "0082",
"maxLength": 4
},
"recurrentAccountEligibleFlag": {
"description": "Flag that indicates if the account is a candidate to be a recurrent payee or not.",
"type": "boolean",
"example": false
},
"recurrentAccountFlag": {
"description": "Flag that indicates if the account is a recurrent or not.",
"type": "boolean",
"example": false
},
"registrationChannelId": {
"description": "Channel through which the account was registered",
"type": "string",
"example": "38",
"maxLength": 4
},
"merchantId": {
"description": "Unique identifier of a company which provides a product (merchant)",
"type": "string",
"example": "878676",
"maxLength": 6
},
"merchantCategoryCode": {
"description": "Unique identifier of a service (merchant)",
"type": "string",
"example": "0123",
"maxLength": 4
},
"loanType": {
"description": "Type of the loan",
"type": "string",
"example": "Credito Hipotecario"
},
"routingNumber": {
"description": "ABA Code",
"type": "string",
"example": "02",
"maxLength": 10
},
"swiftCode": {
"description": "swift code",
"type": "string",
"example": "01",
"maxLength": 12
},
"industrySegment": {
"description": "Economical sector",
"type": "string",
"example": "3",
"maxLength": 2
},
"payeeDetail": {
"$ref": "#/definitions/Payee"
},
"accountProfile": {
"$ref": "#/definitions/AccountProfile"
}
},
"required": [
"accountId",
"accountType",
"accountTypeDescription",
"currencyCode",
"currencyCodeDescription",
"displayAccountNumber",
"recurrentAccountEligibleFlag",
"recurrentAccountFlag"
]
}
{
"type": "object",
"properties": {
"payeeName": {
"description": "Name of the beneficiary",
"type": "string",
"example": "Carlos Ruso Hernández",
"maxLength": 54
},
"partyType": {
"description": "Unique identifier of the type of the beneficiary",
"type": "integer",
"example": 2,
"maxLength": 2
},
"partyTypeDescription": {
"description": "The beneficiary type: Physical or moral person",
"type": "string",
"example": "MORAL",
"maxLength": 55
},
"emailAddress": {
"description": "Payee email address",
"type": "string",
"example": "carlo.russo@hotmail.com",
"maxLength": 78
},
"bankId": {
"description": "Identifier of the bank of beneficiary",
"type": "string",
"example": "4625",
"maxLength": 4
},
"bankName": {
"description": "Name of the bank of beneficiary",
"type": "string",
"example": "BBVA Bancomer",
"maxLength": 20
},
"transactionLimitAmount": {
"description": "Limit of the transaction amount set for the payee",
"type": "number",
"format": "double",
"example": 675757.99,
"maxLength": 12
},
"paymentFrequencyType": {
"description": "Periodicity-payment frequency: D=Diario, S=Semanal, Q=Quincenal, M=Mensual and A=Anual",
"type": "string",
"example": "D",
"maxLength": 1
}
},
"required": [
"partyType",
"partyTypeDescription",
"transactionLimitAmount",
"paymentFrequencyType"
]
}
{
"type": "object",
"properties": {
"lastSearchDate": {
"description": "Payee account last date search",
"type": "string",
"format": "date",
"example": "2018-05-06",
"maxLength": 10
},
"lastUpdatedDate": {
"description": "Payee account last update date",
"type": "string",
"format": "date",
"example": "2018-05-06",
"maxLength": 10
},
"creationDateTime": {
"description": "Account payee creation date time",
"type": "string",
"format": "dateTime",
"example": "2019-01-01T12:10:00",
"maxLength": 19
},
"cancellationDate": {
"description": "Payee account cancellation date",
"type": "string",
"format": "date",
"example": "2018-05-06",
"maxLength": 10
}
}
}
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/PayeeAccountDetail"
}
}
}
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
},
"accountNumber": {
"description": "The account associated to the customer",
"type": "string",
"example": "75767767555",
"maxLength": 18
},
"branchId": {
"description": "The branch id where the account was created",
"type": "string",
"example": "1242",
"maxLength": 4
},
"accountType": {
"description": "Type of the account",
"type": "integer",
"format": "int32",
"example": 61,
"maxLength": 2
},
"accountTypeDescription": {
"description": "Name of the type of the account",
"type": "string",
"example": "Clabe interbancaria",
"maxLength": 40
},
"cardType": {
"description": "Type of the card- Debit/ Credit",
"type": "string",
"example": "TDC"
},
"accountNickName": {
"description": "Account alias name",
"type": "string",
"example": "TDC Tía BVBV",
"maxLength": 20
},
"productCode": {
"description": "Product code that identify the type of account",
"type": "integer",
"format": "int32",
"example": 66
},
"productInstrument": {
"description": "The product instrument code",
"type": "integer",
"format": "int32",
"example": 12
},
"productName": {
"description": "Product Name",
"type": "string",
"example": "Payrol account",
"maxLength": 22
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "integer",
"format": "int32",
"example": 1,
"maxLength": 2
},
"currencyCodeDescription": {
"description": "Currency code of the account",
"type": "string",
"example": "Pesos Mexicanos",
"maxLength": 20
},
"displayAccountNumber": {
"description": "Tha last digits of the account or card",
"type": "string",
"example": "0082",
"maxLength": 4
},
"recurrentAccountEligibleFlag": {
"description": "Flag that indicates if the account is a candidate to be a recurrent payee or not.",
"type": "boolean",
"example": false
},
"recurrentAccountFlag": {
"description": "Flag that indicates if the account is a recurrent or not.",
"type": "boolean",
"example": false
},
"payeeDetail": {
"$ref": "#/definitions/PayeeDetail"
},
"accountProfile": {
"$ref": "#/definitions/AccountProfileData"
}
},
"required": [
"accountId",
"productCode",
"productInstrument",
"currencyCode",
"currencyCodeDescription",
"accountType",
"accountTypeDescription",
"displayAccountNumber",
"recurrentAccountEligibleFlag",
"recurrentAccountFlag"
]
}
{
"type": "object",
"properties": {
"payeeName": {
"description": "Name of the beneficiary",
"type": "string",
"example": "Carlos Ruso Hernández",
"maxLength": 54
},
"phoneNumber": {
"description": "Phone number of the payee",
"type": "string",
"example": "55223123",
"maxLength": 10
},
"taxId": {
"description": "RFC",
"type": "string",
"example": "FTM981104540"
},
"emailAddress": {
"description": "Payee email address",
"type": "string",
"example": "carlo.russo@hotmail.com",
"maxLength": 78
},
"partyType": {
"description": "Unique identifier of the type of the beneficiary",
"type": "integer",
"example": 2,
"maxLength": 2
},
"partyTypeDescription": {
"description": "The beneficiary type: Physical or moral person",
"type": "string",
"example": "MORAL",
"maxLength": 55
},
"transactionLimitAmount": {
"description": "Limit of the transaction amount set for the payee",
"type": "number",
"format": "double",
"example": 675757.99,
"maxLength": 12
},
"paymentFrequencyType": {
"description": "Periodicity-payment frequency: D=Diario, S=Semanal, Q=Quincenal, M=Mensual and A=Anual",
"type": "string",
"example": "D",
"maxLength": 1
}
},
"required": [
"taxId",
"partyType",
"partyTypeDescription",
"transactionLimitAmount",
"paymentFrequencyType"
]
}
{
"type": "object",
"properties": {
"lastSearchDate": {
"description": "Payee account last date search",
"type": "string",
"format": "date",
"example": "2018-05-06",
"maxLength": 10
},
"lastUpdatedDate": {
"description": "Payee account last update date",
"type": "string",
"format": "date",
"example": "2018-05-06",
"maxLength": 10
},
"creationDateTime": {
"description": "Account payee creation date time",
"type": "string",
"format": "dateTime",
"example": "2019-01-01T12:10:00",
"maxLength": 19
},
"cancellationDate": {
"description": "Payee account cancellation date",
"type": "string",
"format": "date",
"example": "2018-05-06",
"maxLength": 10
},
"expiryDate": {
"description": "expiration date of the account registered for payment",
"type": "string",
"format": "date",
"example": "2020-02-03",
"maxLength": 10
}
}
}
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/PayeeAccountInformation"
}
}
}
}
{
"type": "object",
"properties": {
"accountAlias": {
"description": "CLABE of the account",
"type": "string",
"example": "123456789123"
},
"customerId": {
"description": "The customer ID",
"type": "string",
"example": "123456789123"
},
"accountAccessPrefix": {
"description": "The account access prefix",
"type": "string",
"example": "1234"
},
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
},
"accountStatus": {
"description": "Status of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"accountStatusDescription": {
"description": "To identify if the card or account is active, preactive or cancelled",
"type": "string",
"example": "Active"
},
"accountVisibilityFlag": {
"description": "To indicate if the account is going to be visible",
"type": "boolean",
"example": true
},
"accountAssociationType": {
"description": "Type of the association of the account",
"type": "integer",
"example": 19
},
"accountNickName": {
"description": "Nickname of the account",
"type": "string",
"example": "Mi cuenta favorita"
},
"accountNumber": {
"description": "The account associated to the customer",
"type": "string",
"example": "1234567890123456"
},
"accountType": {
"description": "type of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"accountTypeDescription": {
"description": "Name of the type of the account",
"type": "string",
"example": "Cuenta maestra"
},
"branchId": {
"description": "The branch id where the account was created",
"type": "string",
"example": "1234"
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"currencyCodeDescription": {
"description": "Currency Code of the account",
"type": "string",
"example": "MXN"
},
"displayAccountNumber": {
"description": "Tha last digits of the account or card",
"type": "string",
"example": "1234"
},
"productCode": {
"description": "Product code that identify the type of account",
"type": "integer",
"format": "int32",
"example": 66
},
"productInstrument": {
"description": "The product instrument code",
"type": "integer",
"format": "int32",
"example": 12
},
"productName": {
"description": "The product name",
"type": "string",
"example": "Checking Account"
},
"deviceAccessData": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountMediaAccessInfo"
}
}
},
"required": [
"accountId",
"accountNumber",
"accountType",
"accountTypeDescription",
"currencyCode",
"currencyCodeDescription",
"displayAccountNumber",
"accountAccessPrefix",
"accountStatus",
"accountStatusDescription",
"productCode",
"productInstrument"
]
}
{
"type": "object",
"properties": {
"deviceAccessPrefix": {
"description": "The device access prefix which is first four digits of account/card",
"type": "string",
"example": "7002"
},
"deviceAccessUniqueId": {
"description": "Unique ID used by front end to identify the account as a device access",
"type": "string",
"example": "23234"
},
"deviceAccessId": {
"description": "access Media Id",
"type": "string",
"example": "949025241893"
},
"deviceAccessStatus": {
"description": "status of access Media",
"type": "integer",
"format": "int64",
"example": 0
},
"deviceAccessStatusDescription": {
"description": "description of access media status",
"type": "string",
"example": "ACTIVO HASTA SU VENCIMIENTO"
},
"deviceAccessCancellationDate": {
"description": "Device access cancellation date",
"type": "string",
"format": "date",
"example": "2018-05-06",
"maxLength": 10
},
"deviceAccessType": {
"description": "type if device Access Media",
"type": "integer",
"format": "int32",
"example": 0
},
"deviceAccessTypeDescription": {
"description": "accountType",
"type": "string",
"example": "Chequera"
},
"bankIdentificationNumber": {
"description": "account prefix",
"type": "string",
"example": "123456"
},
"productSubCode": {
"description": "This is a secondary code",
"type": "string",
"example": "234"
},
"cardHolderType": {
"description": "Identifies the type of card user such as Primary or Suplementary.",
"type": "string",
"example": "PRIMARY"
},
"deviceAccessNickName": {
"description": "Nickname of the account",
"type": "string",
"example": "Mi cuenta favorita"
},
"productName": {
"description": "The product name",
"type": "string",
"example": "Checking Account"
},
"displayDeviceAccessNumber": {
"description": "displayAccessMedia",
"type": "string",
"example": "123"
},
"deviceAccessVisibilityFlag": {
"description": "It indicates if the access media is going to be visible",
"type": "boolean",
"example": true
},
"cardType": {
"description": "Type of the card- Debit/ Credit",
"type": "string",
"example": "TDC"
}
},
"required": [
"deviceAccessId",
"deviceAccessStatus",
"deviceAccessType",
"deviceAccessUniqueId",
"deviceAccessStatusDescription",
"deviceAccessTypeDescription",
"displayDeviceAccessNumber",
"deviceAccessPrefix"
]
}
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/PayeeAccountData"
}
}
}
}
{
"type": "object",
"properties": {
"accountAlias": {
"description": "CLABE of the account",
"type": "string",
"example": "123456789123"
},
"customerId": {
"description": "The customer ID",
"type": "string",
"example": "123456789123"
},
"accountAccessPrefix": {
"description": "The account access prefix",
"type": "string",
"example": "1234"
},
"accountId": {
"description": "Unique ID used by front end to identify the account",
"type": "string",
"example": "123456"
},
"accountStatus": {
"description": "Status of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"accountStatusDescription": {
"description": "To identify if the card or account is active, preactive or cancelled",
"type": "string",
"example": "Active"
},
"accountVisibilityFlag": {
"description": "To indicate if the account is going to be visible",
"type": "boolean",
"example": true
},
"accountAssociationType": {
"description": "Type of the association of the account",
"type": "integer",
"example": 19
},
"accountNickName": {
"description": "Nickname of the account",
"type": "string",
"example": "Mi cuenta favorita"
},
"accountNumber": {
"description": "The account associated to the customer",
"type": "string",
"example": "1234567890123456"
},
"accountType": {
"description": "type of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"accountTypeDescription": {
"description": "Name of the type of the account",
"type": "string",
"example": "Cuenta maestra"
},
"branchId": {
"description": "The branch id where the account was created",
"type": "string",
"example": "1234"
},
"currencyCode": {
"description": "The currency code identifier of the account",
"type": "integer",
"format": "int32",
"example": 1
},
"currencyCodeDescription": {
"description": "Currency Code of the account",
"type": "string",
"example": "MXN"
},
"displayAccountNumber": {
"description": "Tha last digits of the account or card",
"type": "string",
"example": "1234"
},
"productCode": {
"description": "Product code that identify the type of account",
"type": "integer",
"format": "int32",
"example": 66
},
"productInstrument": {
"description": "The product instrument code",
"type": "integer",
"format": "int32",
"example": 12
},
"productName": {
"description": "The product name",
"type": "string",
"example": "Checking Account"
},
"deviceAccessData": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountMediaAccessInfo"
}
}
},
"required": [
"accountId",
"accountNumber",
"accountType",
"accountTypeDescription",
"currencyCode",
"currencyCodeDescription",
"displayAccountNumber",
"accountAccessPrefix",
"accountStatus",
"accountStatusDescription",
"productCode",
"productInstrument"
]
}
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/Account"
}
}
},
"required": [
"accounts"
]
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique ID used by front end to indentify the account",
"type": "string",
"example": "123456"
},
"accountVisibilityFlag": {
"description": "To indicate if the account is going to be visible",
"type": "boolean",
"example": true
},
"deviceAccessData": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountMediaAccess"
}
}
},
"required": [
"accountId"
]
}
{
"type": "object",
"properties": {
"deviceAccessUniqueId": {
"description": "Unique ID used by front end to identify the account as a device access",
"type": "string",
"example": "23234"
},
"deviceAccessVisibilityFlag": {
"description": "It indicates if the access media is going to be visible",
"type": "boolean",
"example": true
}
}
}
{
"type": "object",
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountDetail"
}
}
},
"required": [
"accounts"
]
}
{
"type": "object",
"properties": {
"accountId": {
"description": "Unique ID used by front end to indentify the account",
"type": "string",
"example": "123456"
},
"accountVisibilityFlag": {
"description": "To indicate if the account is going to be visible",
"type": "boolean",
"example": true
},
"validResponseFlag": {
"description": "Flag to represent if the response from update process was successful",
"type": "boolean",
"example": true
},
"invalidResponseMessage": {
"description": "Error response from update process",
"type": "string",
"example": "The requested account id doesn't exist"
},
"oldAccount": {
"$ref": "#/definitions/AccountInformation"
},
"deviceAccessData": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountMediaAccessDetail"
}
}
},
"required": [
"accountId"
]
}
{
"type": "object",
"properties": {
"accountVisibilityFlag": {
"description": "To indicate if the account is going to be visible",
"type": "boolean",
"example": true
}
}
}
{
"type": "object",
"properties": {
"deviceAccessUniqueId": {
"description": "Unique ID used by front end to identify the account as a device access",
"type": "string",
"example": "23234"
},
"deviceAccessVisibilityFlag": {
"description": "It indicates if the access media is going to be visible",
"type": "boolean",
"example": true
},
"validResponseFlag": {
"description": "Flag to represent if the response from update process was successful",
"type": "boolean",
"example": true
},
"invalidResponseMessage": {
"description": "Error response from update process",
"type": "string",
"example": "The requested account id doesn't exist"
},
"oldDeviceAccessData": {
"$ref": "#/definitions/AccountMediaAccessInformation"
}
}
}
{
"type": "object",
"properties": {
"deviceAccessVisibilityFlag": {
"description": "It indicates if the access media is going to be visible",
"type": "boolean",
"example": true
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "More Info can be used to pass any additional details",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}