Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Split Payment Instructions

Add split payment instructions

This endpoint can be used to add one or more split payment instructions for a merchant. The start date should be greater than or equal to the current posting date of an institution. Refer static documentation for more information on validations involved against each fields.

The body of the request will include the list of fields that can be included for each split payment instruction.

post/split-payment-instructions

Headers

Content-Type'application/json' | 'application/json;charset=UTF-8' required

Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.

FSV-Interaction-Idstring required
Example:9591e6d8-0d70-11ea-8d71-362b9e155667

An RFC4122 UUID used as to trace requests.

Environmentstring required

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-Numberstring required
Example:00000099

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.

Internal-Merchant-Idstring required

OPY Internal Client Number

Request body

sourceAccountTypeIndexstring required

The source account type index (billing level merchant account) used for applying the split payment instruction. The portion of the payment from this source account type will be transferred to destination account type based on the split payment instruction setup. Source account type will always work along with source account currency code selected. Only '496' (PAR Hold Account) is allowed as valid sourceAccountTypeIndex at the moment.

sourceAccountCurrencyCodestring required

The Swift Code of the source account currency corresponding to the selected source account type used for applying the split payment instruction. ISO 4217. Only 'INR' is allowed as valid sourceAccountCurrencyCode at the moment.

startDatestring required

Indicates the date of the split payment instructions become effective. The date must be equal to or greater than the current posting date of an institution. Format YYYYMMDD.

endDatestring required

Indicates the date of the split payment instructions becomes expire. The date must be greater than the current posting date of an institution and greater than the startDate. Format YYYYMMDD.

Example request

[
  {
    "sourceAccountTypeIndex": "496",
    "sourceAccountCurrencyCode": "INR",
    "startDate": "20200615",
    "endDate": "20200615",
    "destinationAccount": [
      {
        "accountTypeIndex": "170",
        "accountCurrencyCode": "USD",
        "splitPercentage": "5.0"
      }
    ]
  }
]

Response

OK

dataobject[]

"Contains the primary data to be returned as the API response.

Use this object only when respnse type is an array.

It will not be returned in case of error."

Example response

{
  "meta": {
    "paging": {
      "count": 100,
      "totalPages": 10,
      "currentOffset": 1,
      "currentNumberOfRetrievedRecords": 10,
      "maxLimit": 10,
      "hasMoreRecords": true,
      "pageNumber": 1
    },
    "sorting": {
      "sort": "name,-startDate"
    },
    "messages": [
      {
        "id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
        "code": "ACCOUNT_NUMBER_NOT_FOUND",
        "title": "The authorization credentials required for this request are invalid.",
        "detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
        "source": {
          "pointer": "/dogs/name",
          "parameter": "type",
          "header": "type"
        }
      }
    ]
  },
  "errors": [
    {
      "id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
      "code": "ACCOUNT_NUMBER_NOT_FOUND",
      "title": "The authorization credentials required for this request are invalid.",
      "detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
      "source": {
        "pointer": "/dogs/name",
        "parameter": "type",
        "header": "type"
      }
    }
  ],
  "links": {
    "self": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=3&limit=10",
    "first": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=1&limit=10",
    "last": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=10&limit=10",
    "prev": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=2&limit=10",
    "next": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=4&limit=10"
  }
}