crds-ccc-o-card-batch-request 1.0.0

No votes yet

Description

This microservice decides if the request is from a debit or a credit card and it will call to the corresponding domain to trigger the functionality of add, authorize, inquire or cancel corresponding to the precreated cards.

Endpoints

production

development

https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext

Paths

/v1/cards/batches/request

create-card-batch-request

Summary

LOB:Cards; Feature:Batch Request Debit and Credit Cards; Functionality:Create

Description

This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of add a request for debit or credit cards corresponding to the precreated cards.

Security

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)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

uuid

Required in header

string

128 bit UUID that you generate for every request

Required in header

string

Content-Types that are acceptable for the response

Accept-Language

Optional in header

string

List of acceptable human languages for response

{
    "default": "es"
}

ChannelId

Required in header

string

Channel where request originated

Content-Type

Required in header

string

Content-Types that are sent in the request

{
    "default": "application\/json"
}

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

{
    "default": "MX"
}

businessCode

Required in header

string

Business code identified during application registration

{
    "default": "GCB"
}

sid

Required in header

string

SessionId sent by Consumer

createCardBatchRequest

Required in body

object

CreateCardBatchRequest

Responses

200

Successful operation.

CreateCardBatchResponse

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters
error	cannotDecryptData	620-Cannot decrypt, please re-check the encrypted value

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details
error	accessNotConfigured	The request operation is not configured to access this resource
error	productNotAllowed	The card is not allowed to issue CVV2 and 2FA.

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
error	backendError	Failed during a call to backend service
error	timeoutError	Time to complete a transaction is over
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

Example Response

Definition

POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/batches/request

Response

/v1/cards/batches/requests/authorization

authorization-card-batch-request

Summary

LOB:Cards; Feature:Batch Request Debit and Credit Cards; Functionality:Authorization

Description

This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of authorize a request for debit or credit cards corresponding to the precreated cards.

Security

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)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

uuid

Required in header

string

128 bit UUID that you generate for every request

Required in header

string

Content-Types that are acceptable for the response

Accept-Language

Optional in header

string

List of acceptable human languages for response

{
    "default": "es"
}

ChannelId

Required in header

string

Channel where request originated

Content-Type

Required in header

string

Content-Types that are sent in the request

{
    "default": "application\/json"
}

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

{
    "default": "MX"
}

businessCode

Required in header

string

Business code identified during application registration

{
    "default": "GCB"
}

sid

Required in header

string

SessionId sent by Consumer

authorizationCardBatchRequest

Required in body

object

AuthorizationCardBatchRequest

Responses

204

Successful operation.

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters
error	cannotDecryptData	620-Cannot decrypt, please re-check the encrypted value

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details
error	accessNotConfigured	The request operation is not configured to access this resource
error	productNotAllowed	The card is not allowed to issue CVV2 and 2FA.

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
error	backendError	Failed during a call to backend service
error	timeoutError	Time to complete a transaction is over
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

Example Response

Definition

POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/batches/requests/authorization

Response

/v1/cards/batches/requests/cancellation

cancellation-card-batch-request

Summary

LOB:Cards; Feature: Batch Request Debit and Credit Cards; Functionality:Cancellation

Description

This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of cancel a request for debit or credit cards corresponding to the precreated cards.

Security

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)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

uuid

Required in header

string

128 bit UUID that you generate for every request

Required in header

string

Content-Types that are acceptable for the response

Accept-Language

Optional in header

string

List of acceptable human languages for response

{
    "default": "es"
}

ChannelId

Required in header

string

Channel where request originated

Content-Type

Required in header

string

Content-Types that are sent in the request

{
    "default": "application\/json"
}

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

{
    "default": "MX"
}

businessCode

Required in header

string

Business code identified during application registration

{
    "default": "GCB"
}

sid

Required in header

string

SessionId sent by Consumer

cancellationCardBatchRequest

Required in body

object

CancellationCardBatchRequest

Responses

204

Successful operation.

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters
error	cannotDecryptData	620-Cannot decrypt, please re-check the encrypted value

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details
error	accessNotConfigured	The request operation is not configured to access this resource
error	productNotAllowed	The card is not allowed to issue CVV2 and 2FA.

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
error	backendError	Failed during a call to backend service
error	timeoutError	Time to complete a transaction is over
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

