Constructing the API call

In this page we will show you how Consumer to build API payload for Fiserv Developer Platform (Apigee Gateway).

A standard API call to create financial adjustment might look like below in UAT region.

An example API structure

{
    method: "POST",
    url:"https://cat.emea.api.fiservapps.com/omnipay/financial/adjustments/v1.0/post-adjustment",
    headers: {
      "Api-Key": "<App Key goes here>"
    },
    body: JSON.stringify({
    {
    "adjustmentCategory": "CHARGES_FEES",
    "adjustmentTypeIndex": "839",
    "internalMerchantId": "23456789",
    "internalAccountNumber": "90000001001",
    "amount": "100.12",
    "currency": "EUR",
    "date": "20240424",
    "description": "Chargeback Fee CR",
    "feeSequenceCode": "0Z1",
    "originalTransactionArn": "93240548754263421094323",
    "quantity": "10"
    }
}

What does each variable mean?

Api-Key

Once Fiserv Developer Portal team approves the 'create new key' request, then Consumer will be able to get Api-Key in Fiserv Developer Portal (refer guidelines in https://docs.fiserv.dev/public/docs/general-getting-started) for test and production seperately. Consumer must pass this Api-Key in header parameter in every single Funding Reject API call.

Below is only for informational purpose:

Once Consumer initiate the API call, it will route to Apigee gateway (Fiserv Developer Portal). APIGEE Gateway does the authentication. Upon successfully authenticated, API call will be routed to Fserv OmniPay Platform with some additional header information (as detailed below) populated by Apigee based on the Consumer APP setup.

{
    method: "POST",
    url:"https://cat.emea.api.fiservapps.com/omnipay/financial/adjustments/v1.0/post-adjustment",
    headers: {
      "Authorization": "Bearer <encoded JWT access_token> goes here",
      "Content-Type": "application/json",
      "Environment": "Prod or test environment goes here. E.g. bwu15 or prod",
      "Institution-Number": "Insitution Number goes here",
      "Trace-Id": "UUID goes here"
    },
    
}

Authorization

The Bearer token to be generated by Apigee (i.e. Fiserv Authentication Gateway). Seperate Bearer token will be generated for test and production environment.

Content-Type

Always populated with a static value 'application/json'.

Environment

For test environment, specific test environment name should be passed (e.g. "bwu15"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value "prod" should be populated.

Institution Number

8-digit number of the Institution where the merchant is boarded. Each acquirer has its Institution set up on the Fiserv OmniPay Platform and is provided with the Institution number. e.g. "00000099"

Trace-Id

This is an unique ID Apigee generate per API request. This unique ID is used mutually to track each API requests. Trace-Id is passed in API response to Consumer.

What does each variable mean in body of the API?

Refer technical documentation for more details.