Retrieve payment instructions

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

accountTypesstring

Example:170

This is the source account type index (billing level merchant account) for which the reserve, rolling reserve and/or factoring need to be set up to be retrieved, or leave empty to retrieve all. The portion of the payment from this source account type will be transferred to another account type based on the payment instruction setup. 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:USD

The Swift Code of the source account currencies for which the reserve, rolling reserve and/or factoring is set up to be retrieved, or leave empty to retrieve all. 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 payment instruction assigned to the merchant. ACTIVE - returns all active payment instructions assigned to a merchant. FUTURE - returns payment instructions assigned to a merchant that are set to become effective in the future, having deductionStartDate later than current posting date. EXPIRED - returns payment instructions assigned to a merchant that are expired, having deductionEndDate less than current posting date of an institution. ALL - returns all active, future and expired payment instructions assigned to a merchant. By default, active and future payment instructions assigned to a merchant are returned.

instructionTypeIndexstring

Example:001

Indicates the type of payment instruction to be set for the selected source account type and source account currency. The valid values depends on the configured payment instruction types for the Institution. For a list of valid codes use Acquirer Profile API get reference_data end-point with query parameter classification equal to instructionTypeIndex.

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": "470",
        "accountCurrencyCode": "GBP"
      },
      "destinationAccount": {
        "accountTypeIndex": "470",
        "accountCurrencyCode": "GBP"
      },
      "instructionType": {
        "instructionTypeIndex": "001"
      },
      "status": "ACTIVE",
      "instructionIdNumber": "0000000010",
      "deductionStartDate": "20201030",
      "deductionEndDate": "20201030",
      "deductionPercentage": "5.0",
      "deductionMinAmount": "250.0",
      "deductionMaxAmount": "250.0",
      "deductionBaseAmount": "250.0",
      "deductionTotalCnt": "100000",
      "deductionTotalAmount": "100000",
      "factorAgent": "James Kirk",
      "note": "Free text to leave any extra notes",
      "deductionFrequency": "Daily",
      "lastExecutionDate": "20201030",
      "executionCount": "10",
      "amountPaid": "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 payment instructions

Query parameters

Headers

Response

Example response