production
development
https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2
Paths
/v1/servicing/payments/file/store
post /v1/servicing/payments/file/store
store-payment-file
API to store payment file into database for night processing
Corporate payment file being received and store into Oracle DB
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
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
paymentFileStorageRequest
Required 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/payments/file/store
Definitions
{
"type": "object",
"properties": {
"dataCenterLocation": {
"description": "Customer data center location",
"type": "string",
"example": "40"
},
"authorizationIndicator": {
"description": "Indicator to identify if the file needs a remote authorization of the representative 2. It will happen in different moment",
"type": "integer",
"format": "int32",
"example": 1
},
"legalRepresentativeId": {
"description": "Representative of the Enterprise who receive the file",
"type": "string",
"example": "99"
},
"checkerLegalRepresentativeId": {
"description": "Representative of the Enterprise who review the file and give confirmation",
"type": "string",
"example": "99"
},
"totalTransactionCount": {
"description": "Number of deposits to perform per file",
"type": "integer",
"format": "int32",
"example": 999999
},
"totalDepositAmount": {
"description": "Total Amount of deposits to perform per file",
"type": "number",
"format": "double",
"example": 10000000000000000
},
"layoutType": {
"description": "Type of layout of the file to validate",
"type": "string",
"example": "A"
},
"customer": {
"$ref": "#/definitions/Customer"
},
"account": {
"$ref": "#/definitions/Account"
},
"payment": {
"$ref": "#/definitions/Payment"
}
},
"required": [
"dataCenterLocation",
"authorizationIndicator",
"legalRepresentativeId",
"checkerLegalRepresentativeId",
"totalTransactionCount",
"totalDepositAmount",
"layoutType",
"payment"
]
}
{
"type": "object",
"properties": {
"paymentDate": {
"description": "Date when payment will be completed",
"type": "string",
"format": "date",
"example": "2019-10-21"
},
"fileSequenceNumber": {
"description": "Customer file sequence number",
"type": "integer",
"format": "int32",
"example": 5
},
"paymentType": {
"description": "Payment type for file to be processed (Payrol, checkbook, etc)",
"type": "string",
"example": "05"
},
"paymentFile": {
"description": "File layout content Base64 coded",
"type": "string",
"example": "MTAwMDA2NjQ3Mjk3OTEzMDIxOTAwODdlbXByZXNhZnVsYW5pdG9zICAgICAgICAgICAgICAgICAgICBub21pbmFmZWIyMDE5ICAgICAgIDA1ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIEMwMA0KMjEwMDEwMDAwMDAwMDAwMDAwMTAwMDAwMTA2ODEwMDAwMDAwMDAwMDAwNzkwMjIzMyAgICAgICAgICAgICAgICAgICAgDQozMDAwMTAwMDAwMDAwMDAwMDAwMTAwMDAzMDAwMDUxNzcxMjQ1MjI5MzQ2OTgxMTExMTExMTExICAgICAgICAgICAgICAgICAgICAgICAgIC"
}
},
"required": [
"paymentDate",
"fileSequenceNumber",
"paymentType",
"paymentFile"
]
}
{
"type": "object",
"properties": {
"transferReferenceNumber": {
"description": "Unique reference number of the payment",
"type": "string",
"example": "6412342"
}
},
"required": [
"transferReferenceNumber"
]
}
{
"type": "object",
"properties": {
"customerId": {
"description": "CitiBanamex internal customer identifier",
"type": "string",
"example": "668450123",
"maxLength": 12,
"pattern": "^[0-9]*$"
},
"fullName": {
"description": "Client name",
"type": "string",
"example": "Juan Perez"
}
},
"required": [
"customerId",
"fullName"
]
}
{
"type": "object",
"properties": {
"productCode": {
"description": "Unique code that identifies the product",
"type": "string",
"example": "1234"
},
"productInstrument": {
"description": "This is the instrument number",
"type": "string",
"example": "1234"
},
"contractNumber": {
"description": "contract number for client",
"type": "string",
"example": "123456789012"
},
"branchId": {
"description": "Is the branch office for the account",
"type": "string",
"example": "12"
}
}
}
{
"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"
]
}