SERV-SOR-V-PayrollPortabilityInformation 1.0.0

No votes yet

Description

The Microservice manages the activities related to Payroll Portability of customers from and to Banamex Accounts

Endpoints

production

development

https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2

Paths

/v1/servicing/accounts/payroll/portability

retrieve-payroll-portability-info

Summary

The API retrieves the details of payroll portability request

Description

The API retrieves the details of payroll portability request

Security

OAuth2 Application Flow

(oauth2 application)

Token URL

https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token

Scopes

/api/v1

Client ID

X-IBM-Client-Id

(apiKey located in header)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

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

ChannelId

Required in header

string

Channel where request originated

sid

Required in header

string

SessionId sent by Consumer

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

businesscode

Required in header

string

Business code identified during application registration

Responses

200

Successful operation.

RetrievePayrollPortabilityResponse

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

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

ErrorResponse

404

Type	Code	Details	More Info
error	resourceNotFound	The requested resource was not found	Empty resource/resource not found

ErrorResponse

422

Type	Code	Details
error	businessValidationFailed	Business validation error occured on one or more parameters

ErrorResponse

500

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

Example Response

Definition

GET https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/accounts/payroll/portability

Response

/v1/servicing/accounts/payroll/portability/manage

create-payroll-portability-info

Summary

To create the request of payroll portability for the customer

Description

The API is used to create the request of payroll portability for the customer

Security

OAuth2 Application Flow

(oauth2 application)

Token URL

https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token

Scopes

/api/v1

Client ID

X-IBM-Client-Id

(apiKey located in header)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

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

ChannelId

Required in header

string

Channel where request originated

sid

Required in header

string

SessionId sent by Consumer

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

businesscode

Required in header

string

Business code identified during application registration

createPayrollPortabilityRequest

Optional in body

object

CreatePayrollPortabilityRequest

Responses

200

Successful operation.

CreatePayrollPortabilityResponse

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

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

ErrorResponse

404

Type	Code	Details	More Info
error	resourceNotFound	The requested resource was not found	Empty resource/resource not found

ErrorResponse

422

Type	Code	Details
error	businessValidationFailed	Business validation error occured on one or more parameters

ErrorResponse

500

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

Example Response

Definition

POST https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/accounts/payroll/portability/manage

Response

cancel-payroll-portability-info

Summary

To cancel the request of payroll portability for the customer

Description

The API is used to cancel the request of payroll portability for the customer

Security

OAuth2 Application Flow

(oauth2 application)

Token URL

https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/oauth/token

Scopes

/api/v1

Client ID

X-IBM-Client-Id

(apiKey located in header)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

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

ChannelId

Required in header

string

Channel where request originated

sid

Required in header

string

SessionId sent by Consumer

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

businesscode

Required in header

string

Business code identified during application registration

cancelPayrollPortabilityRequest

Optional in body

object

CancelPayrollPortabilityRequest

Responses

200

Successful operation.

CancelPayrollPortabilityResponse

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

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

ErrorResponse

404

Type	Code	Details	More Info
error	resourceNotFound	The requested resource was not found	Empty resource/resource not found

ErrorResponse

422

Type	Code	Details
error	businessValidationFailed	Business validation error occured on one or more parameters

ErrorResponse

500

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

Example Response

Definition

PUT https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/accounts/payroll/portability/manage

Response

Definitions

RetrievePayrollPortabilityResponse

{
    "type": "object",
    "properties": {
        "birthDate": {
            "description": "customer's date of birth",
            "type": "string",
            "format": "date",
            "example": "1989-12-26"
        },
        "application": {
            "$ref": "#/definitions/PortabilityApplication"
        }
    }
}

PortabilityApplication

