production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/party/relationships
post /v1/customers/party/relationships
create-party-relationship
Create a relationship between member and a customer
Sets the relation between a member with a 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
source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}createPartyRelationshipRequest
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
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships
put /v1/customers/party/relationships
update-party-relationship
Updates the relationship between a party with a customer
Updates the relationship between a party with a 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
stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}updatePartyRelationshipRequest
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/party/relationships
/v1/customers/party/customer-relationships/retrieve
post /v1/customers/party/customer-relationships/retrieve
retrieve-customer-relationship-by-party
Retrieve the customer information related to a party
Retrieves the customer information related to a particular party
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
stationName
Optional in header
string
Computer name calling or executing API
{
"maxLength": 8
}source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}retrieveCustomerByPartyRequest
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
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/customer-relationships/retrieve
/v1/customers/party/relationships/retrieve
post /v1/customers/party/relationships/retrieve
retrieve-party-by-customer-relationship
Get the parties information just sending the client Id
Get the relationship information from parties who are related to a 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
source
Required in header
number
SourceSystem or Source Application calling the API
{
"maxLength": 6
}operator
Required in header
string
Executive ID accesing API
{
"maxLength": 10
}retrievePartyRelationshipRequest
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
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/party/relationships/retrieve
Definitions
{
"type": "object",
"properties": {
"partyRelationship": {
"$ref": "#/definitions/PartyRelationship"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Client number or product owner",
"type": "string",
"example": "73335782",
"maxLength": 12,
"pattern": "^\\d{12}$"
},
"jobTitle": {
"description": "Type of job that the member does.",
"type": "string",
"example": "01",
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"partyId": {
"description": "Client number generated for the member",
"type": "string",
"example": "2445",
"maxLength": 12,
"pattern": "^\\d{12}$"
},
"percentageOwnership": {
"description": "Percent of participation of the member in the product",
"type": "number",
"format": "float",
"example": 25,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"relationshipType": {
"description": "What is the member's relationship with client",
"type": "string",
"example": "04",
"maxLength": 4,
"pattern": "^\\d{4}$"
},
"partyRoleType": {
"description": "Type o member",
"type": "string",
"example": "01",
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"product": {
"$ref": "#/definitions/Product"
}
},
"required": [
"customerId",
"partyId",
"partyRoleType"
]
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Banamex product ID",
"type": "string",
"example": "0993",
"maxLength": 4,
"pattern": "^\\d{4}$"
},
"productInstrument": {
"description": "Instrument related to the product",
"type": "string",
"example": "32",
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"contractNumber": {
"description": "Client's contract",
"type": "string",
"example": "337822",
"maxLength": 12,
"pattern": "^\\d{12}$"
}
}
}
{
"type": "object",
"properties": {
"requestType": {
"description": "To remove or update the relation information ('V - remove', 'M - update')",
"type": "string",
"example": "M",
"maxLength": 1,
"pattern": "^[A-Z]*$"
},
"partyRelationship": {
"$ref": "#/definitions/PartyRelationship"
}
},
"required": [
"requestType"
]
}
{
"type": "object",
"properties": {
"partyId": {
"description": "Member Id to identify",
"type": "string",
"example": "889363",
"maxLength": 12,
"pattern": "^\\d{12}$"
},
"pageIdWithContract": {
"description": "PageId for parties with contract",
"type": "integer",
"example": 5,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"pageIdWithoutContract": {
"description": "PageId for parties without contract",
"type": "integer",
"example": 10,
"maxLength": 2,
"pattern": "^\\d{2}$"
}
},
"required": [
"partyId"
]
}
{
"type": "object",
"properties": {
"moreInfoWithContractFlag": {
"description": "Flag to know if there is more members with a banamex contract (any kind of contract) to retrieve",
"type": "boolean",
"example": true
},
"moreInfoWithoutContractFlag": {
"description": "Flag to know if there is more members without a banamex contract (any kind of contract) to retrieve",
"type": "boolean",
"example": false
},
"pageIdWithContract": {
"description": "PageId for parties with contract",
"type": "integer",
"example": 5,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"pageIdWithoutContract": {
"description": "PageId for parties without contract",
"type": "integer",
"example": 10,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"party": {
"type": "array",
"items": {
"$ref": "#/definitions/PartyDetails"
}
}
}
}
{
"type": "object",
"properties": {
"jobTitle": {
"description": "Type of job in the company",
"type": "string",
"example": "CEO"
},
"partyRelationship": {
"$ref": "#/definitions/PartyRelationshipDetails"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Customer Id",
"type": "string",
"example": "888093876"
},
"relationshipType": {
"description": "Relationship beetween the member and customer",
"type": "string",
"example": "07"
},
"customerName": {
"description": "Name of the customer",
"type": "string",
"example": "JUAN PABLO DE LA ROSA ALLENDE"
},
"partyRoleType": {
"description": "Position in the board of directors",
"type": "string",
"example": "Director"
},
"percentageOwnership": {
"description": "Percent of amount indicated in policy",
"type": "number",
"format": "double",
"example": 30
},
"product": {
"$ref": "#/definitions/Product"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "Customer Id",
"type": "string",
"example": "34466334",
"maxLength": 12,
"pattern": "^\\d{12}$"
},
"pageIdWithContract": {
"description": "PageId for parties with contract",
"type": "integer",
"example": 5,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"pageIdWithoutContract": {
"description": "PageId for parties without contract",
"type": "integer",
"example": 10,
"maxLength": 2,
"pattern": "^\\d{2}$"
}
},
"required": [
"customerId",
"moreInfoWithContractFlag",
"partiesNumberToFetch"
]
}
{
"type": "object",
"properties": {
"moreInfoWithContractFlag": {
"description": "Flag to know if there is more members with a banamex contract (any kind of contract) to retrieve",
"type": "boolean",
"example": true
},
"moreInfoWithoutContractFlag": {
"description": "Flag to know if there is more members without a banamex contract (any kind of contract) to retrieve",
"type": "boolean",
"example": false
},
"pageIdWithContract": {
"description": "PageId for parties with contract",
"type": "integer",
"example": 5,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"pageIdWithoutContract": {
"description": "PageId for parties without contract",
"type": "integer",
"example": 10,
"maxLength": 2,
"pattern": "^\\d{2}$"
},
"party": {
"type": "array",
"items": {
"$ref": "#/definitions/PartyDetailsInformation"
}
}
}
}
{
"type": "object",
"properties": {
"fullName": {
"description": "Complete name of the member",
"type": "string",
"example": "Fernando Diaz Miranda",
"maxLength": 55
},
"jobTitle": {
"description": "Type of job in the company",
"type": "string",
"example": "20"
},
"partyId": {
"description": "Member Id",
"type": "integer",
"format": "int32",
"example": 4476222
},
"relationshipType": {
"description": "Relationship between the member and customer",
"type": "integer",
"format": "int32",
"example": 4
},
"partyRoleType": {
"description": "Position in the board of directors",
"type": "string",
"example": "Director"
},
"percentageOwnership": {
"description": "Percent of amount indicated in policy",
"type": "number",
"format": "double",
"example": 50
},
"product": {
"$ref": "#/definitions/ProductDetails"
}
}
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Product hired related to the member",
"type": "string",
"example": "433"
},
"paymentInstrumentId": {
"description": "Instrument of payment",
"type": "string",
"example": "20"
},
"contractNumber": {
"description": "Client's contract",
"type": "string",
"example": "337822"
}
}
}
{
"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"
]
}