Example Response

Definition

POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/batches/requests/cancellation

Response

/v1/cards/batches/requests/retrieve

retrieve-card-batch-request

Summary

LOB:Cards; Feature:Batch Request Debit and Credit Cards; Functionality:retrieve

Description

This API depending on the classification, whether it is a debit or credit card, will trigger the funcionality of inquiry to bring the information of a request for debit or credit cards corresponding to the precreated cards.

Security

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)

Parameters

client_id

Required in header

string

Client ID generated during application registration

Authorization

Required in header

string

The Authorization Token received during login

uuid

Required in header

string

128 bit UUID that you generate for every request

Required in header

string

Content-Types that are acceptable for the response

Accept-Language

Optional in header

string

List of acceptable human languages for response

{
    "default": "es"
}

ChannelId

Required in header

string

Channel where request originated

Content-Type

Required in header

string

Content-Types that are sent in the request

{
    "default": "application\/json"
}

countryCode

Required in header

string

Country code in 2 character ISO 3166 format

{
    "default": "MX"
}

businessCode

Required in header

string

Business code identified during application registration

{
    "default": "GCB"
}

sid

Required in header

string

SessionId sent by Consumer

retrieveCardBatchRequest

Required in body

object

RetrieveCardBatchRequest

Responses

200

Successful operation.

RetrieveCardBatchResponse

400

Type	Code	Details
error	invalidRequest	Missing or invalid Parameters
error	cannotDecryptData	620-Cannot decrypt, please re-check the encrypted value

ErrorResponse

401

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

ErrorResponse

403

Type	Code	Details
error	accessNotConfigured	The request operation is not configured to access this resource
error	productNotAllowed	The card is not allowed to issue CVV2 and 2FA.

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
error	backendError	Failed during a call to backend service
error	timeoutError	Time to complete a transaction is over
fatal	serverUnavailable	The request failed due to an internal error/server unavailability

ErrorResponse

Example Request

Example Response

Definition

POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/batches/requests/retrieve

Response

Definitions

CreateCardBatchRequest

{
    "type": "object",
    "properties": {
        "cardTypeCode": {
            "description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
            "maxLength": 3,
            "type": "string",
            "example": "322"
        },
        "embossedProductCode": {
            "description": "This field will send the Number of the Product of the card for example 994 that means 'Simplicity', 941 that means 'Teleton'",
            "maxLength": 3,
            "type": "string",
            "example": "994"
        },
        "branchName": {
            "description": "Name of the Branch or the Sales Unit",
            "maxLength": 32,
            "type": "string",
            "example": "Sucursal Acapulco"
        },
        "productId": {
            "description": "Unique Identifier of the plastic card for example 607 - 'Simplicity', 620 - 'Citi Rewards'",
            "maxLength": 3,
            "type": "string",
            "example": "607"
        },
        "batchCardCount": {
            "description": "Ammount of cards that are going to be processed or required.",
            "type": "integer",
            "format": "int32",
            "example": 1234
        },
        "agentId": {
            "description": "Executive number that request the special package SOEID",
            "maxLength": 12,
            "type": "string",
            "example": "il90164"
        }
    },
    "required": [
        "cardTypeCode",
        "embossedProductCode",
        "branchName",
        "productId",
        "batchCardCount",
        "agentId"
    ]
}

CreateCardBatchResponse

{
    "type": "object",
    "properties": {
        "batchReferenceNumber": {
            "description": "Unique refrence number to identify the operation for the request of precreated cards. It is generated by the folio operation service, used  for tracking.",
            "maxLength": 6,
            "type": "string",
            "example": "123456"
        }
    }
}

AuthorizationCardBatchRequest

{
    "type": "object",
    "properties": {
        "cardTypeCode": {
            "description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
            "maxLength": 3,
            "type": "string",
            "example": "322"
        },
        "batchReferenceNumber": {
            "description": "Unique refrence number to identify the operation for the request of precreated cards. It is generated by the folio operation service, used  for tracking.",
            "maxLength": 6,
            "type": "string",
            "example": "123456"
        },
        "agentId": {
            "description": "Executive number that request the special package SOEID",
            "maxLength": 12,
            "type": "string",
            "example": "il90164"
        }
    },
    "required": [
        "batchReferenceNumber",
        "agentId"
    ]
}

CancellationCardBatchRequest

{
    "type": "object",
    "properties": {
        "cardTypeCode": {
            "description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
            "maxLength": 3,
            "type": "string",
            "example": "322"
        },
        "batchReferenceNumber": {
            "description": "Unique refrence number to identify the operation for the request of precreated cards. It is generated by the folio operation service, used  for tracking.",
            "maxLength": 6,
            "type": "string",
            "example": "123456"
        },
        "agentId": {
            "description": "Executive number that request the special package SOEID",
            "maxLength": 12,
            "type": "string",
            "example": "il90164"
        },
        "cancellationReasons": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/CancellationReason"
            }
        }
    }
}

CancellationReason

{
    "type": "object",
    "properties": {
        "cancellationReasonDescription": {
            "description": "Reason for Case Cancellation For example- Duplicate Case- Customer Driven Cancellation",
            "maxLength": 60,
            "type": "string",
            "example": "Cancellation by repetition of process"
        }
    }
}

RetrieveCardBatchRequest

{
    "type": "object",
    "properties": {
        "cardTypeCode": {
            "description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
            "maxLength": 3,
            "type": "string",
            "example": "322"
        },
        "batchReferenceNumber": {
            "description": "Unique refrence number to identify the operation for the request of precreated cards. It is generated by the folio operation service, used  for tracking.",
            "maxLength": 6,
            "type": "string",
            "example": "123456"
        },
        "branchName": {
            "description": "Name of the Branch or the Sales Unit",
            "maxLength": 32,
            "type": "string",
            "example": "Sucursal Acapulco"
        },
        "agentId": {
            "description": "Executive number that request the special package SOEID",
            "maxLength": 12,
            "type": "string",
            "example": "il90164"
        },
        "pagination": {
            "$ref": "#/definitions/Pagination"
        }
    },
    "required": [
        "batchReferenceNumber",
        "branchName",
        "agentId"
    ]
}

RetrieveCardBatchResponse

{
    "type": "object",
    "properties": {
        "batchs": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Batch"
            }
        },
        "pagination": {
            "$ref": "#/definitions/Pagination"
        }
    }
}

Pagination

{
    "type": "object",
    "properties": {
        "nextBranchName": {
            "description": "This field will have the next branch name for pagination and for better display.",
            "maxLength": 32,
            "type": "string",
            "example": "Zara Galerias"
        },
        "nextRecordId": {
            "description": "This field will provide or request the next record for pagination and for better display.",
            "type": "integer",
            "format": "int32",
            "example": 12345
        }
    }
}

Batch

{
    "type": "object",
    "properties": {
        "batchReferenceNumber": {
            "description": "Unique refrence number to identify the operation for the request of precreated cards. It is generated by the folio operation service, used  for tracking.",
            "maxLength": 6,
            "type": "string",
            "example": "123456"
        },
        "branchName": {
            "description": "Name of the Branch or the Sales Unit",
            "maxLength": 32,
            "type": "string",
            "example": "Sucursal Acapulco"
        },
        "batchCardCount": {
            "description": "Ammount of cards that are going to be processed or required.",
            "type": "integer",
            "format": "int32",
            "example": 1234
        },
        "batchTypeCode": {
            "description": "Card Batch type. Used for Inquiry Only(functionCode = 'I'). Possible values 00 = Default, 01 =  Automatic, 02 = Manual, 03 = Transfer",
            "type": "string",
            "example": "01"
        },
        "requestStatusCode": {
            "description": "Status of the request. Possible Values:01= Pending, 02= Authorized, 03= Cancelled",
            "type": "string",
            "example": "01"
        },
        "agentId": {
            "description": "Executive SOEID number that request the card batch",
            "maxLength": 12,
            "type": "string",
            "example": "il90164"
        },
        "authorizeAgentId": {
            "description": "Executive SOEID number that authorize the request. ",
            "maxLength": 12,
            "type": "string",
            "example": "il90164"
        },
        "cancelAgentId": {
            "description": "Executive SOEID number that request the card batch cancellation",
            "maxLength": 12,
            "type": "string",
            "example": "il90164"
        },
        "authorizationDate": {
            "description": "Authorization date is the date when a transaction is approved. Format YYYY-MM-DD",
            "type": "string",
            "format": "date-time",
            "example": "2017-07-21T17:32:28Z"
        },
        "creationDate": {
            "description": "Date on which the batch is requested. Format YYYY-MM-DD",
            "type": "string",
            "format": "date-time",
            "example": "2017-07-21T17:32:28Z"
        },
        "processingDate": {
            "description": "Date on which the batch is processed. Format YYYY-MM-DD",
            "type": "string",
            "format": "date-time",
            "example": "2017-07-21T17:32:28Z"
        },
        "cancellationDate": {
            "description": "Date on which the transaction is cancelled. Format YYYY-MM-DD",
            "type": "string",
            "format": "date-time",
            "example": "2017-07-21T17:32:28Z"
        },
        "batchTrackNumber": {
            "description": "Number of the Card batch that exist for the request which is already processed",
            "type": "string",
            "example": "74587"
        },
        "batchStatusCode": {
            "description": "Status of Card Batch if already created for req id :Pending, Authorised,Expired, Lost, Damaged, Cancelled Possible values:01=PENDING,02=AUTHORIZED,03=EXPIRED,04=LOST,05=DAMAGED,06=CANCELLED,07=TRANSFERED,08=STOLEN",
            "type": "string",
            "example": "01"
        },
        "originBatchReferenceNumber": {
            "description": "This field will retrieve the information  the origin batch reference Number when the batch is going to be transfered from which reference is being transfered.",
            "type": "string",
            "maxLength": 6,
            "example": "123456"
        },
        "totalCount": {
            "description": "Number of the available plastics in the Branch that can be used to open an account.",
            "type": "integer",
            "format": "int32",
            "example": 123
        },
        "cardPlastic": {
            "$ref": "#/definitions/CardPlastic"
        },
        "cancellationReasons": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/CancellationReason"
            }
        }
    }
}

