/api/v1/omnipay/accounts/{mid}

get https://uat-merchant-services.fiservapp.com/boarding-ui/external-api/maintenance/api/v1/omnipay/accounts/{mid}

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

Responses

Response body

array of objects

object

internalAccountNumber

string

This is the internal account number that is auto-generated by bankworks when an account is created. The combination of institution number and this fields makes a unique key that identifies an account.

accountType

object

Index of the account type to be assigned to the merchant. For a list of valid codes check the institution index file.

accountCurrencyCode

string

ISO 4217 currency of the account selected, possible values are restricted based on the institution configuration.

billingLevel

boolean

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

accountStatus

string

StatusDTO of the account, the main values can be Active or Closed

ACTIVE CLOSED SUSPENDED COLLECT_EPS SUSPENSE_ACCT

receiverCountryCode

string

ISO-3166 alpha country code for the merchant's bank country. Mandatory if billing level is set to true.

paymentReference

string

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.

statementType

object

Statement type to be generated. As per the predefined values or left blank where not applicable. For a list of valid codes and their descriptions, check the institution index file.

statementGenerationCode

string

Option for statement generation.

SUPPRESS GENERATE GENERATE_IF_ACTIVITY GENERATE_IF_NO_ACTIVITY

annualFeeDueDate

date

Annual fee due date.

calendarTypeIndex

object

Defines the scheme exception days when calculating the funding date of merchant payments. As per the institution configuration.

liabilityAccount

string

TBC

sepaDirectDebitSeq

string

Identifies the direct debit sequence i.e. transaction details attached to the payment information block such as first (FRST) or recurring (RCUR).

FRST RCUR

parentInternalMerchantId

string

The internal OmniPay MID to which the merchant needs to be linked to as a child merchant. When populated should be an existing group /sub group merchant MID

parentTradeName

string

required

length between 1 and 32

Merchant Trade Name. UTF8 characters supported. Max 32 bytes.

payable

object

receivable

object

204

No register was found

401

Unauthorized request

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://uat-merchant-services.fiservapp.com/boarding-ui/external-api/maintenance/api/v1/omnipay/accounts/mid \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200Successful operation

400Bad request

403Forbidden request

404Record does not exist

500Internal Error

502API Error