SERV-PYI-D-PaymentFileManagement

SERV-PYI-D-PaymentFileManagement 1.0.0

0
No votes yet

this microservice contains the functionality for management of remote authorization of the payment files

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

Paths

/v1/servicing/payments/files/authorization

post /v1/servicing/payments/files/authorization
remote-authorization

API to receive the authorization of the payment files

Receive the authorization of the payment files

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

remoteAuthorizationRequest
Required in body
object
RemoteAuthorizationRequest
200

Successful operation.

RemoteAuthorizationResponse
400
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
ErrorResponse
401
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
ErrorResponse
403
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
ErrorResponse
404
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
ErrorResponse
422
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
ErrorResponse
500
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
ErrorResponse
Example Request
Example Response
POST https://sandbox.externalapib2b.wlb.nam.nsroot.net:7101/mx-gcgapi-uat/sandbox2/api/v1/servicing/payments/files/authorization

Definitions 

{
    "type": "object",
    "properties": {
        "customerId": {
            "description": "CitiBanamex internal customer identifier",
            "type": "string",
            "minLength": 1,
            "maxLength": 12,
            "pattern": "^[0-9]{1,12}",
            "example": "887779"
        },
        "checkerLegalRepresentativeId": {
            "description": "Representative of the Enterprise who review the file and give confirmation",
            "type": "string",
            "example": "99",
            "maxLength": 2
        },
        "paymentFile": {
            "$ref": "#/definitions/PaymentFile"
        }
    },
    "required": [
        "customerId",
        "checkerLegalRepresentativeId",
        "paymentFile"
    ]
}
              
{
    "type": "object",
    "properties": {
        "transferReferenceNumber": {
            "description": "Unique identification number of confirmation of receipt of the authorization request for a payroll file previously sent by another representative",
            "type": "string",
            "example": "6412342"
        }
    },
    "required": [
        "transferReferenceNumber"
    ]
}
              
{
    "type": "object",
    "properties": {
        "paymentDate": {
            "description": "Date payment was requested",
            "type": "string",
            "format": "date",
            "pattern": "([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))",
            "example": "2019-11-05"
        },
        "fileSequenceNumber": {
            "description": "Customer file sequence number",
            "type": "integer",
            "format": "int32",
            "example": 10,
            "default": 0
        }
    },
    "required": [
        "paymentDate",
        "fileSequenceNumber"
    ]
}
              
{
    "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"
    ]
}