{
    "type": "object",
    "properties": {
        "applicationDate": {
            "description": "date of application submission",
            "type": "string",
            "format": "date",
            "example": "2019-12-26"
        },
        "applicationStatus": {
            "description": "portability application status",
            "type": "string",
            "example": "1"
        },
        "cancellationReason": {
            "description": "application rejection description",
            "type": "string",
            "example": "13"
        },
        "channelType": {
            "description": "Last Requestor Channel",
            "type": "string",
            "example": "1"
        },
        "createdByAgentId": {
            "description": "user id of application creator",
            "type": "string",
            "example": "sb12345"
        },
        "folio": {
            "description": "EBPM Folio generated for portability request",
            "type": "string",
            "example": "7863289379"
        },
        "lastApplicationDate": {
            "description": "Last application date",
            "type": "string",
            "format": "date",
            "example": "2019-12-26"
        },
        "lastApplicationType": {
            "description": "last request operation",
            "type": "string",
            "example": "1"
        },
        "lastUpdatedDate": {
            "description": "date of last update made to payroll portability",
            "type": "string",
            "format": "date",
            "example": "2019-12-26"
        },
        "rejectionReason": {
            "description": "reason of portability rejection",
            "type": "string",
            "example": "12"
        },
        "updatedByAgentId": {
            "description": "request updated by user",
            "type": "string",
            "example": "ab12345"
        },
        "destinationAccount": {
            "$ref": "#/definitions/DestinationAccount"
        },
        "sourceAccount": {
            "$ref": "#/definitions/SourceAccount"
        }
    }
}

DestinationAccount

{
    "type": "object",
    "properties": {
        "accountAlias": {
            "description": "CLABE number of the account",
            "type": "string",
            "example": "12345678901234"
        },
        "accountId": {
            "type": "string",
            "description": "unique identifier of account mapped to account number",
            "example": "12345678"
        },
        "accountType": {
            "description": "type of account",
            "type": "string",
            "example": "checking"
        },
        "bankId": {
            "description": "bank id",
            "type": "string",
            "example": "BNX"
        },
        "bankName": {
            "description": "Bank Name",
            "type": "string",
            "example": "Banamex"
        },
        "customerId": {
            "description": "unique identifier of the customer",
            "type": "string",
            "example": "123456789012"
        }
    }
}

SourceAccount

{
    "type": "object",
    "properties": {
        "accountAlias": {
            "description": "CLABE number of the account",
            "type": "string",
            "example": "12345678901234"
        },
        "accountNumber": {
            "description": "account number of the customer",
            "type": "string",
            "example": "1234567890"
        },
        "accountType": {
            "description": "type of account",
            "type": "string",
            "example": "Checking"
        },
        "bankId": {
            "description": "unique identifier of bank",
            "type": "string",
            "example": "BNX"
        },
        "bankName": {
            "description": "bank name",
            "type": "string",
            "example": "Banamex"
        },
        "branchId": {
            "description": "branch id of the account",
            "type": "string",
            "example": "1234"
        }
    }
}

CreatePayrollPortabilityRequest

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "unique identifier of customer",
            "type": "string",
            "example": "123456789012"
        },
        "portabilityApplication": {
            "$ref": "#/definitions/PortabilityApplicationInfo"
        },
        "security": {
            "$ref": "#/definitions/Security"
        }
    },
    "required": [
        "customerId"
    ]
}

PortabilityApplicationInfo

{
    "type": "object",
    "properties": {
        "channelType": {
            "description": "Requestor Channel",
            "type": "string",
            "example": "Bancanet"
        },
        "portabilityType": {
            "description": "Code to indicate if the portability is to or from banamex account. Values S for send or R to receive",
            "type": "string",
            "example": "S"
        },
        "sourceAccountInfo": {
            "$ref": "#/definitions/SourceAccountInfo"
        },
        "destinationAccountInfo": {
            "$ref": "#/definitions/DestinationAccountInfo"
        }
    },
    "required": [
        "portabilityType"
    ]
}

SourceAccountInfo

{
    "type": "object",
    "properties": {
        "accountId": {
            "type": "string",
            "description": "unique identifier of account mapped to account number",
            "example": "12345678"
        },
        "accountAlias": {
            "description": "CLABE number of the account",
            "type": "string",
            "example": "12345678901234"
        },
        "accountNumber": {
            "description": "account number of the customer",
            "type": "string",
            "example": "1234567890"
        },
        "cardNumber": {
            "description": "Number of the Card.",
            "type": "string",
            "example": "566233800020356"
        },
        "accountType": {
            "description": "type of account",
            "type": "string",
            "example": "Checking"
        },
        "bankId": {
            "description": "unique identifier of bank",
            "type": "string",
            "example": "12"
        },
        "bankName": {
            "description": "bank name",
            "type": "string",
            "example": "Banamex"
        },
        "branchId": {
            "description": "branch id of the account",
            "type": "string",
            "example": "1234"
        }
    }
}

