bcs-payments-management-api-services

API INFORMATION

Title: bcs-payments-management-api-services

Version: 1.0.35

Protocols: HTTPS

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

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

URI Live: https://payments-management-api-services-prod.us-e1.cloudhub.io/payments-management/v1

DOWLOAD RAML

DESCRIPTION

The api will offer the consumers to check the amount to pay, make a payment and validate a payment.:

Summary

-Payments.

Description: This resource manage the three kinds of operations (consultUniquePayment, uniquePayment and validateUniquePayment).

Path:

/payments-management/v1/payments

Query parameters

operation: payments management operation.

• consultUniquePayment : Operation for consult payment unique
• uniquePayment: Operation for payment unique
• validateUniquePayment: Operation for validate payment unique

Consult payment unique.

Request information:

pmtInfo: Payment information object

 pmtCodServ: Agreement code.
 eanCode: Ean Code
 invoicePmtInfo: invoicePmtInfo Object
    pmtRefId: Contains information of reference 1.
    pmtRefid2: Contains information of reference 2.
    pmtRefId3: Contains information related to reference 3.
 minPmtCurAmt: Contains information of MinPmtCurAmt.
    amt: Amount.
 acctId: Identifier of an account or product.
 dueDt: Contains information of product expiration date.
 user: Contains information of user.
 transaction: Contains information related to number TX.
    trnRqUid: Transaction number.
 pmtType: Contains information of payment type [E,D,C,M,P]
 workingDayFrame: Contains information of the working day frame.
 devRec: Contains information of the device.
    devId: Contains information of device Id
 submitOffice: Contains information related to submit Office
    branchId: Contains information related to Office code from which the transaction originates.
 effDt: Contains information of Compensation date
 additionalAcctId: Contains information of Card number
 invoker: Contains information of invoker.
    refId: Contains information of TX Reference number
    terminalId: Contains information of terminal Id
 value: Contains information related to additional information.

Response information:

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "pmtInfo": {
        "pmtType": "PPP",
        "minPmtCurAmt": {
            "amt": "12764.00"
        },
        "totalCurAmt": {
            "amt": "24179.00"
        },
        "legalName": "JACINTA PAMELA BARBOZA VEL",
        "approvalId": "216466",
        "dueDt": "2021-10-19",
        "invoicePmtInfo": {
            "pmtRefId": "",
            "pmtRefId2": "",
            "pmtRefId3": "",
            "pmtRefId4": ""
        },
        "desc": "",
        "origDt": "2022-10-14",
        "availDt": "2022-10-14",
        "pmtCodServ": "15999991",
        "achCodServ": "",
        "agreement": {
            "flagAllowModValue": ""
        },
        "invoiceInfo": {
            "invoiceVouchNum": "",
            "invoiceCount": "00"
        },
        "value": "CR",
        "pmtInfoList": []
    }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
   "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00002",
      "errorDesc": "Factura vencida",
      "errorType": "INF"
   }
}

> Diagram of sequence.

####

Error codes.

Unique payment.

Request information:

pmtInfo: Payment information object

 pmtCodServ: Agreement code.
 pmtDescServ: Agreement name (optional).
 eanCode: Ean Code.
 invoicepmtInfo: invoicepmtInfo Object.
    pmtRefId: Contains information of reference 1.
    pmtRefId2: Contains information of reference 2.
    pmtRefId3: Contains information related to reference 3.
    pmtRefId4: Contains information related  to notification code.
 pmtType: Contains information of payment type [E,D,C,M,P].
 minPmtCurAmt: Contains information of MinPmtCurAmt.
    amt: Amount.
 totalCurAmt: Contains information of Total cur amount.
    amt: Amount.
 dueDt: Contains information of product expiration date.
 user: Contains information of user.
 transaction: Contains information related to number TX.
    trnRqUid: Transaction number.
    desc: Contains information of description Transaction description one.
 workingDayFrame: Contains information of the working day frame.
 devRec: Contains information of the device.
    devId: Contains information of device Id
 submitOffice: Contains information related to submit Office
    branchId: Contains information related to Office code from which the transaction originates.
 pmtStatus: Contains information of PmtStatus.
    pmtIsReverse: Contains information of pmtIsReverse (N = Normal , R = Reverse)
    clearingDays: Contains information of exchange days (check) 2 .
    chkNum: Contains information of check number 2.
    chkType: Contains information of check type 2 , L: Local  , R: (consignment) .
 acctId: Contains information of AcctId.
 flagRefOrInvoice: Indicator if the payment is by reference or invoice.
 refId: Contains information of Deal Reference.
 refId2: Contains information of Deal Reference 2.
 processId: Contains information of processId.
 availDt: Contains information of recording date of the transaction.
 desc: Contains information of description Transaction description two.
 clearingDays: Contains information of exchange days (check) .
 chkNum: Contains information of check number.
 chkType: Contains information of check type , L: Local  , R: (consignment) .
 bankId: Contains information of code of the originating Bank of the Check.
 flagForcPost: Contains information of behavior information flagForcPost.
 flagBranssup: Contains information of behavior information flagBranssup.
 flagChkRefId: Contains information of behavior information flagChkRefId
 flagDealMod: Contains information of flagDealMod.
 effDt: Contains information of Compensation date
 additionalAcctId: Contains information of Card number
 invoker: Contains information of invoker.
    refId: Contains information of TX Reference number
    terminalId: Contains information of terminal Id
 rejectCode: Contains information of rejectCode.
 sNinetyField: Contains information of s90Field.
 bankInfo: Contains information of bank information.
    bankId: Contains information of entity code (Financial Entity)
    Name: Contains information of name of the authorizing financial institution.
 approvalId: Contains information of authorization number given by the financial institution that
 invoiceInfo: Contains information of invoiceInfo object.
    effDt: Contains information of Compensation date
    invoiceVouchNum: Contains information of  unique invoice identifier.
 achCycle: Contains information of ACH service code .
 cusCode: Contains information of Unique Tracking Code (CUS) .
 achCodServ: Contains information of ACH service code  .
 value: Contains information related to additional information.

