Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Accounts

Retrieve merchant accounts

Retrieves the list of merchant accounts for the merchant. The list can be filtered by account type and/or currency.

get/accounts

Query parameters

accountCurrencystring[]

The Swift Code of the Account Currencies to be retrieved, or leave empty to retrieve all

[
  "USD",
  "EUR"
]
accountTypesstring[]

The Account Type IDs to be retrieved, or leave empty to retrieve all

[
  "170"
]

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

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": [
    {
      "internalAccountNumber": "90000001001",
      "accountCurrencyCode": "EUR",
      "accountStatus": "ACTIVE",
      "receiverCountryCode": "IRE",
      "paymentReference": "999999999999999999",
      "statementGenerationCode": "SUPPRESS",
      "annualFeeDueDate": "20201231",
      "liabilityAccount": "IR21A123456",
      "sepaDirectDebitSeq": "FRST",
      "parentInternalMerchantId": "00101010",
      "parentTradeName": "Insomnia",
      "payable": {
        "bankName": "Bank of Dublin",
        "accountName": "John Doe Debit Account",
        "counterBankNumber": "13165987",
        "accountNumber": "ZZ999999999999999",
        "bankTelephone": "00535125412123",
        "bankContactName": "Frank Castle",
        "correspondentBankNo": "ZZZZZZZZZZZ",
        "iban": "ZZ99999999999999999999",
        "customerPaymentText": "9999999999",
        "bankCity": "Dublin",
        "correspondentBankAccount": "ZZ 9842512858747",
        "calendarDays": "000",
        "paymentDelayDays": "000",
        "ceilingLimit": "1000.12"
      },
      "receivable": {
        "bankName": "Sample Bank Name",
        "accountName": "John Doe Debit Account",
        "counterBankNumber": "13165987",
        "accountNumber": "ZZ9999999999999999",
        "bankTelephone": "003531234567",
        "bankContactName": "Frank Castle",
        "correspondentBankNo": "ZZ99999999",
        "iban": "ZZ999999999999999999999",
        "customerPaymentText": "item number 6478",
        "bankCity": "Dublin",
        "correspondentBankAccount": "ZZ 9842512858747",
        "calendarDays": "000",
        "collectionDelayDays": "000",
        "ddMandateReference": "12345678NWMA02"
      }
    }
  ],
  "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"
  }
}