DestinationAccountInfo

{
    "type": "object",
    "properties": {
        "accountId": {
            "type": "string",
            "description": "unique identifier of account mapped to account number",
            "example": "12345678"
        },
        "accountAlias": {
            "description": "CLABE number of the account",
            "type": "string",
            "example": "12345678901234"
        },
        "accountNumber": {
            "description": "account number of the customer",
            "type": "string",
            "example": "1234567890"
        },
        "accountType": {
            "description": "type of account",
            "type": "string",
            "example": "checking"
        },
        "bankId": {
            "description": "bank id",
            "type": "string",
            "example": "12"
        },
        "bankName": {
            "description": "Bank Name",
            "type": "string",
            "example": "Banamex"
        },
        "branchId": {
            "description": "branch id of the account",
            "type": "string",
            "example": "1234"
        },
        "cardNumber": {
            "description": "card number of the customer",
            "type": "string",
            "example": "1234567890123456"
        },
        "caseId": {
            "description": "Unique identifier associated with Case",
            "type": "string",
            "example": "232333"
        }
    }
}

CreatePayrollPortabilityResponse

{
    "type": "object",
    "properties": {
        "folio": {
            "description": "EBPM Folio generated for portability request",
            "type": "string",
            "example": "7863289379"
        },
        "portabilityTimeStamp": {
            "description": "Time stamp when the portability is made it",
            "type": "string",
            "format": "dateTime",
            "example": "02/07/2020 18:20:40"
        }
    },
    "required": [
        "portabilityTimeStamp"
    ]
}

Security

{
    "type": "object",
    "properties": {
        "lastEncryptedChallenge": {
            "type": "string",
            "example": "0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=",
            "description": "Challenge previously received (must be same as the given from get challenge service), composed by \"Challenge\" : \"String State\". This is encrypted by the frontend using Platform End-to-End encryption APIs."
        },
        "encryptedChallengeToken": {
            "type": "string",
            "example": "0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=",
            "description": "Challenge token generated by the hardToken or softToken assigned to the client, This is encrypted by the frontend using Platform End-to-End encryption APIs."
        }
    }
}

CancelPayrollPortabilityRequest

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "unique identifier of the customer",
            "type": "string",
            "example": "123456789012"
        },
        "PortabilityApplicationDetail": {
            "$ref": "#/definitions/PortabilityApplicationDetail"
        },
        "security": {
            "$ref": "#/definitions/SecurityDetail"
        }
    },
    "required": [
        "customerId"
    ]
}

PortabilityApplicationDetail

{
    "type": "object",
    "properties": {
        "cancellationDate": {
            "description": "date of application cancellation",
            "type": "string",
            "format": "date",
            "example": "2019-12-26"
        },
        "cancellationReason": {
            "description": "reason of cancellation",
            "type": "string",
            "example": "time expired"
        },
        "cancelledByAgentId": {
            "description": "user id of application cancellation",
            "type": "string",
            "example": "sb12345"
        },
        "channelType": {
            "description": "Requestor Channel",
            "type": "string",
            "example": "Bancanet"
        },
        "sourceAccountInfo": {
            "$ref": "#/definitions/SourceAccountDetail"
        },
        "destinationAccountInfo": {
            "$ref": "#/definitions/DestinationAccountDetail"
        }
    }
}

SourceAccountDetail

