production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/accounts/statements/transactions
post /v1/customers/accounts/statements/transactions
account-statement-transactions
The API helps to orchestrate and retrieve account specific transactions for a particular period
The API helps to orchestrate and retrieve account specific transactions for a particular period
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
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
accountStatementTransactionRequest
Required in body
object
Cycle for which transaction being requested
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/accounts/statements/transactions
Definitions
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "unique identifier of account mapped to account number",
"example": "12345678"
},
"rowLimit": {
"description": "Maximum Number of transactions per request for each account",
"type": "integer",
"format": "int32",
"example": 10
},
"pageId": {
"description": "Page Id",
"type": "integer",
"example": 10
},
"transactionQueryCycle": {
"description": "Cycle for which transaction being requested",
"type": "integer",
"example": 10
}
},
"required": [
"accountId",
"rowLimit",
"pageId",
"transactionQueryCycle"
]
}
{
"type": "object",
"properties": {
"moreInformationFlag": {
"description": "Indicates if the account has more transactions available.",
"type": "boolean",
"example": true
},
"pageId": {
"description": "Id of the page",
"type": "integer",
"format": "int32",
"example": 5
},
"transactionQueryCycle": {
"description": "Transaction Cycle for which details is required",
"type": "integer",
"example": 10
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/Transaction"
}
}
},
"required": [
"moreInformationFlag",
"transactionQueryCycle",
"pageId"
]
}
{
"type": "object",
"properties": {
"transactionAmount": {
"description": "Transaction amount",
"type": "number",
"format": "double",
"example": 15000.01
},
"transactionDate": {
"description": "Date on which the transaction was made",
"type": "string",
"example": "2019-12-26"
},
"transactionDescription": {
"description": "Transaction description",
"type": "string",
"example": "IVA COMISION ANUAL"
},
"transactionStatus": {
"description": "Transaction status",
"type": "string",
"example": "Aprobada"
},
"requestReceiptIndicator": {
"description": "Indicate if the transaction is for CEP",
"type": "string",
"example": "E"
},
"transactionReferenceNumber": {
"description": "Transaction reference number",
"type": "string",
"example": "D INT 423234454"
},
"authorizationCode": {
"description": "Transaction authorization code",
"type": "string",
"example": "1274"
},
"runningBalanceAmount": {
"description": "Refers to available balance in the account associated with current transaction",
"type": "number",
"format": "double",
"example": 55286.95
},
"merchantCategoryCode": {
"description": "It is used to classify the business by the type of goods or services it provides",
"type": "string",
"example": "145253"
},
"loanTransactions": {
"$ref": "#/definitions/LoanAccount"
}
}
}
{
"type": "object",
"properties": {
"transactionCode": {
"description": "Transaction Code",
"type": "string",
"example": "123"
},
"transactionType": {
"description": "Transaction Type",
"type": "string",
"example": "01"
},
"branchId": {
"description": "Branch Id",
"type": "string",
"example": "1234"
},
"tellerStationNumber": {
"description": "Teller where the transaction is attended",
"type": "string",
"example": "123"
}
}
}
{
"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"
]
}