bcs-transfers-management-api-services

API INFORMATION

Title: bcs-transfers-management-api-services

Version: 1.0.39

Protocols: HTTPS

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

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

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

DOWLOAD RAML

DESCRIPTION

The api will offer the consumers to create transaction, consult fees for transfers and all related to transfers.:

Summary

-Transfers.

Description: This resource management 3 kinds of transfers own, third parties, Interbank.

Path:

/transfers-management/v1/transfers

Transfers of type own.

Request information:

refId: Deal Reference.

xFerRec: Transfer record.

 categCode: Transfer type

custPayeeInfo: Contains information about documents.

 refId: Document number
 govIssueIdent: Identification given by the local government
     govIssueIdentType: Type of customer identification.
     identSerialNum: Number customer Identification

fee: Commission value.

 curAmt: Contains information of amount.
      amt: Amount.

xFerInfo: Transfer Information.

 depAcctIdFrom: Source account information.
    acctId: Account ID.
 processingCode: Commission code.
 amt: Amount of transfer.
 desc: Concept.
 bankId: Code that identifies the bank.
 depAcctIdTo: Destination account information.
     acctId: Account ID
     acctType: Account type
 xFerId: Funds Transfer Identifier.
 origDt: Transaction date.

bankInfo: Contains information of Origin office code and Destination office code.

 branchIdFrom: Origin office code.
 branchIdTo: Destination office code.

Response information:

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "refId":"APII2223326017219999"
}

> 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.

####

##

Transfers of type third parties.

Request information:

refId: Deal Reference.

xFerRec: Transfer record.

 categCode: Transfer type

custPayeeInfo: Contains information about documents.

refId: Document number.

fee: Commission value.

 curAmt: Contains information of amount.
      amt: Amount.

xFerInfo: Transfer Information.

 personName: Holder name.
    fullName: Full name.
 depAcctIdFrom: Source account information.
    acctId: Account ID.
 processingCode: Commission code.
 amt: Amount of transfer.
 desc: Concept.
 bankId: Code that identifies the bank.
 depAcctIdTo: Destination account information.
     acctId: Account ID
 xFerId: Funds Transfer Identifier.
 origDt: Transaction date.

bankInfo: Contains information of Origin office code and Destination office code.

 branchIdFrom: Origin office code.
 branchIdTo: Destination office code.

Response information:

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "refId":"APII2223326017219999"
}

> 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.

####

##

Transfers of type Interbank.

Request information:

refId: Deal Reference.

xFerRec: Transfer record.

 categCode: Transfer type

custPayeeInfo: Contains information about documents.

 refId: Document number
 govIssueIdent: Identification given by the local government
     govIssueIdentType: Type of customer identification.
     identSerialNum: Number customer Identification

fee: Commission value.

 curAmt: Contains information of amount.
      amt: Amount.

xFerInfo: Transfer Information.

 personName: Holder name.
    fullName: Full name.
 depAcctIdFrom: Source account information.
    acctId: Account ID.
 processingCode: Commission code.
 pseTrnCode:  PSE transaction code.
 amt: Amount of transfer.
 desc: Concept.
 bankId: Code that identifies the bank.
 depAcctIdTo: Destination account information.
     acctId: Account ID
     acctType: Account type
 xFerId: Funds Transfer Identifier.
 origDt: Transaction date.

bankInfo: Contains information of Origin office code and Destination office code.

 branchIdFrom: Origin office code.
 branchIdTo: Destination office code.

Response information:

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "refId":"APII2223326017219999"
}

> 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.

####

##

-Error codes for any type transfers.

-Fees.

Description: This service allows you to generate transfers.

Path:

/transfers-management/v1/fees

Request information:

-----------------------------------------------------------------------------------------------------------------------------------------

Considerations:

To calculate commission commission code (xFerInfo.processingCode ) :

depAcctIdFrom: Source account information.

 depAcctId:  Account ID
     acctId: Account number

depAcctIdTo: Destination account information.

 depAcctId:  Account ID
     acctId: Account number

xFerInfo: Contains information about documents.

 processingCode: Commission code (for X-Invoker-Channel = 007 and X-Invoker-subChannel= 06 send value 77134).
 curAmt: Contains information of amount.
      amt: Amount.

Response information:

responseType: Source account information.

 value:

personName: Holder name.

 fullName:  Full name.

xFerInfo: Destination account information.

 processingCode:  Commission code

transaction: Tax payment information.

 curAmt: Contains information of amount.
      amt: Amount.

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "personName": {
        "fullName": "JOBS C"
    },
    "xFerInfo": {
        "processingCode": "372999"
    },
    "transaction": {
        "curtAmt": {
            "amt": 0
        }
    }
}

> Example response Error.

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"
    }
}

> Errors Code.

> Diagram of sequence.

####

##

Transfers of Operation using advance Credit Card and Revolving Credit .

Request information:

xFerRec: Transfer record.

 categCode: Transfer type = CCR (Required)

refId: Deal Reference.(Required

bankInfo: Contains information of Origin office code and Destination office code.

  branchIdTo: Destination office code. (Required)

xFerInfo: Transfer Information.

xFerId: Funds Transfer Identifier. (Required)
    acctId: Account ID (for credit card send encrypted data*). (Required)
    acctType: Account type (ej. CCA , RLA ) (Required)
depAcctIdTo: Destination account information.
    acctId: Account ID(Required)
    acctType: Account type (ej. SDA, DDA )(Required)
amt: Amount of transfer.(Required)
numberOfInstallments: Number of months for the term. (Required)
approvalId: Challenge authorization number (op)

custPayeeInfo: Contains information about customer information.

  govIssueIdent : Contains information about GovIssueIdent
     govIssueIdentType: Type of customer identification. (Required)
     identSerialNum: Number customer Identification. (Required)

> Body request example:.

{
  "xFerRec": {
    "categCode": "CCR"
  },
  "refId": "APII2377331380587280",
  "xFerInfo": {
    "xFerId": "AV001",
    "depAcctIdFrom": {
      "acctId": "cecdea9ea716f0948a508c",
       "acctType": "RLA"
       },
   "depAcctIdTo": {
      "acctId": "57172460999",
      "acctType": "SDA"
     },
    "amt": 1044000.00,
    "numberOfInstallments": 12
  },
  "custPayeeInfo": {
    "govIssueIdent": {
      "identSerialNum": "1234569999",
      "govIssueIdentType": "CC"
    }
  }
}

Response information:

> Response 201.

{
    "responseType": {
        "value": "OK"
    },
    "xFerInfo":{
        "approvalId":"324D1D"
    },
    "refId":"APII2223326017219999"
}

> Example response Error.

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": "00014",
        "errorDesc": "Tarjeta de Credito o Credito Rotativo No Existe",
        "errorType": "OPC"
    }
}

> Errors Code.

> Diagram of sequence.

##

Transfers of operation investment fund .

Request information:

refId: Deal Reference.

xFerRec: Transfer record.

 categCode: Transfer type = TFI (Required)

xFerInfo: Transfer Information.

depAcctIdFrom: Source account information.
    acctId: Origin product number (Required)
    acctType: Account type (ej. OFA, SDA , DDA ) (Required)
amt: Amount of transfer.(Required)
xFerId: Funds Transfer Identifier. (Required)
origDt: Transaction date (Required)
depAcctIdTo: Destination product number.
    acctId: Account ID(Required)
    acctType: Account type (ej. OFA, SDA , DDA)(Required)
flagTradeType: Flag Trade Type (opt)

approvalId: Challenge authorization number (opt)

bankInfo: Contains information of Origin office code and Destination office code.

  branchIdFrom: Contains information of destination office code. (opt)

refId: Document number . (Required)

workingDayFrame: Contains information of workday. (opt)

> Body request example:.

{
  "xFerRec": {
    "categCode": "TFI"
   },
  "xFerInfo": {
    "depAcctIdFrom": {
       "acctId": "24517151999",
       "acctType": "OFA"
    },
    "amt": 1044000.00,
    "xFerId": "AV001",
    "origDt": "2015-07-04T21:00:00",
   "depAcctIdTo": {
     "acctId": "57172460999",
     "acctType": "SDA"
   },
   "flagTradeType": false
  },
 "bankInfo": {
   "branchIdFrom": "0148"
   },
  "refId": "APII2223326017219999"
}

Response information:

> Response 201.

{
    "responseType": {
        "value": "OK"
    },
    "refId":"APII2223326017219999"
}

> Example response Error.

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": "00003",
        "errorDesc": "No hay matricula vigente en BMRS",
        "errorType": "RNE"
    }
}

> Errors Code.

####

> Diagram of sequence.

-------------------------------------Immediate Transfers (Transfiya) - operations ------------------------------------------------

Considerations:

To calculate commission commission code in /transfers-management/v1/fees (xFerInfo.processingCode ) for operations that use fee.curAmt.amt (commission value) :

------------------------------------------------------------------------------------------------------------------------------------------

-(1) Consult Enrollment .

Description: This resource manages the operation to obtain enrollment.

Path [GET]:

/transfers-management/v1/transfiya/enrollment/{identserialnum}?govIssueIdentType={govIssueIdentType}

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

URI parameters

identSerialNum: Identification number (Required)

Query parameters

govIssueIdentType: Type of identification issued by the government of the country (Required)

cellPhone: Mobile number of the registered account.. (Optional)

Response information:

responseType: Response type object.

 value: Response Value

personInfo: Information about a person

cellPhone:  Cell phone number.

depAcctId: ontains information related to savings account product.

acctId:  Identifier of an account.

> Example response 200.

{
    "responseType": {
        "value": "OK"
    },
    "personInfo": {
        "cellPhone": "3017561255"
    },
    "depAcctId": {
        "acctId": "21002908664"
    }
}

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al lmmite permitido",
    "errorType": "APL"
  }
}

-(2) Create - Update enrollment .

Description: With this resource you can create or update an enrollment.

Path [POST]:

/transfers-management/v1/transfiya/enrollment

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

Request information (Body):

govIssueIdent: Transfer record.

   identSerialNum: Contains information of number customer Identification. (Required)
   govIssueIdentType: Contains information of type of customer identification. (Required)
   cellPhone: Contains information of user's cell phone number. (Required)

xFerInfo: xFerInfo object.

depAcctIdFrom: depAcctIdFrom object.
    acctId: Account number to register in ach. (Required)

transfiyaOperationType: Contains informatin of transfiyaOperationType , enum : [ Create , Modify ] (If it is not sent, the default value is: Create ) (Optional)

deviceFingerPrint: Contains informatin of component where the operation is performed (ACH FingerPrint).(Required)

> Body request example:.

{
  "govIssueIdent": {
    "identSerialNum": "51434566546",
    "govIssueIdentType": "CC",
    "cellPhone":"2334545646"
   },
  "xFerInfo": {
    "depAcctIdFrom": {
       "acctId": "24517151999"
    }
   },
   "transfiyaOperationType": "Create",
   "deviceFingerPrint":"{\"Geolocation\":{\"city\":\"Bogota\",\"country\":\"Colombia\",\"ip\":\"120.243.57.210\",\"isp\":\"LevS.A\"},\"Hash\":{\"id\":\"26bdb237b9d81404702589e4c385b5472e4fe405b733e582ef97fa5a28fe07e0\"},\"General\":{\"deviceId\":\"daf1895883e4a82c42e6c0c597662588\",\"hostname\":\"Chrome\",\"macAddress\":\"Windows\",\"passiveId\":\"\"}}"
}

Response information:

responseType: Response type object.

 value: Response Value

> Response 201.

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

> Example response Error.

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": "20001",
        "errorDesc": "MATRICULA INEXISTENTE",
        "errorType": "RNE"
    }
}

-(3) Check recent transfers. .

Description: With this resource you can obtain the cell phone numbers of recent transfers

Path [GET]:

/transfers-management/v1/transfiya/transfers/{cellphone}/recent

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

URI parameters

cellphone: Origin cell phone number . (Required)

Query parameters

totalRecords: Total Number of Records (If it is not sent, the default value is: 1 ) (Optional)

recordsXPage: Number of Records Returned (If it is not sent, the default value is: 10 ) (Optional)

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: xFerInfo object.

 depAcctIdTo: depAcctIdTo object
        cellPhone: cell phone.

> Example response 200.

{
    "responseType": {
        "value": "OK"
    },
    "xFerInfo": [
        {
            "depAcctIdTo": {
                "cellPhone": "3204633555"
            }
        },
        {
            "depAcctIdTo": {
                "cellPhone": "3208824555"
            }
        },
        {
            "depAcctIdTo": {
                "cellPhone": "322802455"
            }
        }
    ]
}

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al lmmite permitido",
    "errorType": "APL"
  }
}

###

-(4) Send Money.

Description: With this resource you can send money ( to 6- Accept Money).

Path [POST]:

/transfers-management/v1/transfiya/credit

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

Request information (Body):

xFerInfo: xFerInfo object

   depAcctIdFrom: depAcctIdFrom object. (Required)
        acctId: Contains information of registered account number. (Required)
        cellPhone:  Contains information of origin User's cell phone number. (Required)
   depAcctIdTo: (Required)
        cellPhone: Contains information of destination user's cell phone number.(Required)

   amt: Contains information of ammount. (Required)
   desc: Contains information of description. (Required)

fee: fee object.

curAmt: curAmt object. (Required)
     amt: Contains information of commission value. (Required)

deviceFingerPrint: Contains information of the component where the operation is performed (ACH FingerPrint) .(Required)

> Body request example:.

{
  "xFerInfo": {
    "depAcctIdFrom": {
      "acctId": "24517151999",
      "cellPhone": "55677878"
    },
    "depAcctIdTo": {
      "cellPhone": "55677878"
    },
    "amt": 5677.23,
    "desc": "Transfer to phone"
  },
  "fee": {
    "curAmt": {
      "amt": 0
    }
  },
  "deviceFingerPrint": "{\"Geolocation\":{\"city\":\"Bogota\",\"country\":\"Colombia\",\"ip\":\"190.217.17.210\",\"isp\":\"Level3ColombiaS.A\"},\"Hash\":{\"id\":\"26bdb237b9d81404702589e5c384b5472e4fe405b733e582ef97fa5a28fe07e0\"},\"General\":{\"deviceId\":\"daf1895883eda82c45e6c0c597662588\",\"hostname\":\"Chrome\",\"macAddress\":\"Windows\",\"passiveId\":\"\"}}"
}

###

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: xFerInfo object.

pseTrnCode: Transaction identifier given by ach

> Example response 201.

{
    "responseType": {
        "value": "OK"
    },
    "xFerInfo":{
        "pseTrnCode":"6dGl2pEs3bra47Bz3"
    }
}

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al lmmite permitido",
    "errorType": "APL"
  }
}

-(5) Consult pending transfers to receive .

Description: With this resource you can obtain the list of transfers to receive.

Path [GET]:

/transfers-management/v1/transfiya/transfers/{cellphone}/pending/get

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

URI parameters

cellphone: Destination moviel phone . (Required)

Query parameters

initialRecord: InitialRecord for consult (If it is not sent, the default value is: 1 ) (Optional)

recordsXPage: Number of Records Returned (If it is not sent, the default value is: 10 ) (Optional)

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: xFerInfo object.

depAcctIdTo: Destination account information

cellPhone: Cell phone number.

curAmt: Contains a list all the data of the different balance e.g. Total balance , Available Balance , Exchange Balance , Pocket Balance,Total contingent withholding, Credit saving guarantee.

amt: Value to send.

desc: Concept of tranfers.

pseTrnCode: Transaction identifier given by ach

> Example response 200.

{
 "responseType": {
        "value": "OK"
    },
  "xFerInfo": [
    {
      "depAcctIdTo": {
        "cellPhone": "3208824364"
      },
      "curAmt": {
        "amt": 2000.00,
        "desc": "envio"
      },
      "pseTrnCode": "6dGl5pEsSbrar7Bz3"
    },
    {
      "depAcctIdTo": {
        "cellPhone": "3208824364"
      },
      "curAmt": {
        "amt": 2000.00,
        "desc": "envio"
      },
      "pseTrnCode": "6dGl5pEsSbrar7Bz3"
    }
  ]
}

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al lmmite permitido",
    "errorType": "APL"
  }
}

- (6) Accept money.

Description: With this resource you can accept money (from 4 - Send money).

Path [PUT]:

/transfers-management/v1/transfiya/transfers/agree

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

Request information (Body):

xFerInfo: xFerInfo object

   pseTrnCode: Contains information of transaction ID. (Required)
   depAcctIdFrom: depAcctIdFrom object. (Required)
        acctId: Contains information of registered account number. (Required)
        cellPhone:  Contains information of origin User's cell phone number. (Required)
   depAcctIdTo: (Required)
        cellPhone: Contains information of destination user's cell phone number. (Required)

   amt: Contains information of ammount. (Required)
   desc: Contains information of description. (Required)

fee: fee object.

curAmt: curAmt object. (Required)
     amt: Contains information of commission value. (Required)

flagTransferAccept: Contains information of Flag in which it is sent if you want to accept or reject the money transfer. [ Accept , Reject , ToBlock ] (Required)

flagEstablishTrust: Contains information of flag in which a record is marked as a trusted link, to perform operations without acceptance by any origin or destination. [ true , false] (Required)

deviceFingerPrint: Contains information of the component where the operation is performed (ACH FingerPrint) .(Required)

> Body request example:.

 {
  "xFerInfo": {
    "pseTrnCode": "6dG45pEs5brar7Bz3",
    "depAcctIdFrom": {
      "acctId": "24517151999",
      "cellPhone": "5567787448"
    },
    "depAcctIdTo": {
      "cellPhone": "5567766878"
    },
    "amt": 45677.23,
    "desc": "Transfer to phone"
  },
  "fee": {
    "curAmt": {
      "amt": 0
    }
  },
  "flagTransferAccept": "Accept",
  "flagEstablishTrust": true,
  "deviceFingerPrint": "{\"Geolocation\":{\"city\":\"Bogota\",\"country\":\"Colombia\",\"ip\":\"190.217.17.210\",\"isp\":\"Level3ColombiaS.A\"},\"Hash\":{\"id\":\"26bdb237b9d81404702589e5c384b5472e4fe405b733e582ef97fa5a28fe07e0\"},\"General\":{\"deviceId\":\"daf1895883eda82c45e6c0c597662588\",\"hostname\":\"Chrome\",\"macAddress\":\"Windows\",\"passiveId\":\"\"}}"
}

Response information:

> Response 201.

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

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al lmmite permitido",
    "errorType": "APL"
  }
}

-(7) Request Money

Description: With this resource you can request money (to 9- Accept send money).

Path [POST]:

/transfers-management/v1/transfiya/request-money

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

URI parameters

acctid: Registered account number. (Required)

Request information (Body):

xFerInfo: xFerInfo object

   depAcctIdFrom: depAcctIdFrom object. (Required)
        cellPhone:  Contains information of origin cell phone number. (Required)
   depAcctIdTo: (Required)
        cellPhone: Contains information of destination user's cell phone number.  (Required)

   amt: Contains information of value to send.(Required)
   desc: Contains information of description. (Required)

fee: fee object.

curAmt: curAmt object. (Required)
     amt: Contains information of commission value. (Required)

deviceFingerPrint: Contains information of the component where the operation is performed (ACH FingerPrint) .(Required)

> Body request example:.

{
  "xFerInfo": {
    "depAcctIdFrom": {
      "cellPhone": "5569875258"
    },
    "depAcctIdTo": {
      "cellPhone": "5589568788"
    },
    "amt": 5677.23,
    "desc": "Transfer to phone"
  },
  "fee": {
    "curAmt": {
      "amt": 0
    }
  },
  "deviceFingerPrint": "{\"Geolocation\":{\"city\":\"Bogota\",\"country\":\"Colombia\",\"ip\":\"190.217.17.210\",\"isp\":\"Level3ColombiaS.A\"},\"Hash\":{\"id\":\"26bdb237b9d81404702589e5c384b5472e4fe405b733e582ef97fa5a28fe07e0\"},\"General\":{\"deviceId\":\"daf1895883eda82c45e6c0c597662588\",\"hostname\":\"Chrome\",\"macAddress\":\"Windows\",\"passiveId\":\"\"}}"
}

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: xFerInfo object.

 pseTrnCode: Transaction identifier given by ach *

> Response 201.

{
    "responseType": {
        "value": "OK"
    },
    "xFerInfo":{
        "pseTrnCode":"6dGl2pEs3bra47Bz3"
    }
}

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al lmmite permitido",
    "errorType": "APL"
  }
}

-(8) Consult pending transfers send

Description: With this resource you can obtain the list of transfers to send.

Path [GET]:

/transfers-management/v1/transfiya/transfers/{cellPhone}/pending/send

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

URI parameters

cellphone: Origin cellphone (Required)

Query parameters

initialRecord: initial registration (If it is not sent, the default value is: 1 ) (Optional)

totalRecords: Number of Records Returned (If it is not sent, the default value is: 10 ) (Optional)

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: List of transfers

depAcctIdTo: Destination account information
   cellPhone:  Contains information of Destination Cell phone number
curAmt:  Contains a list all the data of the different balance e.g. Total balance , Available Balance , Exchange Balance , Pocket Balance,Total contingent withholding, Credit saving guarantee.
  > amt:  Value to send.
  > desc:  Concept of tranfers.

pseTrnCode:  Contains information of  transaction identifier given by ACH

> Example response 200.

{
  "responseType": {
    "value": "OK"
  },
  "xFerInfo": [
    {
      "depAcctIdTo": {
        "cellPhone": "5767867567"
      },
      "curAmt":{
        "amt": 768.10,
        "desc": "Money to "
       },
      "pseTrnCode": "6dG45pEs5brar7Bz8"
    },
    {
      "depAcctIdTo": {
        "cellPhone": "5745645567"
      },
      "curAmt":{
        "amt": 678.10,
      "desc": "Money to "
      },
      "pseTrnCode": "6dG43pEs5brar7Bz3"
    },
    {
      "depAcctIdTo": {
        "cellPhone": "5789567245"
      },
      "curAmt":{
        "amt": 454.10,
        "desc": "Money to "
      },
      "pseTrnCode": "6dG48pEs5brar7Bz1"
    }
  ]
}

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al lmmite permitido",
    "errorType": "APL"
  }
}

-(9)Accept send money

Description: With this resource you can accept send money (from 7 - Request money).

Path [PUT]:

/transfers-management/v1/transfiya/credit/agree

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

Request information (Body):

xFerInfo: xFerInfo object

pseTrnCode:  Contains information of  transaction identifier given by ACH *
depAcctIdFrom: depAcctIdFrom object. (Required)
        acctId: Contains information of registered account number. (Required)
        cellPhone:  Contains information of origin cell phone number. (Required)
   depAcctIdTo: (Required)
        cellPhone: Contains information of destination user's cell phone number.  (Required)
   amt: Contains information of value to send.(Required)
   desc: Contains information of description. (Required)
   flagTransferAccept: Contains information of Flag in which it is sent if you want to accept or reject the money transfer. ( Accept , Reject , ToBlock) (Required)

fee: fee object.

curAmt: curAmt object. (Required)
     amt: Contains information of commission value. (Required)

tx:Transaction Information

id: Transaction ID (Required)

deviceFingerPrint: Contains information of the component where the operation is performed (ACH FingerPrint) .(Required)

> Body request example:.

  {
  "xFerInfo": {
    "pseTrnCode": "6dG45pEs5brar7Bz3",
    "depAcctIdFrom": {
      "acctId": "22875459846",
      "cellPhone": "5744564566"
    },
    "depAcctIdTo": {
      "cellPhone": "5778566766"
    },
    "amt": 20000.10,
    "desc": "Transfer to ",
    "flagTransferAccept": "Accept"
  },
  "fee": {
    "curAmt": {
      "amt": 40.10
    }
  },
  "tx": {
    "id": "100082"
  },
  "deviceFingerPrint": "{\"Geolocation\":{\"city\":\"Bogota\",\"country\":\"Colombia\",\"ip\":\"190.217.17.210\",\"isp\":\"Level3ColombiaS.A\"},\"Hash\":{\"id\":\"26bdb237b9d81404702589e5c384b5472e4fe405b733e582ef97fa5a28fe07e0\"},\"General\":{\"deviceId\":\"daf1895883eda82c45e6c0c597662588\",\"hostname\":\"Chrome\",\"macAddress\":\"Windows\",\"passiveId\":\"\"}}"
}

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: List of transfers

pseTrnCode:  Contains information of  transaction identifier given by ACH

> Example response 201.

  {
    "responseType": {
        "value": "OK"
    },
    "xFerInfo":{
        "pseTrnCode":"6dGl2pEs3bra47Bz3"
    }
}

> Example response Error.

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": "00050",
    "errorDesc": "Valor del plan menor al limite permitido",
    "errorType": "APL"
  }
}

-(10) Consult Trust Relationship

Description: With this resource you can obtain the list of consult Trust Relationship.

Path [GET]:

/transfers-management/v1/transfiya/account-relationships/{cellPhone}

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

URI parameters

cellphone: Origin cellphone (Required)

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: List of transfers

transaction: Transaction Object
   trnRqUid:  Transaction's ID

depAcctIdFrom: Origin account information
  cellPhone: Origin Cell phone number

depAcctIdTo: Destination account information.
  cellPhone: Destination Cell phone number

transfiyaOperationType: Determine if you have a trust relationship (Values [ A = Active , B = Blocked]).
startDt: Creation date.

> Example response 200.

{
  "responseType": {
    "value": "OK"
  },
  "xFerInfo": [
    {
      "transaction": {
        "trnRqUid": "29503d4b-6fe4-4b87-a29f-1412a07fbc7b"
      },
      "depAcctIdFrom": {
        "cellPhone": "574564556666"
      },
      "depAcctIdTo": {
        "cellPhone": "573564457766"
      },
      "transfiyaOperationType": "B",
      "startDt": "2022-05-05"
    },
    {
      "transaction": {
        "trnRqUid": "13703d4b-6fe4-4b87-a29f-1712a075bc3b"
      },
      "depAcctIdFrom": {
        "cellPhone": "5745678877"
      },
      "depAcctIdTo": {
        "cellPhone": "5735609896"
      },
      "transfiyaOperationType": "A",
      "startDt": "2022-05-05"
    }
  ]
}

> Example response Error.

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": "20001",
    "errorDesc": "Matricula inexistente",
    "errorType": "RGN"
  }
}

-(11) Manage Trust Relationship .

Description: With this resource you can manage trust relationships

Path [POST]:

/transfers-management/v1/transfiya/account-relationships

Headers

X-Ident-DeviceFingerPrint: Device Fingerprint (optional)

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

Headers Security

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

client_id: The Mule expression to use for obtaining the client ID from

client_secret: The Mule expression to use for obtaining the client secret from API requests

authorization: Used to send a valid OAuth 2 access token

Request information (Body):

xFerInfo [] : xFerInfo Array

   depAcctIdFrom: depAcctIdFrom object.
        cellPhone:  Contains information of origin cell phone number. (Required)
   depAcctIdTo:
        cellPhone: Contains information of destination user's cell phone number. (Required)

   transfiyaOperationType: Contains information of transfiyaOperationType [Enum:  Activate , Eliminate].(Required)

deviceFingerPrint: Contains information of the component where the operation is performed (ACH FingerPrint) .(Required)

> Body request example:

*Maximum size of trust relationships = 50 items.