{
    "type": "object",
    "properties": {
        "accountAlias": {
            "description": "CLABE number of the account",
            "type": "string",
            "example": "12345678901234"
        },
        "accountNumber": {
            "description": "account number of the customer",
            "type": "string",
            "example": "1234567890"
        },
        "accountType": {
            "description": "type of account",
            "type": "string",
            "example": "Checking"
        },
        "bankId": {
            "description": "unique identifier of bank",
            "type": "string",
            "example": "BNX"
        },
        "bankName": {
            "description": "bank name",
            "type": "string",
            "example": "Banamex"
        },
        "branchId": {
            "description": "branch id of the account",
            "type": "string",
            "example": "1234"
        }
    }
}

DestinationAccountDetail

{
    "type": "object",
    "properties": {
        "accountAlias": {
            "description": "CLABE number of the account",
            "type": "string",
            "example": "12345678901234"
        },
        "accountId": {
            "type": "string",
            "description": "unique identifier of account mapped to account number",
            "example": "12345678"
        },
        "accountType": {
            "description": "type of account",
            "type": "string",
            "example": "checking"
        },
        "bankId": {
            "description": "bank id",
            "type": "string",
            "example": "BNX"
        },
        "bankName": {
            "description": "Bank Name",
            "type": "string",
            "example": "Banamex"
        }
    },
    "required": [
        "accountId"
    ]
}

SecurityDetail

{
    "type": "object",
    "properties": {
        "lastEncryptedChallenge": {
            "type": "string",
            "example": "0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=",
            "description": "Challenge previously received (must be same as the given from get challenge service), composed by \"Challenge\" : \"String State\". This is encrypted by the frontend using Platform End-to-End encryption APIs."
        },
        "encryptedChallengeToken": {
            "type": "string",
            "example": "0736H4sIAAAAAAAAAI1STWgTQRR+2SbUNBWq6MFbaEUQIT+SmoSeQtrDyhqDWxXsQSababKyM7POvm2SCp4KQu+eBa967cWbR2+ePAjeBfEgiNSbbzbbNtYeHBjm/b/vfW/efodcpGG5xyQTfFzyKrXq43qlUtr0hS8HrRiHXLrIkP/e/fypFLV/WZC5DfkImUaK4WMNxYh7seaeEmGMlFSKRtwrzaS+PvhhHbb2OhYUbLgs2rHWXOI0AH2PodI2LImuVqg8FTzgOvKVtKEg7nGMtbTltjLa/YhrW1KTyIFFMc1vK9FTCBedJ2yHlQMmB2UXNaFY24KcWGfUH65vOacglg3E8l8ITOiaA/PC7hvxKTwHy4E8qRsUgpPUYPybk5Cn6iVxV/sDX7JgBk7qOy9cHplJ2kMWBIlxHML0fKCbMRchX62kJ9ZnQJ1lcxbqx9zVFwfvX96wAJKqc7TGlTNz1ye0W9/rjpLBfr678nWn/u2ZBfOPiKENb5hwe8eXFOD6u9yBBZEg5nJwNGZiCU/mMDwYi90/Vjt8RAVSNSuOZPof1/5vIrW/t3L45c2yBVkDqIW0xl6MPLJN9Vj0uHYIcIf+adolJ443YSjIwpTQCy7b5g+V7he7AaOGsUBYOCHB0A4IhWqxVm00i/XV5q2QTmTqnEvXY4VGW0zk8B/v3GkvwhKtr7parzUa9eZNIyNkY/qu9MgUcI4gZgTmX+3/AT2pjop1AwAA=",
            "description": "Challenge token generated by the hardToken or softToken assigned to the client, This is encrypted by the frontend using Platform End-to-End encryption APIs."
        }
    }
}

CancelPayrollPortabilityResponse

{
    "type": "object",
    "properties": {
        "applicationStatus": {
            "description": "status of portability application",
            "type": "string",
            "example": "1"
        },
        "folio": {
            "description": "EBPM Folio generated for portability request",
            "type": "integer",
            "format": "int32",
            "example": 2337823
        }
    }
}

ErrorResponse

{
    "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"
    ]
}

sandbox.developer.banamex.com

Menu

SERV-SOR-V-PayrollPortabilityInformation

SERV-SOR-V-PayrollPortabilityInformation 1.0.0

Paths

/v1/servicing/accounts/payroll/portability

/v1/servicing/accounts/payroll/portability/manage

Definitions