CardPlastic

{
    "type": "object",
    "properties": {
        "cardTypeCode": {
            "description": "This field will recover the ID from the cards where values will be '322' if it´s Credit or '321' if it's Debit.",
            "maxLength": 3,
            "type": "string",
            "example": "322"
        },
        "embossedProductCode": {
            "description": "This field will send the Number of the Product of the card for example 994 that means 'Simplicity', 941 that means 'Teleton'",
            "maxLength": 3,
            "type": "string",
            "example": "994"
        },
        "productId": {
            "description": "Unique Identifier of the plastic card for example 607 - 'Simplicity', 620 - 'Citi Rewards'",
            "maxLength": 3,
            "type": "string",
            "example": "607"
        },
        "cardShipment": {
            "$ref": "#/definitions/CardShipment"
        }
    }
}

CardShipment

{
    "type": "object",
    "properties": {
        "deliveryBranch": {
            "description": "Name of the Branch or the Sales Unit that will be transfered",
            "maxLength": 32,
            "type": "string",
            "example": "Sucursal Acapulco"
        },
        "expectedDeliveryDayCount": {
            "description": "Number of day permit pre-created card transfer",
            "type": "integer",
            "format": "int32",
            "example": 1
        },
        "deliveryRemarks": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/DeliveryRemark"
            }
        }
    }
}

DeliveryRemark

{
    "type": "object",
    "properties": {
        "deliveryRemarkDescription": {
            "description": "Description that explains the reason of why the request is being transfered to another branch.",
            "maxLength": 60,
            "type": "string",
            "example": "Transfered due to the branch needs more cards"
        }
    }
}

ErrorResponse

{
    "required": [
        "code",
        "details",
        "location",
        "moreInfo",
        "timestamp",
        "type"
    ],
    "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": {
            "type": "string",
            "description": "Error code which qualifies the error"
        },
        "details": {
            "type": "string",
            "description": "Human readable explanation specific to the occurrence of the problem"
        },
        "location": {
            "type": "string",
            "description": "The name of the field that resulted in the error"
        },
        "moreInfo": {
            "type": "string",
            "description": "URI to human readable documentation of the error"
        },
        "timestamp": {
            "type": "string",
            "description": "Timestamp of the error"
        }
    }
}

perf.developer.banamex.com

Menu

crds-ccc-o-card-batch-request

crds-ccc-o-card-batch-request 1.0.0

Paths

/v1/cards/batches/request

/v1/cards/batches/requests/authorization

/v1/cards/batches/requests/cancellation

/v1/cards/batches/requests/retrieve

Definitions