bcs-cards-management-api-services

API INFORMATION

Title: cards-management-api-services

Version: 1.0.0

Protocols: HTTPS

URI Sandbox: https://cards-management-api-services-dev.us-e1.cloudhub.io/cards-management/v1

URI QA: https://cards-management-api-services-qa.us-e1.cloudhub.io/cards-management/v1

URILive: https://cards-management-api-services-prod.us-e1.cloudhub.io/cards-management/v1

DOWLOAD RAML

DESCRIPTION

The purpose of this API is mangament Credit or debit card transactions, which allows the following operations:

Summary

-Apply Debit Card

Path:

/cardsManagement/v1/DebitCard

Headers

Response information:

responseType: Used to return the response

-Account Holds.

Path:

POST

/cards-management/v1/account-holds

Body:

govIssueIdentType: Type of customer identification. (CC, CE, LC, NI, OT, PA or RC)

identSerialNum: Number customer Identification

flagAllDebCardsBlock: Indicates if all debit cards associated with the client are going to be blocked

additionalAcctId: List with Number of Associated Accounts

> Example when sending flagAllDebCardsBlock value false.

 {
  "govIssueIdentType": "CC",
  "identSerialNum": "99999999",
  "flagAllDebCardsBlock": false,
  "additionalAcctId":["4985340009999999"]
 }

> Example when sending flagAllDebCardsBlock value true.

 {
  "govIssueIdentType": "CC",
  "identSerialNum": "99999999",
  "flagAllDebCardsBlock": true,
  "additionalAcctId":[]
 }

> Response 200.

