Retrieve split payment instructions

Retrieves a paginated list of split payment instructions for a merchant. By default only active and future effective dated split payment instructions are returned, the results can be fitered by account type, account currency code, and split payment instruction status.

accountTypestring

Example:496

The source account type index (billing level merchant account) used for applying the split payment instruction. If this index is not provided, the split payment instructions assigned to the merchant will be retrieved for all source account types. To get list of source account type with source account currency code assigned for a merchant, use GET merchant accounts endpoint in Merchant Maintenance API.

accountCurrencystring

Example:INR

The Swift Code of the source account currency used for applying the split payment instruction. If this field is not provided, the split payment instructions assigned to the merchant will be retrieved for all source account currencies. ISO 4217. To get list of source account type with source account currency code assigned for a merchant, use GET merchant accounts endpoint in Merchant Maintenance API.

status'ACTIVE' | 'FUTURE' | 'EXPIRED' | 'ALL'

Example:ACTIVE

Status of the split payment instruction assigned to the merchant. ACTIVE - returns all active split payment instructions assigned to a merchant. FUTURE - returns split payment instructions assigned to a merchant that are set to become effective in the future, having startDate later than current institution posting date. EXPIRED - returns split payment instructions assigned to a merchant that are expired, having endDate less than current posting date of an institution. ALL - returns all active, future and expired split payment instructions assigned to a merchant. By default, active and future split payment instructions assigned to a merchant are returned.

limitinteger

The number of items to return

offsetinteger

The number of items to skip before returning the results

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

Response

OK

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"
        }
      }
    ]
  },
  "data": [
    {
      "sourceAccount": {
        "accountTypeIndex": "496",
        "accountCurrencyCode": "INR"
      },
      "destinationAccount": {
        "accountTypeIndex": "170",
        "accountCurrencyCode": "USD"
      },
      "instructionType": {
        "instructionTypeIndex": "003"
      },
      "status": "ACTIVE",
      "instructionIdNumber": "1234567890",
      "startDate": "20200615",
      "endDate": "20200615",
      "deductionPercentage": "5.0",
      "lastExecutionDate": "20201030",
      "totalExecutionCount": "10",
      "totalAmountPaid": "10000.50",
      "lastUpdatedBy": "John Smith",
      "lastUpdatedDate": "20210406"
    }
  ],
  "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"
  }
}

v1

Retrieve split payment instructions

Query parameters

Headers

Response

Example response