{
  "xFerInfo": [
    {
      "depAcctIdFrom": {
        "cellPhone": "578956789878"
      },
      "depAcctIdTo": {
        "cellPhone": "568556677788"
      },
      "transfiyaOperationType": "Activate"
    },
    {
      "depAcctIdFrom": {
        "cellPhone": "585666677677"
      },
      "depAcctIdTo": {
        "cellPhone": "594566672323"
      },
      "transfiyaOperationType": "Eliminate"
    }
  ],
  "deviceFingerPrint": "{\"Geolocation\":{\"city\":\"Bogota\",\"country\":\"Colombia\",\"ip\":\"190.217.17.210\",\"isp\":\"Level3ColombiaS.A\"},\"Hash\":{\"id\":\"26bdb237b9d81404702589e5c384b5472e4fe405b733e582ef97fa5a28fe07e0\"},\"General\":{\"deviceId\":\"daf1895883eda82c45e6c0c597662588\",\"hostname\":\"Chrome\",\"macAddress\":\"Windows\",\"passiveId\":\"\"}}"
}

Response information:

responseType: Response type object.

 value: Response Value

xFerInfo: List of transfers

depAcctIdFrom: Origin account information
  cellPhone: Origin Cell phone number

depAcctIdTo: Destination account information.
  cellPhone: Destination Cell phone number

startDt: Creation date.

responseType: Response type object.
   value: Response Value

responseDetail: responseDetail object.
  errorCode: Error code.
  errorDesc: Error description.
  errorType: Error type.

> Example response 201.

{
  "responseType": {
    "value": "OK"
  },
  "xFerInfo": [
    {
      "depAcctIdFrom": {
        "cellPhone": "43464567676"
      },
      "depAcctIdTo": {
        "cellPhone": "43464566787"
      },
      "startDt": "2022-02-12",
      "responseType": {
        "value": "OK"
      },
      "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
      }
    }
  ]
}

> Example response Error.

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": "20001",
    "errorDesc": "Matricula inexistente",
    "errorType": "RGN"
  }
}

> Diagram of sequence for Immediate Transfers (Transfiya) all operations.

> Common errors codes (Immediate Transfers (Transfiya) ).

Pockets transfers.

/transfers-management/v1/transfers/pockets

-Pockets transfers .

Description: Pockets transfers

Path [POST]:

/transfers-management/v1/transfers/pockets

Request information (Body):

depAcctId: Account identification

   acctId: Product number

xFerInfo: Transfer Information

   amt: Amount
   flagTransfer: Transfer flag D : Transfer from transactional account to pocket - Debit, C: Pocket transfer to transactional account – Credit

branch: Information used to identify the bank

   branchId: Code of the office where you will collect the certification

> Body request example:

{
  "depAcctId": {
    "acctId": "240269999"
  },
  "xFerInfo": {
    "amt": 1000,
    "flagTransfer": "D"
  },
  "branch": {
    "branchId": "1102"
  }
}

Response information:

responseType: Response type object.

 value: Response Value

acctBal: Account balance

curAmt: contains the amount
  amt: Amount

> Example response 201.

{
    "responseType": {
        "value": "OK"
    },
    "acctBal": {
        "curAmt": {
            "amt": 5812025.20
        }
    }
}

> Example response Error.

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": "20001",
    "errorDesc": "Matricula inexistente",
    "errorType": "RGN"
  }
}

> Diagram of sequence for .... operations.

> Common errors codes (Immediate Transfers (Transfiya) ).

- Deposit

Description:

This service allows deposit

Path:

PUT: /transfers-management/v1/deposit:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "code": "123456789123456",
    "depAcctIdTo": {
      "acctId": "12321414"
    },
    "curAmt": {
      "amt": 99
    },
    "type": "Normal",
    "trnRqUID": "123456",
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "depAcctIdFrom": {
      "acctId": "12321414"
    }
  }
}

Response Body:

Success Response Example:

{
  "responseType": {
      "value": "OK"
  },
  "trn": {
    "personName": {
      "fullName": "full name"
    },
    "depAcctId": {
      "acctId": "12321414"
    },
    "approvalId": "Z69599FB119FB12927E1"
  }
}

Response Error Example:

{
    "responseType": {
        "value": "ER500"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

Diagram of sequence