Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Accounts

Add merchant accounts

Adds one or more new account(s) to the merchant. The system will validate that the merchant currently don't have the combination of account type and currency passed on the request body. The new account type and currency should exist for the parent of the merchant otherwise an error returned.

post/accounts

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

accountTypeIndexstring required

Index of the merchant account type to be assigned or used in the operation. For a list of valid codes in the institution use the Acquirer Profile service-contracts/{serviceContractIndex}/account-settlement endpoint. For valid accounts for an existing merchant refer to the omnipay/maintenance/v1.0/accounts GET endpoint in merchant maintenance API.

accountCurrencyCodestring required

ISO 4217 currency of the account selected, possible values are restricted based on the institution configuration. For a list of valid codes use Acquirer Profile API GET /service-contracts/serviceContractIndex/account-settlement.

billingLevelboolean required

Indicates if the account will be settled to on a funding. Billing accounts should have the Bank Account details filled.

receiverCountryCodestring

ISO-3166 alpha country code for the merchant's bank country. Mandatory if billing level is set to true. If not provided while adding a merchant account then system will default to null.

paymentReferencestring

For institutions using IFS funding file this field should contain the direct debit contract number (required for merchant debits). For others it is a reference text to display on merchant's bank statement if supported on the funding file.

statementTypeIndexstring

Statement type to be generated. Allowed to provide valid value if the institution level configuration enabled to override at merchant level. If no value provided while adding a merchant account, then system will default to "900". For a list of valid codes use Acquirer Profile API get reference_data end-point with query parameter clasification equal to statementTypeIndex.

statementGenerationCode'SUPPRESS' | 'GENERATE' | 'GENERATE_IF_ACTIVITY' | 'GENERATE_IF_NO_ACTIVITY'

Option for statement generation.

annualFeeDueDatestring

YYYYMMDD Date which the annual fee for this account should be generated

calendarTypeIndexstring

Defines the scheme exception days when calculating the funding date of merchant payments as per the institution configuration. If not provided while adding an account, then system will default to null value. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal calendarTypeIndex.

Example request

[
  {
    "accountTypeIndex": "170",
    "accountCurrencyCode": "EUR",
    "receiverCountryCode": "IRE",
    "paymentReference": "999999999999999999",
    "statementTypeIndex": "900",
    "statementGenerationCode": "SUPPRESS",
    "annualFeeDueDate": "20201231",
    "calendarTypeIndex": "000",
    "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",
      "paymentFormatIndex": "000",
      "clearingEntityIndex": "000",
      "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",
      "paymentFormatIndex": "000",
      "clearingEntityIndex": "000",
      "correspondentBankAccount": "ZZ 9842512858747",
      "calendarDays": "000",
      "collectionDelayDays": "000",
      "ddMandateReference": "12345678NWMA02"
    }
  }
]

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"
  }
}