Response information:

> Response 201.

{
  "responseType": {
    "value": "OK"
  },
  "pmtInfo": {
    "pmtType": "PPP",
    "invoicePmtInfo": {
      "pmtRefId4 ": ""
    },
    "approvalId": "374423",
    "origDt": "2022-09-22",
    "availDt": "2022-09-22",
    "processId": "PU075",
    "itemGeneric1": "0280",
    "additionalAcctId": "",
    "legalName": "JACINTA PAMELA BARBOZA VEL",
    "value": "",
    "refId": "APII2265325483954029"
  }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
   "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "N3 ",
      "errorDesc": "N3- REF.TRANSAC.PARA NUEVAS NEGOC.DEBE SER UNICA",
      "errorType": "TRX"
   }
}

> Diagram of sequence.

####

Error codes.

Validate unique payment.

Request information:

pmtInfo: Payment information object

 pmtCodServ: Agreement code.
 eanCode: Ean Code
 invoicePmtInfo: invoicepmtInfo Object
    pmtRefId: Contains information of reference 1.
    pmtRefId2: Contains information of reference 2.
    pmtRefId4: Contains information related  to notification code.
 pmtType: Contains information of payment type [E,D,C,M,P]
 minPmtCurAmt: Contains information of MinPmtCurAmt.
    amt: Amount.
 totalCurAmt: Contains information of Total cur amount.
    amt: Amount.
 dueDt: Contains information of product expiration date.
 transaction: Contains information related to number TX.
    trnRqUid: Transaction number.
 submitOffice: Contains information related to submit Office
    branchId: Contains information related to Office code from which the transaction originates.
 agreement: Contains information of Agreement.
    flagAllowModValue: Contains information of flag allow modify value.
 processId: Contains information of Process Id.
 value: Contains information related to additional information.

Response information:

> Response 200.

{
   "responseType": {
      "value": "OK"
   },
   "pmtInfo":{
      "value": ""
   }
}

> Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
   "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "12027",
      "errorDesc": "FALTAN DATOS PARA EL PAGO",
      "errorType": "VAL"
   }
}

> Diagram of sequence.

####

Error codes.

-PSE.

Description: This resource manage the two operations to get and confirm PSE transactions.

Path:

/payments-management/v1/pse/trn/

- Get transaction information PSE by UUID (GET)

Description: This resource get information about the PSE transaction.

Path:

/payments-management/v1/pse/trn/{trnrquid}

URI parameters

trnrquid: Contains information related to UUID.

Response information:

Transaction: Contains information about the transaction

 trnrqUid: Contains information related to UUID

xferInfo: Contains information related to the transaction

status: Contains information about the status
cusCode: Contains information of trazability Code (CUS)
curAmt: Contains information of the transaction amount
   amt: Contains information related to the transaction value
fee: Contains information of the fee
   amt: Contains information related to the VAT value
achCodServ: Contains information related to the service code
url: Contains information related to entity URL
achCycle: Contains information related to transaction cycle
clientDt: Contains information related to solicitation date
desc: Contains information of payment detail
pmtRefId: Contains information of reference 1
pmtRefId2: Contains information of reference 2
pmtRefId3: Contains information of reference 3

entpr: Contains information related to the company

companyId: Contains information related to entity code

invoicePmtInfo: Contains information of the invoicePmtInfo

billerNum: Contains information related to the ticket Id

orgInfo: Contains information of the govIssueIdent

name: Contains information related to entity name

govIssueIdent: Contains information of the govIssueIdent

personType: Contains information related to person type:
                 - Natural (0)
                 - Legal (1)
identSerialNum: Contains information related to payer identification number
govIssueIdentType: Contains information related to payer identification type:
                 - RC: Registro civil (11)
                 - TI: Tarjeta de Identidad (12)
                 - CC: Cédula de ciudadanía (13)
                 - TE: Tarjeta de Extranjeria (21)
                 - CE: Cedula de Extranjería (22)
                 - NI: NIT (31)
                 - PA: Pasaporte (41)
                 - DE: Documento de Identificación Extranjero (42)

Body response example:

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "transaction": {
    "trnrqUid": "37838712718554537308490620097"
  },
  "xferInfo": {
    "status": "PENDING",
    "cusCode": "3065762",
    "curAmt": {
      "amt": 342000.00
    },
    "fee": {
      "amt": 100000.00
    },
    "achCodServ": "52456384",
    "url": "https://www.comercio.com.co/Transaction?ID=383912",
    "achCycle": "4",
    "clientDt": "2023-01-16",
    "desc": "Pago",
    "pmtRefId": "2334234",
    "pmtRefId2": "545645",
    "pmtRefId3": "435345345"
  },
  "entpr": {
    "companyId": "812345678"
  },
  "invoicePmtInfo": {
    "billerNum": 564634
  },
  "orgInfo": {
    "name": "Comercio Pruebas"
  },
  "govIssueIdent": {
    "personType": "Natural",
    "identSerialNum": "1116232178",
    "govIssueIdentType": "CC"
  }
}

> Errors.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "00001",
        "errorDesc": "Uuid no existe",
        "errorType": "RGN"
    }
}

####

> Diagram of sequence.

Error codes.

- Confirm transaction PSE (POST)

Description: This resource confirm the information about the PSE transaction.

Path:

/payments-management/v1/pse/trn/

Request information:

Transaction: Contains information about the transaction

trnrqUid: Contains information related to UUID

xferInfo: Contains information related to the transaction

status: Contains information about the status
pseTrnCode: PSE transaction code
endDt: Contains information of closing date
bankChannel: Contains information of Bank Channel
acctId: Account number

govIssueIdent: Contains information of the govIssueIdent

identSerialNum: Contains information related to user identification number
govIssueIdentType: Contains information related to user identification type:
                 - CC : Cédula de ciudadanía
                 - CE : Cédula de extranjería
                 - TI: Tarjeta de identidad
                 - NI: Número de identificación tributaria
                 - PE: Permiso especial de permanencia

Body request example:

{
    "transaction": {
          "trnrqUid": "28498521"
  },
      "xFerInfo": {
        "status": "OK",
        "pseTrnCode": "28498521",
        "endDt": "2022-07-05T01:05:10",
        "bankChannel": "BE",
        "acctId": "7890"
  },
      "govIssueIdent": {
        "identSerialNum": "1234567890",
        "govIssueIdentType": "CC"
  }
}

Body response example:

> Response 201.

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

> Errors.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "00001",
        "errorDesc": "Uuid no existe",
        "errorType": "RGN"
    }
}

> Diagram of sequence.

Error codes.

Códigos de Rechazo enviados a ACH

[Domiciliations operations]:

- Consult Domiciliations

Description: This resource is related to consult domiciliations with pagination.

Path [GET]:

/payments-management/v1/domiciliation/{identserialnum}

URI Parameter:

identserialnum: Contains information related to the customer identification. (Required)

Query Parameters:

govIssueIdentType: Contains information related to Type of customer identificationon: (Required)

CC: Citizenship Card ,

CE: Immigration ID ,

TI: Identity card ,

NI: NIT ,

PE: Special Stay Permit for Venezuelans

svcRqiId: Contains information related to Guid of the domiciled service. (Optional)

processId: Contains information related to Domiciliated service agreement number. (Optional)

pmtRefId: Contains information related to Payment reference. (Optional)

acctId: Contains information related to Account number associated with the direct debit. (Optional)

recordsxPage: Contains information related to Quantity Records. If the parameter is not sent, the api sets 10 (Optional)

initialRecord: Contains information related to Initial Registration. If the parameter is not sent, the api sets 1 (Optional)

Response information:

responseType:

  value: Response information

resultsPagesGeneric:

  totalRecords: Response informatContains information of Total number of existing records.
  recordsxPage: Response informatioContains information of Number of records returned in paging

totalRecords: Contains information of Number of direct debits in a registered state, associated with the entered ID.

entprAgreement []:

notify: Contains information of Indicates if Notify the Direct Debit Agent in the table is enabled :0 = NO , 1 = YES
operationType: Contains information of Indicates if the Debit Agent is enabled in the table: 0 = NO ,1 = YES
orgInfo: orgInfo object
   govIssueIdent: govIssueIdent object
      identserialnum: Contains information related to the identification (Originator Id ).
      govIssueIdentType: Contains information of Type of customer identification PE : Special Stay Permit (for Venezuelans)) , TI :Identity card ,CC : Citizenship Card , NI : NIT ,CE : Immigration ID
      emailAddr: Contains information of Email for domiciliatory table notifications.
      cellphone: Contains information of Phone for notifications address table.
   govOrgName: Contains information of Company name of the Originator.
category: Contains information of Agreement category.
processId: Contains information of Service GuID.
spName: Contains information of Name of the domiciled Service.
xFerInfo: xFerInfo object
  pmtRefId: Contains information of Payment reference name.
  pmtRefId2: Contains information of Additional reference name.
city:Contains information of Name of the city of the service.
acctType: Contains information of Account type.
status: Contains information of Enrollment Status (Cancelado ,Pendiente ,PendienteCancelacion ,Matriculado ,Rechazado)
startDt: Contains information of Registration date
numberOfInstallments: Contains information of Payments MadenumberOfInstallments
svcIdent: Contains information of Agreement number.
govIssueIdent: govIssueIdent object.
  identSerialNum: Contains information related to Identification number of the direct debit customer.
  govIssueIdentType: Contains information of Type of customer identification PE : Special Stay Permit (for Venezuelans)) , TI :Identity card ,CC : Citizenship Card , NI : NIT ,CE : Immigration ID
pmtRefId: Contains information of Payment reference for the domiciled service.
pmtRefId2: Contains information of Additional reference of the domiciled service.
name: Contains information of Name that the domiciliator assigns to the domiciled service.
acctId: Contains information of Account number of the direct debit client.
pmtType: Contains information if Indicates direct debit payment scheme :
        - Al Vencimiento
        - Dias Antes Del Vencimiento
        - Al Recibir Factura
        - Unknown * this value is presented only when flagNotify=1 *
daysBefore: This field indicates how many days before the expiration the direct debit payment is made. Values can be from 1 to 5. If not applicable, the return value is '0'.
condition: Contains information related to Indicates the payment condition :
        - Permanente
        - Hasta Fecha
        - Hasta N Pagos
        - Unknown: * this value is presented only when flagNotify=1 *
totalPmtCount: Contains information of Number of payments .* This field applies when condition = HastaNPagos * If not applicable, the return value is '0'
endDt: Contains information of Deadline ,* This field applies when condition = HastaFecha * .If not applicable, the returned value is the registration date of the direct debit.
flagAllowNotify: Contains information of Allow Notification ,Indicates that the client requires notification of direct debits: 0= No , 1= Yes.
typeTop: Indicates if the client stipulates a maximum value per month for direct debit payment.
maxCurAmt: maxCurAmt object.
  amt: Contains information of Maximum amount.
flagNotify: Indicates that the client only wants to be notified of the arrival of invoices 0= No , 1= Yes.

Response example:

> Response 200.

 {
  "responseType": {
    "value": "OK"
  },
  "resultsPagesGeneric": {
    "totalRecords": 5,
    "recordsxPage": 2
  },
  "totalRecords": 2,
  "entprAgreement": [
    {
      "notify": "0",
      "operationType": "1",
      "orgInfo": {
        "govIssueIdent": {
          "identSerialNum": "345435",
          "govIssueIdentType": "CC"
        },
        "govOrgName": "CLARO"
      },
      "category": "INMOBILIARIAS",
      "processId": "dd5-4d45-198-e54-693e",
      "spName": "CLARO",
      "xFerInfo": {
        "pmtRefId": "Numero de Referencia",
        "pmtRefId2": "Numero de Referencia 2"
      },
      "city": "BOGOTA",
      "acctType": "Ahorros",
      "status": "Pendiente",
      "startDt": "2023-04-04",
      "numberOfInstallments": "1",
      "svcIdent": "23455",
      "govIssueIdent": {
        "identSerialNum": "354456456",
        "govIssueIdentType": "CC",
        "emailAddr": "mail@email.com",
        "cellphone": "445666676"
      },
      "pmtRefId": "23223",
      "pmtRefId2": "4445",
      "name": "PRUEBA DOMI",
      "acctId": "54567",
      "pmtType": "Al Vencimiento",
      "daysBefore": "0",
      "condition": "permanente",
      "totalPmtCount": "1",
      "endDt": "2023-02-04",
      "flagAllowNotify": "0",
      "typeTop": "Monto Maximo",
      "maxCurAmt": {
        "amt": 50000
      },
      "flagNotify": "0"
    },
    {
      "notify": "0",
      "operationType": "1",
      "orgInfo": {
        "govIssueIdent": {
          "identSerialNum": "434345",
          "govIssueIdentType": "CC"
        },
        "govOrgName": "CLARO2"
      },
      "category": "INMOBILIARIAS2",
      "processId": "wqwedd5-4d5-198-e54-693e",
      "spName": "CLAROV",
      "xFerInfo": {
        "pmtRefId": "Numero de Referencia 1",
        "pmtRefId2": "Numero de Referencia 2"
      },
      "city": "MEDELLIN",
      "acctType": "Ahorros",
      "status": "Pendiente",
      "startDt": "2023-01-04",
      "numberOfInstallments": "1",
      "svcIdent": "23455",
      "govIssueIdent": {
        "identSerialNum": "354456456",
        "govIssueIdentType": "CC",
        "emailAddr": "examplemail@email.com",
        "cellphone": "445655666676"
      },
      "pmtRefId": "23223",
      "pmtRefId2": "4445",
      "name": "PRUEBA DOMI",
      "acctId": "54567",
      "pmtType": "Al Vencimiento",
      "daysBefore": "0",
      "condition": "permanente",
      "totalPmtCount": "1",
      "endDt": "2023-02-04",
      "flagAllowNotify": "0",
      "typeTop": "Monto Maximo",
      "maxCurAmt": {
        "amt": 6000
      },
      "flagNotify": "0"
    }
  ]
}

> Errors.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "SQLCODE",
        "errorDesc": "ERROR DE INICIO TP",
        "errorType": "TPS"
    }
}

Error codes.

> Diagram of sequence.

- Enable/Disable services (Domiciliation)

Description: This resource allows you to activate or deactivate a domiciled service.

Path [PUT]:

/payments-management/v1/domiciliation

Request information:

entprAgreement: (Required)

operationType: Contains information related to Type of operation to be performed (activate , deactivate) (Required)
svcIdent: Contains information related to domiciled service agreement code (Only required when in field flagNotify = false ) .(Optional)
acctId: Account number of domiciliator (Only required when in field flagNotify = false ). (Optional)
maxCurAmt:
   amt: Information related to value of the maximum monthly amount for direct debit payment (Only required when in field flagNotify = false ) (Optional)
flagNotify: Contains information of the client if only wants to be notified of the arrival of the invoices. (Required)
processId: Contains information of GUID of the service. (Required)

govIssueIdent: (Required)

identSerialNum: Contains information related to customer identification. (Required)
govIssueIdentType: Type of customer identification : (Required)
                     PE : Special Stay Permit (for Venezuelans)) ,
                     TI :Identity card ,
                     CC : Citizenship Card ,
                     NI : NIT ,<br>
                     CE : Immigration ID
contactInfo:
   emailAddr: Contains information related to contactInfo. (Optional)
   cellPhone: CellPhone number. (Optional)

transaction: (Required)

refId: Direct debit payment reference. (Required)

Request information example:

  {
  "entprAgreement": {
    "operationType": "activate",
    "svcIdent": "54645656",
    "acctId": "34545645",
    "maxCurAmt": {
      "amt": 500
    },
    "flagNotify": true,
    "processId": "5ef-0f81-4705-54-10b59cd6"
  },
  "govIssueIdent": {
    "identSerialNum": "986659849",
    "govIssueIdentType": "CC",
    "contactInfo": {
      "emailAddr": "myemail@mail.com",
      "cellPhone": "3434456456"
    }
  },
  "transaction": {
    "refId": "7123"
  }
}

> Errors.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "SQLCODE",
        "errorDesc": "ERROR DE INICIO TP",
        "errorType": "TPS"
    }
}

Error codes.

> Diagram of sequence.

- Validate Domiciliation Registration (GET)

Description: This resource returns whether or not a domiciliation register exists

Path:

/payments-management/v1/domiciliation/validation/{acctid}

URI parameters

acctid: Contains information related to account number

Query parameters

svcident: Contains information related to agreement number

Response information:

entprAgreement: Contains information about the domiciliation registration

 flagExist:  Contains information about the existence of the domiciliation registration

Body response example:

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "entprAgreement":{
        "flagExist": false
    }
}

> Errors.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "02601",
        "errorDesc": "ERROR EJECUTANDO PROCEDIMIENTO ALMACENADO",
        "errorType": "DBA"
    }
}

####

> Diagram of sequence.

Error codes.

- Last Ten Domiciliation Payments (GET)

Description: This resource returns the last ten domiciliation payments

Path:

/payments-management/v1/domiciliation/payments/{identserialnum}

URI parameters

identserialnum: Contains information related the number customer Identification

Query parameters

govissueidenttype: Contains information related to the type of customer identification (NI, CC, TI, CE, PE)

Response information:

resultsPagesGeneric: Contains information about the ResultsPagesGeneric

 totalRecords:  Contains information about the total records

entprAgreement: Array that contains information about the ResultsPagesGeneric

 name:  Contains information related to service name
 transaction:  Contains information about the transaction
    pmtRefId:  Contains information about the main reference
    pmtRefId2:  Contains information about the secondary reference
    amt:  Contains information about the amount
    processDate:  Contains information about the payment date
    trnSrc:  Contains information related to the invoice origin ("BCSC", "RedebanMulticolor")
 trnSrcInfo:  Contains information about the transaction source
    channel:  Contains information about the channel
    name:  Contains information about the channel name

Body response example:

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "resultsPagesGeneric": {
        "totalRecords": 10
    },
    "entprAgreement": [
        {
            "name": "DUQUESA_MULTI CC11897",
            "transaction": {
                "pmtRefId": "123370",
                "pmtRefId2": null,
                "amt": 316400.00,
                "processDate": "2020-02-27",
                "trnSrc": "BCSC"
            },
            "trnSrcInfo": {
                "channel": "07",
                "name": "APLICACION MOVIL BANCA PERSONAS"
            }
        },
        {
            "name": "DUQUESA_MULTI CC11897",
            "transaction": {
                "pmtRefId": "123370",
                "pmtRefId2": null,
                "amt": 4108.00,
                "processDate": "2020-02-14",
                "trnSrc": "BCSC"
            },
            "trnSrcInfo": {
                "channel": "07",
                "name": "APLICACION MOVIL BANCA PERSONAS"
            }
        },
        {
            "name": "DUQUESA_MULTI CC11897",
            "transaction": {
                "pmtRefId": "123370",
                "pmtRefId2": null,
                "amt": 5408.00,
                "processDate": "2020-02-13",
                "trnSrc": "BCSC"
            },
            "trnSrcInfo": {
                "channel": "07",
                "name": "APLICACION MOVIL BANCA PERSONAS"
            }
        },
        {
            "name": "AGUA Y ALCANTARILLADO DE BOGOTA",
            "transaction": {
                "pmtRefId": "38953411212",
                "pmtRefId2": null,
                "amt": 329220.00,
                "processDate": "2019-08-29",
                "trnSrc": "RedebanMulticolor"
            },
            "trnSrcInfo": {
                "channel": "01",
                "name": "CAJEROS AUTOMATICOS PROPIOS"
            }
        },
        {
            "name": "CLARO",
            "transaction": {
                "pmtRefId": "404011",
                "pmtRefId2": null,
                "amt": 18000.00,
                "processDate": "2019-07-19",
                "trnSrc": "RedebanMulticolor"
            },
            "trnSrcInfo": {
                "channel": "14",
                "name": "PROGRAMACION DE PAGOS"
            }
        },
        {
            "name": "COLEGIO JONATHAN SWIFT",
            "transaction": {
                "pmtRefId": "125431430330794",
                "pmtRefId2": null,
                "amt": 4644.00,
                "processDate": "2019-05-30",
                "trnSrc": "BCSC"
            },
            "trnSrcInfo": {
                "channel": "07",
                "name": "INTERNET BANCA PERSONAL"
            }
        },
        {
            "name": "COLEGIO JONATHAN SWIFT",
            "transaction": {
                "pmtRefId": "10011",
                "pmtRefId2": null,
                "amt": 225110.00,
                "processDate": "2019-05-24",
                "trnSrc": "BCSC"
            },
            "trnSrcInfo": {
                "channel": "07",
                "name": "INTERNET BANCA PERSONAL"
            }
        },
        {
            "name": "COLEGIO JONATHAN SWIFT",
            "transaction": {
                "pmtRefId": "10011",
                "pmtRefId2": null,
                "amt": 225110.00,
                "processDate": "2019-05-24",
                "trnSrc": "BCSC"
            },
            "trnSrcInfo": {
                "channel": "07",
                "name": "INTERNET BANCA PERSONAL"
            }
        },
        {
            "name": "COLEGIO JONATHAN SWIFT",
            "transaction": {
                "pmtRefId": "1356978411191",
                "pmtRefId2": null,
                "amt": 1000.00,
                "processDate": "2019-05-06",
                "trnSrc": "BCSC"
            },
            "trnSrcInfo": {
                "channel": "07",
                "name": "INTERNET BANCA PERSONAL"
            }
        },
        {
            "name": "EPM",
            "transaction": {
                "pmtRefId": "634879697",
                "pmtRefId2": null,
                "amt": 845388.91,
                "processDate": "2018-08-14",
                "trnSrc": "RedebanMulticolor"
            },
            "trnSrcInfo": {
                "channel": "01",
                "name": "CAJEROS AUTOMATICOS PROPIOS"
            }
        }
    ]
}

> Errors.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "20126",
        "errorDesc": "NO EXISTEN REGISTROS PARA LA CONSULTA",
        "errorType": "RGN"
    }
}

> Diagram of sequence.

Error codes.

- Get Contact Data (GET)

Description: This resource returns the domiciliation contact data

Path:

/payments-management/v1/domiciliation/contact/{identserialnum}

URI parameters

identserialnum: Contains information related the number customer Identification

Query parameters

govissueidenttype: Contains information related to the type of customer identification (NI, CC, TI, CE, PE)

Response information:

entprAgreement: Object that contains contact data information

  contactInfo: Contact Info Object
    emailAddr: Contact Email
    cellPhone: Contact CellPhone

Body response example:

> Response 200.

{
    "responseType": {
        "value": "OK"
    },
    "entprAgreement": {
        "contactInfo": {
            "emailAddr": "ppirbmemilio1@bancocajasocial.com",
            "cellPhone": "3165225790"
        }
    }
}

> Errors.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "20012",
        "errorDesc": "NO EXISTE EL DOMICILIADOR CONSULTADO",
        "errorType": "RGN"
    }
}

> Diagram of sequence.

Error codes.

Bills:

Path: /payments-management/v1/bills/

- Modify bill status (PUT):

Description: This service is used to modify the status of an invoice.

Path:

/payments-management/v1/bills/status:

Request information:

invoicePmtInfo: InvoicePmtInfo object
    invoiceInfo: InvoiceInfo object
        invoiceNum: Contains information related to the invoice identification
        status: Contains information related to the invoice status (Available, Processing)

Response information:

> Response 200.

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

> Error response.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    {
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "",
        "errorDesc": "",
        "errorType": ""
    }
}

> Diagram of sequence.

> Errors Code.

BCS Minisite Service

This service is exposed allows the web portal of the minisite to Consult the information of a specific transaction and confirm the final status of the same to the web service component of Banco Caja Social

-getTrxInformationPayMinisitioByUUID :

Path: /payments-management/v1/pse-minisite/trn/{trnrquid}

Method: GET

Description: For this service is the "WS Minisite" component validates the data received, verifies the status of the transaction and returns a response to the channel that made the consumption.

URI parameters

trnrquid: Contains information related to transaction number.( ej. 40582204652432563 ) (Required)

Query parameters

bankChannel: Contains information of bank through which the transaction is made. (Required)

 -businessBanking

 -personalBanking

Response information:

entprAgreement: Object that contains contact data information

 responseType: responseType Object
    value: Contains information of Reponse type
 xFerInfo: xFerInfo Object
    status : Contains information about Payment status on the bank's minisite. [OK ,PENDING ,ER]
    endDt : Contains information of date and time the transaction ends on the minisite .
    url :  Url where the client should be directed when the transaction is finished on the BCS minisite
    pseTrnCode : Authorization number ,Authorization code assigned by the bank when the transaction is completed successfully It is sent when xFerInfo.status
                 is OK.
    desc: Contains information about Merchant for which the transaction is made
    pmtRefId: Contains information of payment reference Id
    pmtRefId2: Contains information of payment reference Id 2
    pmtRefId3: Contains information of payment reference Id 3
    pmtRefId4: Notification Code
    curAmt: curAmt object
      amt: Contains information related to the transaction value
    flagHeader: Defines if the page header should be displayed depending on whether the transaction is made through the web page or the mobile app.
 transaction: transaction Object
    trnRquId: Contains information of transaction Number.
 orgInfo: orgInfo Object
    name: Contains information related to Trade name.
 pmtInfo: pmtInfo Object
    eanCode: Contains information of Ean Code.
    dueDt : Contains information of product expiration date.
    flagRefOrInvoice:  Contains information of indicator if the payment is by reference or invoice.
  invoicePmtInfo: invoicePmtInfo  Object
    billerNum:  Contains information related to the ticket Id
  entprAgreement: entprAgreement Object
    name: Contains information related to Agreement Name
    scvIdent: Contains information related to Convention Code.
    entprAgrmntType: Contains information related to type of collection.
    govIssueIdent: govIssueIdent  Object
      identSerialNum:  Contains information related to Company Mnemonic
      govIssueIdentType:  Contains information related Company Mnemonic

Body response example:

> Response 200.

{
  "responseType": {
    "value": "OK"
  },
  "responseDetail": {
    "errorType": "RGN",
    "errorCode": "00009",
    "errorDesc": "Tiempo de transacción excedido"
  },
  "xFerInfo": {
    "status": "OK",
    "endDt": "2022-07-05T01:05:10",
    "url": "https://www.comercio.com.co/Transaction?ID=383912",
    "pseTrnCode": "546567567",
    "desc": "Movist4r service",
    "pmtRefId": "2334234",
    "pmtRefId2": "545645",
    "pmtRefId3": "435345345",
    "pmtRefId4": "",
    "curAmt": {
      "amt": 342000
    },
    "flagHeader": "1"
  },
  "transaction": {
    "trnRquId": "APIE230455675597"
  },
  "orgInfo": {
    "name": "Comercio Pruebas"
  },
  "pmtInfo": {
    "eanCode": "77715542354",
    "dueDt": "2022-03-05",
    "flagRefOrInvoice": "1"
  },
  "invoicePmtInfo": {
    "billerNum": "564634"
  },
  "entprAgreement": {
    "name": "COLEGIO DOMAN",
    "scvIdent": "159654459",
    "entprAgrmntType": "REC",
    "govIssueIdent": {
      "identSerialNum": "344564645",
      "govIssueIdentType": "CC"
    }
  }
}

> Error response.

