bcs-payments-management-sys

API INFORMATION

Title: payments-management-sys

Version: 1.0.0

Protocols: HTTPS

URI Sandbox:

URI QA:

URILive:

DESCRIPTION

This service allows Management of payments-management-sys Information, which allows the following operations:

Summary

- Customer Payment Status Report

Description:

The CustomerPaymentStatusReport message is sent by an instructed agent to the upstream party in the payment chain. It is used to inform this party about the positive or negative status of an instruction (either single or archive). It is also used to report a pending instruction.

Path:

POST: /CustomerPaymentStatusReport

Request Data:

Headers:

Canonical Request Body:

Request Example:

{
  "CstmrPmtStsRpt": {
    "GrpHdr": {
      "MsgId": "f007badf-9d05-48d0-813b-feeac6e85774",
      "CreDtTm": "2022-02-28T14:07:02"
    },
    "OrgnlGrpInfAndSts": {
      "OrgnlMsgId": "d50c92ad-47fd-4ba3-896a-6eeb8c14108f",
      "OrgnlMsgNmId": "pain001",
      "OrgnlCreDtTm": "2022-02-28T14:08:16",
      "OrgnlNbOfTxs": "1",
      "OrgnlCtrlSum": "100000.00",
      "GrpSts": "ACCP",
      "StsRsnInf": {
        "Rsn": {
          "Cd": "NT00",
          "Prtry": "Aceptado"
        },
        "AddtnlInf": "845564185167"
      }
    },
    "OrgnlPmtInfAndSts": {
      "OrgnlPmtInfId": "fbc0f86f-8c30-4efc-811d-6bbdb1133850"
    }
  }
}

Canonical Response Body:

Response Error Example:

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

Diagram of sequence.

Customer Direct Debit Initiation

Description:

Scope
The CustomerDirectDebitInitiation message is sent by the initiating party to the forwarding agent or creditor agent. It is used to request one-time or bulk collections of funds from one or more debtor accounts for a creditor.

Usage
The CustomerDirectDebitInitiation message can contain one or more direct debit instructions.

The message can be used in a direct or relay scenario -->

In a direct scenario, the message is sent directly to the creditor agent. The creditor agent is the account manager of the creditor.

In a relay scenario, the message is sent to a forwarding agent. The forwarding agent acts as a hub financial institution. It will forward the CustomerDirectDebitInitiation message to the creditor agent.

The message can also be used by an initiating party that has the authority to send the message on behalf of the creditor. This fits, for example, in the scenario of a payment factory that initiates all payments on behalf of a large company.

The CustomerDirectDebitInitiation message can be used in both domestic and cross-border scenarios.

CustomerDirectDebitInitiation may or may not contain mandate-related information, i.e. extracts of a mandate, such as MandateIdentification or DateOfSignature. The CustomerDirectDebitInitiation message should not be considered as a mandate.

Path:

POST: /CustomerDirectDebitInitiation

Request Data:

Headers:

Canonical Request Body:

Request Example:

{
  "CstmrDrctDbtInitn": {
    "GrpHdr": {
      "MsgId": "2bcdcb24-bf11-4374-ac6e-18d3d20bc088",
      "CreDtTm": "2024-04-22T21:21:16.835",
      "NbOfTxs": "1",
      "CtrlSum": "8000.00",
      "InitgPty": {
        "Nm": "ANDRES G. T."
      },
      "InitnSrc": {
        "Nm": "ENTRECUENTAS",
        "Prvdr": "REDEBAN",
        "Vrsn": "Ver001.01"
      }
    },
    "PmtInf": [
      {
        "PmtInfId": "13251087744299833222783728588506860",
        "PmtMtd": "TRF",
        "ReqdColltnDt": "2024-04-22",
        "Cdtr": {
          "Nm": "COMERCIO PRUEBAS 6777",
          "Id": {
            "OrgId": {
              "Othr": [
                {
                  "Id": "987610773"
                }
              ]
            }
          }
        },
        "CdtrAgt": {
          "FinInstnId": {
            "BICFI": "0051"
          }
        },
        "DrctDbtTxInf": [
          {
            "PmtId": {
              "InstrId": "null",
              "EndToEndId": "bee8cbce-dc2a-44ee-971e-9d1f41786d4c"
            },
            "InstdAmt": "8000.00",
            "Dbtr": {
              "Nm": "ANDRES G. T.",
              "Id": {
                "OrgId": {
                  "Othr": [
                    {
                      "Id": "+573118371384"
                    }
                  ]
                },
                "PrvtId": {
                  "Othr": [
                    {
                      "Id": "9858558",
                      "SchmeNm": {
                        "Cd": "CC"
                      }
                    }
                  ]
                }
              }
            },
            "DbtrAcct": {
              "Ccy": "COP",
              "Id": {
                "Othr": {
                  "Id": "3118361384"
                }
              },
              "Tp": {
                "Cd": "SVGS"
              }
            },
            "DbtrAgt": {
              "FinInstnId": {
                "BICFI": "0807"
              }
            },
            "DbtrAgtAcct": {
              "Id": {
                "Othr": {
                  "Id": "98585585"
                }
              }
            },
            "PmtTpInf": {
              "CtgyPurp": {
                "Cd": "P2M",
                "Prtry": "PAY"
              }
            },
            "RmtInf": {
              "Strd": [
                {
                  "RfrdDocInf": [
                    {
                      "LineDtls": [
                        {
                          "Id": [
                            {
                              "Nb": "DataMap QR"
                            }
                          ],
                          "Desc": "channel:APP;uniqueCodeMerchant:910203040;idTransaccion:000001;storelabel:001;terminalLabel:001;securityField:hy67shdjjdnbdGH"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Canonical Response success:

Response success example:

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

Canonical Response error:

Response Error Example:

{
  "errorInformation": {
    "errorCode": "2441",
    "errorDescription": "string"
  }
}

- Payment Reversal

Description:

Service that allows users to reverse a payment

Path:

POST: /CustomerPaymentReversal

Request Data:

Headers:

Canonical Request Body:

Request Example:

{
    "CstmrPmtRvsl": {
        "GrpHdr": {
            "MsgId": "34af5076-c220-4ade-afc1-09c803275c9f",
            "CreDtTm": "2022-10-31T20:05:24.023",
            "NbOfTxs": "1",
            "CtrlSum": "4723.34"
        },
        "OrgnlGrpInf": {
            "OrgnlMsgId": "d50c92ad-47fd-4ba3-896a-6eeb8c14108f",
            "OrgnlCreDtTm": "2022-10-17T09:30:47",
            "OrgnlMsgNmId": "pain008",
            "RvslRsnInf": [
                {
                    "Rsn": {
                        "Cd": "AC04",
                        "Prtry": "ClosedAccountNumber"
                    },
                    "AddtlInf": "845564185167"
                }
            ]
        },
        "OrgnlPmtInfAndRvsl": [
            {
                "OrgnlPmtInfId": "63171197792539904131832198021486397",
                "TxInf": [
                    {
                        "OrgnlEndToEndId": "68e3ac97-a754-4f53-bb98-61f624dadf8c",
                        "OrgnlTxRef": {
                            "Cdtr": {
                                "Pty": {
                                    "Id": {
                                        "OrgId": {
                                            "Othr": [
                                                {
                                                    "Id": "910203040"
                                                }
                                            ]
                                        }
                                    },
                                    "Nm": "EMPRESA MI COMERCIO"
                                }
                            },
                            "CdtrAgt": {
                                "FinInstnId": {
                                    "BICFI": "0013"
                                }
                            },
                            "DbtrAcct": {
                                "Ccy": "COP",
                                "Id": {
                                    "Othr": {
                                        "Id": "23004012666"
                                    }
                                },
                                "Tp": {
                                    "Cd": "SVGS"
                                }
                            },
                            "Dbtr": {
                                "Pty": {
                                    "Nm": "Diego Jimenez",
                                    "Id": {
                                        "PrvtId": {
                                            "Othr": [
                                                {
                                                    "SchmeNm": {
                                                        "Cd": "CC"
                                                    },
                                                    "Id": "1018475999"
                                                }
                                            ]
                                        }
                                    }
                                }
                            },
                            "DbtrAgt": {
                                "FinInstnId": {
                                    "BICFI": "0007"
                                }
                            },
                            "PmtTpInf": {
                                "CtgyPurp": {
                                    "Cd": "P2M",
                                    "Prtry": "PAY"
                                }
                            }
                        }
                    }
                ]
            }
        ]
    }
}

Canonical Response success: (202)

Response success example:

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

Canonical Response error:

Response Error Example:

{
  "errorInformation": {
    "errorCode": "2442",
    "errorDescription": "string"
  }
}

- Payment Reversal Credit

Description:

El mensaje CustomerPaymentReversalCredit es enviado por la parte iniciadora a la siguiente parte en la cadena de pago. Se utiliza para revertir un pago previamente ejecutado.

Path:

POST: /CustomerPaymentReversalCredit

Request Data:

Headers:

Canonical Request Body:

{
  "CstmrPmtRvsl": {
    "GrpHdr": {
      "MsgId": "72cae516-f793-4979-bac3-abc6bb3a9e24",                                  // [1]
      "CreDtTm": "2024-03-13T06:47:19.294",                                             // [2]
      "NbOfTxs": "1",                                                                   // [3]
      "CtrlSum": "10000.00"                                                             // [4]
    },
    "OrgnlGrpInf": {
      "OrgnlMsgId": "fcb47c0a-add4-4ff5-b888-c9b23f27dab5",                             // [5]
      "OrgnlCreDtTm": "2024-03-13T06:47:19",                                            // [6]
      "OrgnlMsgNmId": "pain001",                                                        // [7]
      "RvslRsnInf": [
        {
          "Rsn": {
            "Cd": "NT46",                                                               // [8]
            "Prtry": " Not Acceptable -- No se obtuvo res-puesta Pain002 de Credito"    // [9]
          },
          "AddtlInf": "000000"                                                          //[10]
        }
      ]
    },
    "OrgnlPmtInfAndRvsl": [
      {
        "OrgnlPmtInfId": "12900241017230089889282900587856395",                         //[11]
        "TxInf": [
          {
            "OrgnlEndToEndId": "a50dca07-169c-4095-b2ca-675b2870413c",                  //[12]
            "OrgnlTxRef": {
              "DbtrAcct": {
                "Ccy": ""
              },
              "Cdtr": {
                "Pty": {
                  "Id": {
                    "OrgId": {
                      "Othr": [
                        {
                          "Id": "934128397"                                             //[14]
                        }
                      ]
                    },
                    "PrvtId": {
                      "Othr": [
                        {
                          "Id": "2332443234",                                            //[21]
                          "SchmeNm": {
                            "Cd": "1212121"                                              //[22]
                          }
                        }
                      ]
                    }
                  },
                  "Nm": "JUEGOS COMO NINOS"                                             //[13]   //[20]
                }
              },
              "CdtrAgt": {
                "FinInstnId": {
                  "BICFI": "0807"                                                       //[15]   //[23]
                }
              },
              "CdtrAcct": {
                "Ccy": "COP",                                                           //[16]
                "Id": {
                  "Othr": {
                    "Id": "555940121234"                                                //[17]
                  }
                },
                "Tp": {
                  "Cd": "SVGS"                                                          //[18]
                }
              },
              "CdtrAgtAcct": {
                "Id": {
                  "Othr": {
                    "Id": "08070120"                                                    //[19]
                  }
                }
              },
              "Dbtr": {
                "Pty": {
                  "Nm": "ANDRES G. T.",
                  "Id": {
                    "PrvtId": {
                      "Othr": [
                        {
                          "Id": "9816514",
                          "SchmeNm": {
                            "Cd": "CC"
                          }
                        }
                      ]
                    }
                  }
                }
              },
              "DbtrAgt": {
                "FinInstnId": {
                  "BICFI": "0051"
                }
              },
              "PmtTpInf": {
                "CtgyPurp": {
                  "Cd": "P2M",                                                      // OK [24]
                  "Prtry": "PAY"                                                    // OK [25]
                }
              }
            }
          }
        ]
      }
    ]
  }
}

Mapping Request

Response OK:

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

Mapping Response OK (202)

Response Error Example:

{
  "errorInformation": {
    "errorCode": "2441",
    "errorDescription": "string"
  }
}

Mapping Response ERROR

Customer Credit Transfer Initiation

Description:

The CustomerCreditTransferInitiation message is sent by the initiating party to the freight forwarder or debtor agent. It is used to request the movement of funds from the debtor account to a creditor account.

Path:

POST: /CustomerCreditTransferInitiation

Request Data:

Headers:

Canonical Request Body:

Request Example:

{
  "CstmrCdtTrfInitn": {
    "GrpHdr": {
      "MsgId": "464c393b-a7e3-4dfa-89ad-8e2ba926b32d",
      "CreDtTm": "2024-04-22T22:35:22.121",
      "NbOfTxs": "1",
      "CtrlSum": "8000.00",
      "InitgPty": {
        "Nm": "ANDRES G. T."
      },
      "InitnSrc": {
        "Nm": "ENTRECUENTAS",
        "Prvdr": "REDEBAN",
        "Vrsn": "Ver001.01"
      }
    },
    "PmtInf": [
      {
        "PmtInfId": "13251532274810329689203529645029155",
        "PmtMtd": "TRF",
        "ReqdExctnDt": {
          "Dt": "2024-04-22"
        },
        "Dbtr": {
          "Nm": "ANDRES G. T.",
          "Id": {
            "PrvtId": {
              "Othr": [
                {
                  "Id": "9816514",
                  "SchmeNm": {
                    "Cd": "CC"
                  }
                }
              ]
            }
          }
        },
        "DbtrAgt": {
          "FinInstnId": {
            "BICFI": "0051"
          }
        },
        "CdtTrfTxInf": [
          {
            "PmtId": {
              "EndToEndId": "f4d9dd14-1b44-43be-9d8a-9a6673e114fb"
            },
            "Amt": {
              "InstdAmt": "8000.00"
            },
            "Cdtr": {
              "Nm": "DSR",
              "Id": {
                "OrgId": {
                  "Othr": [
                    {
                      "Id": "934129908"
                    }
                  ]
                },
                "PrvtId": {
                  "Othr": [
                    {
                      "Id": "1234567900",
                      "SchmeNm": {
                        "Cd": "NIT"
                      }
                    }
                  ]
                }
              }
            },
            "CdtrAcct": {
              "Ccy": "COP",
              "Id": {
                "Othr": {
                  "Id": "40671264019"
                }
              },
              "Tp": {
                "Cd": "SVGS"
              }
            },
            "CdtrAgt": {
              "FinInstnId": {
                "BICFI": "0807"
              }
            },
            "CdtrAgtAcct": {
              "Id": {
                "Othr": {
                  "Id": "08070120"
                }
              }
            },
            "Tax": {
              "Rcrd": [
                {
                  "Ctgy": "Comision",
                  "TaxAmt": {
                    "Dtls": [
                      {
                        "Amt": "390.32"
                      }
                    ]
                  }
                },
                {
                  "Ctgy": "IVAComision",
                  "TaxAmt": {
                    "Dtls": [
                      {
                        "Amt": "62.32"
                      }
                    ]
                  }
                },
                {
                  "Ctgy": "costoTx",
                  "TaxAmt": {
                    "Dtls": [
                      {
                        "Amt": "49.00"
                      }
                    ]
                  }
                }
              ]
            },
            "PmtTpInf": {
              "CtgyPurp": {
                "Cd": "P2M",
                "Prtry": "PAY"
              }
            },
            "RmtInf": {
              "Strd": [
                {
                  "RfrdDocInf": [
                    {
                      "LineDtls": [
                        {
                          "Id": [
                            {
                              "Nb": "DataMap QR"
                            }
                          ],
                          "Desc": "channel:APP;uniqueCodeMerchant:910203040;idTransaccion:000001;storelabel:001;terminalLabel:001;securityField:hy67shdjjdnbdGH"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Canonical Response success:

Response success example:

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

Canonical Response error:

Response Error Example:

{
  "errorInformation": {
    "errorCode": "2441",
    "errorDescription": "string"
  }
}

Customer Credit Transfer Initiation ON-US

Description:

The CustomerCreditTransferInitiation ON-US message is sent by the initiating party to the freight forwarder or debtor agent. It is used to request the movement of funds from the debtor account to that of a creditor.

Path:

POST: /CustomerCreditTransferInitiationOnUS

Request Data:

Headers:

Canonical Request Body:

Request Example:

{
  "CstmrCdtTrfInitn": {
    "GrpHdr": {
      "MsgId": "bfd5322f-4258-4a2e-8727-5add745fcf99",
      "CreDtTm": "2024-04-22T23:08:19.789",
      "NbOfTxs": "1",
      "CtrlSum": "8000.00",
      "InitgPty": {
        "Nm": "ANDRES G. T."
      },
      "InitnSrc": {
        "Nm": "ENTRECUENTAS",
        "Prvdr": "REDEBAN",
        "Vrsn": "Ver001.01"
      }
    },
    "PmtInf": [
      {
        "PmtInfId": "13251730019910710746973943940407985",
        "PmtMtd": "TRF",
        "ReqdExctnDt": {
          "Dt": "2024-04-22"
        },
        "Dbtr": {
          "Nm": "ANDRES G. T.",
          "Id": {
            "OrgId": {
              "Othr": [
                {
                  "Id": "+573118361384"
                }
              ]
            },
            "PrvtId": {
              "Othr": [
                {
                  "Id": "9816514",
                  "SchmeNm": {
                    "Cd": "CC"
                  }
                }
              ]
            }
          }
        },
        "DbtrAcct": {
          "Ccy": "COP",
          "Id": {
            "Othr": {
              "Id": "3118361384"
            }
          },
          "Tp": {
            "Cd": "SVGS"
          }
        },
        "DbtrAgt": {
          "FinInstnId": {
            "BICFI": "0051"
          }
        },
        "DbtrAgtAcct": {
          "Id": {
            "Othr": {
              "Id": "00510040"
            }
          }
        },
        "CdtTrfTxInf": [
          {
            "PmtId": {
              "EndToEndId": "cbe7579e-dd7d-4c7f-9c31-d71042ef5374"
            },
            "Amt": {
              "InstdAmt": "8000.00"
            },
            "Cdtr": {
              "Nm": "PRUEBAS MASIVAS COMERCIOS PARALELITOSS 440",
              "Id": {
                "OrgId": {
                  "Othr": [
                    {
                      "Id": "927888486"
                    }
                  ]
                },
                "PrvtId": {
                  "Othr": [
                    {
                      "Id": "36586497",
                      "SchmeNm": {
                        "Cd": "CC"
                      }
                    }
                  ]
                }
              }
            },
            "CdtrAcct": {
              "Ccy": "COP",
              "Id": {
                "Othr": {
                  "Id": "63434889"
                }
              },
              "Tp": {
                "Cd": "SVGS"
              }
            },
            "CdtrAgt": {
              "FinInstnId": {
                "BICFI": "0051"
              }
            },
            "CdtrAgtAcct": {
              "Id": {
                "Othr": {
                  "Id": "00510040"
                }
              }
            },
            "Tax": {
              "Rcrd": [
                {
                  "Ctgy": "Comision",
                  "TaxAmt": {
                    "Dtls": [
                      {
                        "Amt": "0.00"
                      }
                    ]
                  }
                },
                {
                  "Ctgy": "IVAComision",
                  "TaxAmt": {
                    "Dtls": [
                      {
                        "Amt": "0.00"
                      }
                    ]
                  }
                },
                {
                  "Ctgy": "costoTx",
                  "TaxAmt": {
                    "Dtls": [
                      {
                        "Amt": "0.00"
                      }
                    ]
                  }
                }
              ]
            },
            "PmtTpInf": {
              "CtgyPurp": {
                "Cd": "P2M",
                "Prtry": "PAY"
              }
            },
            "RmtInf": {
              "Strd": [
                {
                  "RfrdDocInf": [
                    {
                      "LineDtls": [
                        {
                          "Id": [
                            {
                              "Nb": "DataMap QR"
                            }
                          ],
                          "Desc": "channel:APP;uniqueCodeMerchant:910203040;idTransaccion:000001;storelabel:001;terminalLabel:001;securityField:hy67shdjjdnbdGH"
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Canonical Response success:

Response success example:

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

Canonical Response error:

Response Error Example:

{
  "errorInformation": {
    "errorCode": "2441",
    "errorDescription": "string"
  }
}