production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
Paths
/v1/servicing/accounts/deposits/cash-transactions/folio
post /v1/servicing/accounts/deposits/cash-transactions/folio
create-folio
Creates a folio number for authorize cash transactions
Generates a folio number to get a transaction approval according to the limits of cash politics
OAuth2 Application Flow
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)
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
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
saveFolioRequest
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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/accounts/deposits/cash-transactions/folio
put /v1/servicing/accounts/deposits/cash-transactions/folio
update-folio
Updates a folio status
Status change according to the business rules
OAuth2 Application Flow
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)
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
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
updateFolioRequest
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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/accounts/deposits/cash-transactions/folio
/v1/servicing/accounts/deposits/cash-transactions/retrieve-folio
post /v1/servicing/accounts/deposits/cash-transactions/retrieve-folio
retrieve-folio
Recover the information of a folio given
Recover the information of a folio given
OAuth2 Application Flow
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)
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
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveFolioRequest
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://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/accounts/deposits/cash-transactions/retrieve-folio
Definitions
{
"type": "object",
"properties": {
"bankAccountTransaction": {
"$ref": "#/definitions/BankAccountTransaction"
}
}
}
{
"type": "object",
"properties": {
"transactionAmount": {
"description": "Transaction amount",
"type": "number",
"format": "double",
"maxLength": 12,
"example": 130000.58
},
"transactionDescription": {
"description": "Reason why the customer is doing the cash transaction",
"type": "string",
"maxLength": 180,
"example": "HERENCIA"
},
"tellerStationName": {
"description": "Terminal where the transaction was requested",
"type": "string",
"maxLength": 4,
"example": "05"
},
"accountNumber": {
"description": "Account number which the transactions is related",
"type": "string",
"maxLength": 16,
"example": "0000000006982770"
},
"branchId": {
"description": "Branch where the transaction was requested",
"type": "string",
"maxLength": 4,
"example": "0100"
},
"customerId": {
"description": "Customer number",
"type": "string",
"maxLength": 12,
"example": "000003020297"
},
"sourceSystem": {
"description": "System where the transaction was made",
"type": "string",
"maxLength": 6,
"example": "2345"
},
"agent": {
"$ref": "#/definitions/AgentCreateFolio"
},
"document": {
"$ref": "#/definitions/Document"
},
"transactionAuthorization": {
"$ref": "#/definitions/TransactionAuthorizationCreateFolio"
}
},
"required": [
"transactionAmount",
"accountNumber",
"branchId",
"customerId",
"transactionDescription",
"tellerStationName",
"sourceSystem"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "Agent SoeID",
"type": "string",
"maxLength": 16,
"example": "AG33022"
},
"employeeNumber": {
"description": "Employee number of the agent",
"type": "string",
"maxLength": 10,
"example": "003033020297"
}
},
"required": [
"agentId",
"employeeNumber"
]
}
{
"type": "object",
"properties": {
"documentId": {
"description": "Reference number of document type or voucher or receipt",
"type": "string",
"maxLength": 18,
"example": "012345"
},
"documentType": {
"description": "Type of document",
"type": "string",
"maxLength": 4,
"example": "IFE"
}
},
"required": [
"documentId",
"documentType"
]
}
{
"type": "object",
"properties": {
"transactionReferenceId": {
"description": "Folio number generated for the transaction",
"type": "string",
"example": "000003020297000003"
}
},
"required": [
"transactionReferenceId"
]
}
{
"type": "object",
"properties": {
"bankAccountTransaction": {
"$ref": "#/definitions/BankAccountTransactionUpdate"
}
}
}
{
"type": "object",
"properties": {
"transactionReferenceId": {
"description": "Folio number",
"type": "string",
"maxLength": 18,
"example": "000003020297000003"
},
"transactionStatus": {
"description": "Folio status",
"type": "integer",
"format": "int32",
"maxLength": 1,
"example": 1
},
"branchId": {
"description": "Branch where the folio belongs",
"type": "string",
"maxLength": 4,
"example": "2345"
},
"tellerStationName": {
"description": "Terminal where the transaction was requested",
"type": "string",
"maxLength": 4,
"example": "05"
},
"sourceSystem": {
"description": "System where the transaction was made",
"type": "string",
"maxLength": 6,
"example": "2345"
},
"agent": {
"$ref": "#/definitions/AgentDetail"
},
"transactionAuthorization": {
"$ref": "#/definitions/TransactionAuthorization"
}
},
"required": [
"transactionReferenceId",
"transactionStatus",
"branchId",
"sourceSystem",
"tellerStationName"
]
}
{
"type": "object",
"properties": {
"agentId": {
"description": "Agent soeid",
"type": "string",
"maxLength": 16,
"example": "AS33992"
},
"employeeNumber": {
"description": "Employee number of the Agent",
"type": "string",
"maxLength": 10,
"example": "0001315587"
},
"supervisorAgentId": {
"description": "Authorizator agent soeid",
"type": "string",
"maxLength": 16,
"example": "SA33345"
},
"supervisorEmployeeNumber": {
"description": "Employee number of the supervisor Agent",
"type": "string",
"maxLength": 10,
"example": "SA33345"
},
"jointAgentId": {
"description": "Agent soeid for joint authorizations",
"type": "string",
"maxLength": 16,
"example": "AS33992"
},
"jointEmployeeNumber": {
"description": "Employee number of the Agent for joint authorizations",
"type": "string",
"maxLength": 10,
"example": "0001315587"
}
},
"required": [
"agentId",
"employeeNumber"
]
}
{
"type": "object",
"properties": {
"bankAccountTransaction": {
"$ref": "#/definitions/BankAccountTransactionDetails"
}
}
}
{
"type": "object",
"properties": {
"transactionAmount": {
"description": "Amount of the transaction",
"type": "number",
"format": "double",
"maxLength": 12,
"example": 20002.12
},
"transactionStatus": {
"description": "Status of the folio",
"type": "integer",
"format": "int32",
"maxLength": 1,
"example": 2
},
"branchId": {
"description": "Branch where the folio belongs",
"type": "string",
"maxLength": 4,
"example": "322"
},
"transactionAuthorization": {
"$ref": "#/definitions/TransactionAuthorization"
}
},
"required": [
"transactionAmount",
"transactionStatus",
"branchId"
]
}
{
"type": "object",
"properties": {
"authorizationId": {
"description": "Authorization number of the transaction",
"type": "string",
"maxLength": 6,
"example": "003993882"
}
}
}
{
"type": "object",
"properties": {
"authorizationId": {
"description": "Authorization number of the transaction",
"type": "string",
"maxLength": 6,
"example": "003993882"
}
}
}
{
"type": "object",
"properties": {
"bankAccountTransaction": {
"$ref": "#/definitions/BankAccountTransactionRetrieve"
}
}
}
{
"type": "object",
"properties": {
"transactionReferenceId": {
"description": "Folio number to retrieve information",
"type": "string",
"maxLength": 18,
"example": "000003020297000003"
},
"branchId": {
"description": "Branch where the folio was created",
"type": "string",
"maxLength": 4,
"example": "0001315587"
},
"tellerStationName": {
"description": "Terminal where the transaction was requested",
"type": "string",
"maxLength": 4,
"example": "05"
},
"agentId": {
"description": "Agent number soeid",
"type": "string",
"maxLength": 16,
"example": "AG12356"
},
"employeeNumber": {
"description": "Employee number of the agent",
"type": "string",
"maxLength": 10,
"example": "0023212356"
},
"sourceSystem": {
"description": "System where the transaction was made",
"type": "string",
"maxLength": 6,
"example": "2345"
}
},
"required": [
"transactionReferenceId",
"branchId",
"sourceSystem",
"tellerStationName"
]
}
{
"type": "object",
"properties": {
"bankAccountTransaction": {
"$ref": "#/definitions/BankAccountTransactionDetail"
}
}
}
{
"type": "object",
"properties": {
"transactionAmount": {
"description": "Amount of the transaction",
"type": "number",
"format": "double",
"maxLength": 12,
"example": 300000
},
"transactionStatus": {
"description": "Folio estatus",
"type": "integer",
"format": "int32",
"maxLength": 1,
"example": 1
},
"branchId": {
"description": "Branch number where the transaction was made",
"type": "string",
"maxLength": 4,
"example": "0100"
},
"accountNumber": {
"description": "Acount number of the transaction",
"type": "string",
"maxLength": 16,
"example": "0000000006985773"
},
"transactionAuthorization": {
"$ref": "#/definitions/TransactionAuthorization"
}
},
"required": [
"transactionAmount",
"transactionStatus",
"branchId",
"accountNumber"
]
}
{
"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"
]
}