cboj-payments-prc-api

1.0.x
(0 reviews)

Payments Process API

Description :

This API is used to orchestrate the logic for the customers process.

Base URLs

EnvironmentBase URLs
Mockhttps://eu1.anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/4be2e19f-42da-4571-80fd-19077a31ce58/cboj-payments-prc-api/1.0.11/m/
Devhttps://maictrldev.capitalbank.jo/payments-prc/v1
Staginghttps://maictrlstg.capitalbank.jo/payments-prc/v1
ProductionNA

Description

Payments Services are classified into following :

  1. Single Transfer Payments
  2. Standing Order Payments
  3. Get Transfer Tracking Service
  4. Get Swift Image
  5. This document describes the API specification for ‘Single Transfer Payments’.

‘Single Transfer Payments’ functionality includes the following APIs :

  1. Single Payments Domestic Posting ACH
  2. Single Payments Domestic Posting RTGS
  3. Single Payments International Posting
  4. Single Payments Internal Transfer Posting

‘Standing Order Payments’ functionality includes the following APIs :

  1. Standing Order Domestic Posting ACH
  2. Standing Order Domestic Posting RTGS
  3. Standing Order International Posting
  4. Standing Order Internal Posting
  5. Standing Order Third Party Posting
  6. Terminate Standing Order
  7. Search Standing Order Summary

Other APIs include :

  1. Get Transfer Tracking Payment Service
  2. Get Swift Image
  3. Submit Financial Posting
  4. Get Transaction details
  5. Internal Salary Credit Ryalize
  6. Program Fee Settlement Online
  7. Payment Transaction

Technical Specifications

Headers

Below are the headers that are set with every HTTP Request

Header NameSample ValueOptional?
client_id9712801dbaaffg90d43a0b09c59fdaf21e65524235436Mandatory
client_secret234d8AeC33e34bE1b3eiud31b2887cD4Mandatory
AuthorizationBearer afdca88b-9ed0-344b-8af0-b2195e382574Optional
x-channel-idCFFCHLMandatory
x-correlation-idaftca88b-9ed0-344b-8af0-b2155e382574Mandatory and unique for each request and is duplicate check. Can be any unique number but preferably a global unique identifier (GUID)
x-bank-idCBOJMandatory and should be hardcoded to 'CBOJ'
x-debug-flag0Optional (enum - 0 or 1)
x-customer-id2100122Optional (mandatory for customer facing channels)
x-sub-channel-idCLIQOptional

Error handling

HTTP Status

The HTTP error codes are:

  • 400 - Bad Request: An error in the client request (Mostly due to validations)
  • 400 - Bad Request: Any Error from Temenos System
  • 401 - Unauthorized: User can't be authenticated
  • 403 - Forbidden: The server cannot give access to the resource
  • 404 - Not Found: The resource defined in the URL doesn't exist
  • 405 - Method Not Allowed
  • 415 - Unsupported Media Type
  • 500 - Internal Server Error: The server encountered an unexpected condition

Error Response

A REST API should reply with an error code and a message to be shown to the consumer.

{
    "status": {
        "success": false,
        "code": "T24003799",
        "reasonCode": "",
        "arabicMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
        "englishMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
        "errorCode": "T24003799",
        "errorDescription": "INVALID/ NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS"
    }
}

API Security

Below polices are applied.

NameDescriptionExample
Client ID EnforcementIt restricts access to a protected resourceclient_id: 9d41a8940c5e4181aace6fc5e6cfffc3 client_secret: aB9D5Bd7450d49F584F23250D96872fD

Config Information

  1. The T24 versions which are to be used are determined by headers 'x-channel-id' and 'x-sub-channel-id'. The versions details are organized in such a way that in case a version needs to be changed , we can navigate to the properties based on the channel and sub channel id (t24.'x-channel-id'.'x-sub-channel-id'.endpoint.option.version)
  2. Any new channel or sub channel id needs to be added , we can add the required details under the same hierarchy. (t24.new 'x-channel-id'.new 'x-sub-channel-id'.new endpoint.option.version)

Reviews