Additional the error code of APIKit this resource it has some custom errors code or business errors and all errors used the following structure.
{
    {
    "responseType": {
        "value": "ER"
    },
    "responseDetail": {
        "errorCode": "00004",
        "errorDesc": "Fondos Insuficientes",
        "errorType": "VAL"
    }
}

Error codes.

> Diagram of sequence.

####

confirmTrxPayMinisitio:

Path: /payments-management/v1/pse-minisite/trn

Method: PUT

Description: For WS Minisite component records the information received in the TRX_MINISITIO table in the corresponding database according to the bank through which the transaction is made.

Body request :

  transaction
    trnrqUid: Unique number assigned to the transaction by mipagoamigo. (Required)

  xFerInfo:
    status: Contains information about the transaction status [ok , error , pending]  (Required)
    endDt: Contains information of transaction end date. Format yyyy-MM-ddThh:mm:ss  (Required)
    pseTrnCode:  PSE transaction code  (Required)
    bankChannel:  Contains information of Bank Channel. [ businessBanking , personalBanking] (Required)

  responseDetail:  Required only when xFerInfo.status = "error"
    errorType:  Error type.
    errorCode:  Error code.
    errorDesc: Error description.

Body request example :

{
  "transaction": {
    "trnrqUid": "54562234"
  },
  "xFerInfo": {
    "status": "error",
    "endDt": "2023-04-04T01:05:10",
    "pseTrnCode": "43455645",
    "bankChannel": "businessBanking"
  },
  "responseDetail": {
    "errorType": "ER",
    "errorCode": "23443",
    "errorDesc": "Error description"
  }
}

Body response example:

> Response 201.

*Note: The communication is asynchronous and therefore the web portal of the Banco Caja Social Minisite does not expect a response, however, it has been decided to return a type of response from the OSB, this response indicates that the request has been sent without problem by part of the OSB. This response does NOT correspond to the confirmTrxPayMinisite response, only to the communication between it and the OSB.

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

Error codes.

> Diagram of sequence.

####

NotificationPayments:

Path: /payments-management/v1/payments/notifications

Method: POST

Description: Operation that notifies the payments of an account.

Body request :

  pmtInfo:
    pmtId: Identifier of the payment. (Required)
    pmtType: Payment type indicator. (Required)
    acctId: A data item containing a series of digits and/or characters which identify a customer account. Sometimes known as account number.
    origDt: Contains information of transaction origin date. Format yyyy-MM-dd  (Required)
    effDt: Contains information of transaction end date. Format yyyy-MM-dd  (Required)
    totalcurAmt:
        amt: Payment amount. (Required)
    notification:
        pmtType: Payment type. (Required)
            - RV: Reverso Pago.
            - RE: Pago Efectivo.
  govIssueIdent:
    identSerialNum: Contains information related to payer identification number.
    govIssueIdentType: Contains information related to payer identification type:
                 - RC: Registro civil.
                 - TI: Tarjeta de Identidad.
                 - CC: Cédula de ciudadanía.
                 - TE: Tarjeta de Extranjeria.
                 - CE: Cedula de Extranjería.
                 - NI: NIT.
                 - PA: Pasaporte.
                 - DE: Documento de Identificación Extranjero.

Body request example :

{
    "pmtInfo": {
        "pmtId": "2333",
        "pmtType": "EFEC",
        "acctId": "222",
        "origDt": "2023-05-02",
        "effDt": "2023-05-02",
        "totalcurAmt": {
            "amt": 589000.0
        },
        "notification": {
            "pmtType": "RE"
        }
    },
    "govIssueIdent": {
        "identSerialNum": "1129490946",
        "govIssueIdentType": "CC"
    }
}

Body response example:

> Response 201.

 {
  "pmtInfo": {
    "pmtId": "23232222",
    "acctId": "45344345354",
    "transaction": {
      "trnRqUid": "1234AF1232-E123",
      "desc": "Transaccion Exitosa"
    }
  }
}

Error codes.

> Diagram of sequence.

- Consult Own Payment

Description:

This service allows consult PP

Path:

POST: /payments-management/v1/consult-own-payment:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "code": "123456789123456",
    "refId": "12321414",
    "trnRqUID": "123456",
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "aditionalData": [
      {
        "name": "nombre referencia 1",
        "value":"0399200339917"
      },
      {
        "name": "nombre referencia 2",
        "value":"0399200339917"
      },
      {
        "name": "nombre referencia 3",
        "value":"0399200339917"
      }
    ],
    "govIssueIdentType": "CC",
    "identSerialNum": "1143935925"
  }
}

Response Body:

Success Response Example:

{
  "responseType": {
      "value": "OK"
  },
  "trn": {
    "personName": {
      "fullName": "full name"
    },
    "approvalId": "Z69599FB119FB12927E1",
    "minCurAmt": {
      "amt": 99
    },
    "totalCurAmt": {
      "amt": 99
    }
  }
}

Response Error Example:

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

Diagram of sequence

- Own Payment

Description:

This service allows PPP

Path:

POST: /payments-management/v1/own-payment:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "code": "123456789123456",
    "depAcctIdFrom": {
      "acctId": "12321414"
    },
    "trnRqUID": "123456",
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "type": "Normal",
    "refId": "123456",
    "aditionalData": [
      {
        "name": "Nombre referencia 1",
        "value":"Referencia de pago 1"
      },
      {
        "name": "Nombre referencia 2",
        "value":"Referencia de pago 2"
      },
      {
        "name": "Nombre referencia 3",
        "value":"Referencia de pago 3"
      }
    ],
    "totalCurAmt": {
      "amt": 99
    },
    "minCurAmt": {
      "amt": 99
    },
    "curAmt": {
      "amt": 99
    },
    "govIssueIdentType": "CC",
    "identSerialNum": "1143935925"
  }
}

Response Body:

Success Response Example:

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

Response Error Example:

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

Diagram of sequence

- Collection

Description:

This service allows Collection payment

Path:

POST:  /collections-management/v1/collection:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "code": "123456789123456",
    "depAcctIdFrom": {
      "acctId": "12321414"
    },
    "trnRqUID": "123456",
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "depAcctIdTo": {
      "acctId": "12321414"
    },
    "type": "Normal",
    "refId": "123456",
    "eanCode": "",
    "aditionalData": [
      {
        "name": "Nombre referencia 1",
        "value":"Referencia de pago 1"
      },
      {
        "name": "Nombre referencia 2",
        "value":"Referencia de pago 2"
      }
    ],
    "curAmt": {
      "amt": "99"
    },
    "totalCurAmt": {
      "amt": 99
    },
    "dueDt": "",
    "refType": "",
    "refName": "",
    "flagAnotherAmt": "",
    "pmtRefId": ""
  }
}

Response Body:

Success Response Example:

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

Response Error Example:

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

Diagram of sequence

- Payment PILA

Description:

This service allows payment PILA

Path:

POST: payments-management/v1/pila:

Request Data:

Headers:

Request Body:

Request Example:

{
  "trn": {
    "transactionHour": "15:37:59",
    "trnRqUID": "123456",
    "code": "123456789123456",
    "depAcctIdTo": {
      "acctId": "12321414"
    },
    "branchName": "MI OFICINA BETTY",
    "cityId": "25386",
    "city": "LA MESA",
    "stateProv": "25",
    "depAcctIdFrom": {
      "acctId": "12321414"
    },
    "type": "",
    "invoiceInfo": {
      "invoiceNum": "12321414",
      "identSerialNum": "12321414"
    },
    "validityPeriodInfo": {
      "validityPeriod": "12321414"
    },
    "dueDt": "",
    "curAmt": {
      "amt": 24
    }
  }
}

Response Body:

Success Response Example:

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

Response Error Example:

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

Diagram of sequence.

- Remittances - Consult Payments.

Description:

This service allows consult remittances basic data.

Path:

GET

/payments-management/v1/remittances/consult-payment/{refId}:

URIParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

{
  "responseType": {
    "value": "OK"
  },
  "transaction": {
    "origDt": "2023-12-17T00:00:00",
    "spRefId": "7246",
    "refId": "8219535213",
    "xFerInfo": {
      "depAcctIdFrom": {
        "curtAmt": {
          "amt": 20.00,
          "curCode": "BRL"
        },
        "fullName": "SOLANGEL BALBINA VIANCHA VIANCHA",
        "country": "BR",
        "stateProv": "MT - Mato Grosso"
      },
      "depAcctIdTo": {
        "curtAmt": {
          "amt": 11097
        },
        "fullName": "NAVYA  RADHIKA"
      }
    }
  }
}

Response Error Example:

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

Diagrama.

- Remittances - Create Payments.

Description:

PagoRemesa is a service that was implemented so that a client can receive money sent by a sender who is located abroad. In order to receive the money, the client must provide personal, financial information, relationship with the sender, source of economic resources, etc. Once the service is consumed; the payment will be collected and its status in the system will change to 'Collected', that is, the payment will be collected only once.

Path:

POST

/payments-management/v1/remittances/payments:

Headers

Mapping Data:

- Request:

- Response:

Examples:

Example of Body Request:

{
    "pmtInfo": {
        "additionalData": {
            "reason": "REGALO",
            "originResources": "AHORR",
            "reationshipType": "AMG",
            "desc": "PRUEBA",
            "pmtType": "E"
        },
        "senderPmtInfo": [
            {
                "type": "VLRACT",
                "rank": "VLRACT1"
            },
            {
                "type": "VLREGR",
                "rank": "VLREGR1"
            },
            {
                "type": "VLRING",
                "rank": "VLRING3"
            },
            {
                "type": "VLRPAS",
                "rank": "VLRPAS5"
            }
        ],
        "personInfo": {
            "personName": {
                "lastName": "GONZALEZ",
                "secondLastName": "URZOLA",
                "firstName": "DANIEL",
                "middleName": "TATIANA"
            },
            "businessInfo": {
                "branchName": "BCS"
            },
            "certCode": "0010",
            "jobTitle": "EMPPLU",
            "birthDt": "1994-12-12",
            "country": "CO",
            "emailAddr": "corre@correo.com",
            "flagUpdate": true,
            "cspRefId": 0,
            "rank": "NIV1",
            "gender": "F",
            "flagPubExpPerson": false,
            "govIssueIdent": {
                "govIssueIdentType": "C.C.",
                "identSerialNum": "1234",
                "expCityId": "11001",
                "issDt": "2012-12-12",
                "city": "BOGOTA",
                "expDt": "2024-03-15",
                "country": "CO"
            }
        },
        "listAddress": [
            {
                "cellPhone": "123",
                "stateProv": "BOGOT",
                "addrType": "RESI",
                "addr1": "DIRECCION UFWPPYCVEU",
                "phone": "123",
                "city": "BOGOT",
                "postalCode": "11001",
                "cityId": "11001"
            },
            {
                "cellPhone": "123",
                "stateProv": "BOGOT",
                "addrType": "EMPR",
                "addr1": "DIRECCION UFWPPYCVEU",
                "phone": "231",
                "city": "BOGOT",
                "postalCode": "11001",
                "cityId": "11001"
            }
        ],
        "adviser": {
            "adviserId": "W9M7R1A9",
            "adviserName": "EDISON",
            "middleName": "EDISON",
            "lastName": "EDISON",
            "secondLastName": "EDISON"
        },
        "pmtReferences": {
            "createRefId": "",
            "branchId": "0106",
            "status": "A"
        },
        "refId": "123445433",
        "trnRqUID": "0"
    },
    "compliance": {
        "termsConditions": true,
        "personDataProcessing": true
    }
}

Example of Body Response:

{
    "responseType": {
        "value": "OK"
    },
    "pmtInfo": {
        "spRefId": "1111",
        "originDt": "2023-03-14 18:20:38",
        "refId": "123445433",
        "depAcctIdTo": {
            "curtAmt": {
                "amt": 8624
            }
        },
        "depAcctIdFrom": {
            "curtAmt": {
                "amt": 2
            }
        },
        "intRateInfo": {
            "amt": 4311.5385,
            "curtAmt": {
                "amt": 0.0002319
            }
        },
        "taxPmtInfo": {
            "amt": 0,
            "gmtInfo": {
                "amt": 34
            },
            "fee": {
                "amt": 0
            }
        },
        "desc": "",
        "submitOffice": {
            "branchName": "SP02",
            "branchId": "25"
        },
        "status": "US"
    }
}

Response Error Example:

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

Diagrama.