{
    "responseType": {
        "value": "OK"
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

> Diagram of sequence.

####

##

-Credit Card Replacement.

Path:

POST

/cards-management/v1/card-orders/credit-card/replacement

Body:

acctId: Product number.

(If the channel know what is the number of card can send acctID on clear, and if the channel not know your need send encrypted value).

lockCode: Lock code (At the moment inly 01 is available)

> Example.

 {
  "acctId": "4570211273204425",
  "lockCode": "01"
 }

{
  "acctId": "f46626ae2ffa16e81c96b8374cd4b259",
  "lockCode": "01"
 }

> Response 200.

{
    "responseType": {
        "value": "OK"
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "2",
        "errorDesc": "Error description.",
        "errorType": "CLI"
    }
}

> Diagram of sequence.

####

##

-Debit Card Replacement

Description:

This service allows you to ask for a debit card replacement.

Path:

POST: /cards-management/v1/card-orders/debit-card/replacement

Headers:

Body:

> Mapping request:

> Request Example:

{
    "trn":{
        "operationType": "1",
        "reason": "IVR01",
        "trnSrc": "TEL",
        "fee":{
          "amt": "00000000100000"
        },
        "depAcctId":{
            "acctId":"24500036202"
        },
        "cardAcctId":{
            "blockTypeField":"",
            "acctId":"5496162795737624"
        },
        "govIssueIdent":{
            "govIssueIdentType":"CC",
            "identSerialNum":"51680607"
        },
        "contactInfo":{
            "emailAddr":"EMAIL@EMAIL.COM",
            "cellPhone":"3000000000"
        },
        "postAddr":{
            "type":"NAL",
            "addr1":"carrera 10 numero 10",
            "city":"Bogota",
            "country":"CO",
            "postalCode": 730005
        },
        "entprAgreement":{
            "spRefId":"",
            "svcIdent":"N",
            "svcRqUID":"N"
        }
    }
}

> Response Example:

{
    "responseType": {
        "value": "OK"
    },
    "trn":{
      "billerNum": "4615043316",
      "refId": "6321966129",
      "depAcctId": {
        "acctId": "24026154741"
      }
    }
}

> Response Error Example:

Additionally, the error code of APIKit has some custom error codes or business errors and all errors use the following structure.
{
    "responseType": {
        "value": "ER400"
    },
    "responseDetail": {
        "errorCode": "000001",
        "errorDesc": "No se encontraron extractos para la consulta generada.",
        "errorType": ""
    }
}

Errors Code:

Diagram of sequence.

-Credit Card CVV validation.

Path:

GET

/cards-management/v1/credit-card/cvv/{secretid}/validate

Operation get informtation about User for Digital enrollment

URIParameters:

secretid: Encrypted CVV (only when it is a credit card).

Headers

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

X-Invoker-ally: Ally

Headers Security

X-Security-CustLoginIdSi: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Query Parameters:

identserialnum: User Identification Number

govIssueIdentType: Type of customer identification. (CC, CE, PA, TI, NI or PE)

Response information:

responseType: Used to return the response

> Response 200.

{
    "responseType": {
        "value": "OK"
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
  "ResponseType": {
    "value": "ER"
  },
  "ResponseDetail": {
    "ErrorCode": "00068",
    "ErrorDesc": "Usuario ya existe.",
    "ErrorType": "OUD"
  }
}

> Diagram of sequence.

####

-Debit Card PIN validation.

Path:

GET

/cards-management/v1/debit-card/password/{secretid}/validate

Operation get informtation about User for Digital enrollment

URIParameters:

secretid: Encrypted TD Pin (only when it is a debit card)

Headers

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

X-Invoker-ally: Ally

Headers Security

X-Security-CustLoginIdSi: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Query Parameters:

identserialnum: User Identification Number

govIssueIdentType: Type of customer identification. (CC, CE, PA, TI, NI or PE)

Response information:

responseType: Used to return the response

> Response 200.

{
    "responseType": {
        "value": "OK"
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.
{
  "ResponseType": {
    "value": "ER"
  },
  "ResponseDetail": {
    "ErrorCode": "00068",
    "ErrorDesc": "Usuario ya existe.",
    "ErrorType": "OUD"
  }
}

> Diagram of sequence.

-Cards Update - Day Cycle(CambioFechaPagoTC).

Description:

This service allows you to modify the billing cycle of a credit card.

Path:

PUT: /cards-management/v1/card-updates/cycle-date

Headers:

Body:

> Mapping request:

> Request Example:

{
  "depAcctTrnRec": {
    "depAcctId": {
      "acctId": "789456123"
    },
    "daysCycle": "1",
    "contactInfo":{
      "emailAddr": "example@example.com",
      "cellPhone":"31111111111"
    }
  },
  "govIssueIdent": {
    "identSerialNum": "1234567890"
  }
}

> Response Example:

{
    "responseType": {
        "value": "OK"
    }
}

> Response Error Example:

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the follogin structur.
{
    "responseType": {
        "value": "ER400"
    },
    "responseDetail": {
        "errorCode": "01074",
        "errorDesc": "El numero de periodos transcurridos entre la fecha hoy y el ultimo cambi.",
        "errorType": ""
    }
}

Errors Code:

Diagram of sequence.

-Modify Credit Card Deadlines

Description:

This service allows you to modify the payments and advances deadlines of a credit card

Path:

PUT: /cards-management/v1/credit-card/deadlines

Headers:

Body:

> Mapping request:

> Request Example:

{
  "cardAcctId":{
    "acctId": "5470610024022374",
    "term": [
      {
        "sequence": "12345678",
        "numAsignInstallments": "01"
      },
      {
        "sequence": "87654321",
        "numAsignInstallments": "02"
      },
      {
        "sequence": "56781234",
        "numAsignInstallments": "01"
      }
    ]
  }
}

> Response Example:

{
    "responseType": {
        "value": "OK"
    }
}

> Response Error Example:

Additional to the error code of APIKit this resource has some custom errors code or bussines errors and all errors used the follogin structur.
{

    "responseType": {
        "value": "ER"
     },
    "responseDetail": {
        "errorCode": "00001",
        "errorDesc": "No se puede enviar esa cantidad de registros por pagina",
        "errorType": "OCP"
    }
}

Errors Code: