GetMerchantAccount

GET /api/admin/merchantaccounts/{id}

GetMerchantAccount

cURL

curl --request GET \
  --url https://test.paysight.io/api/admin/merchantaccounts/{id} \
  --header 'Authorization: <api-key>' \
  --header 'ClientId: <clientid>' \
  --header 'UserEmail: <useremail>'

200

{
  "id": 123,
  "mid": "<string>",
  "title": "<string>",
  "companyId": 123,
  "agent": "<string>",
  "acquiringBank": "<string>",
  "gatewayId": 123,
  "enabledMastercard": true,
  "enabledVisa": true,
  "descriptor": "<string>",
  "mcc": "<string>",
  "acquirerBINVisa": "<string>",
  "acquirerBINMastercard": "<string>",
  "psp": "<string>",
  "maxPrice": 123,
  "verticalId": 123,
  "monthlyCap": 123,
  "reservePercentage": 123,
  "discountRatePercentage": 123,
  "gatewayTransactionFee": 123,
  "chargebackFee": 123,
  "routingNumber": "<string>",
  "accountNumber": "<string>",
  "brandId": 123,
  "allowPremiumProgram": true,
  "fullyLive": true,
  "shorthandSuffix": "<string>",
  "defaultCurrency": "<string>",
  "rdrFee": 123,
  "ethocaFee": 123,
  "cdrnFee": 123,
  "allowRetriesFromOtherMids": true,
  "allowInsufficientFundsRetries": true,
  "capLimited": "2023-11-07T05:31:56Z",
  "forceAllowRefunds": true,
  "dynamicDescriptorEnabled": true,
  "dynamicDescriptorPrefix": "<string>",
  "dynamicDescriptorPrefix_MC": "<string>",
  "dynamicDescriptorFormat": 123,
  "bankAuthFee": 123,
  "bankDeclineFee": 123,
  "bankAVSFee": 123,
  "customFee": 123,
  "customFeeApprovedOnly": 123,
  "notes": "<string>",
  "caid": "<string>",
  "chargebackMitigationProviderId": 123,
  "chargebackMitigationNotes": "<string>",
  "processorPortalAccessId": 123,
  "rowVersion": 123,
  "merchantDefinedField1": "<string>",
  "merchantDefinedField2": "<string>",
  "merchantDefinedField3": "<string>",
  "customField1": "<string>",
  "customField2": "<string>",
  "customField3": "<string>",
  "midOwnerId": 123,
  "currencies": [
    {
      "currency": "<string>",
      "gatewayCredentials": {
        "apiKey": "<string>",
        "username": "<string>",
        "password": "<string>",
        "emailAddress": "<string>",
        "processorId": "<string>"
      }
    }
  ],
  "company": "<string>",
  "gateway": "<string>",
  "vertical": "<string>",
  "brand": "<string>",
  "chargebackMitigationProvider": "<string>",
  "processorPortalAccess": "<string>",
  "parentCompanyId": 123,
  "parentCompany": "<string>",
  "requiresZip": true,
  "paymendStoreId": "<string>"
}

Authorizations

Authorization · string · header · required

Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account

Headers

ClientId · string · required

Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight

UserEmail · string · required

The email address of the party or group making the request

Path Parameters

id · integer · required

ID of the merchant account to retrieve

Response

200 - application/json

Success

id · integer

Internal identifier for the merchant account

mid · string

Merchant Identification Number (MID) issued by the payment processor

title · string

Human-readable name of the merchant account

companyId · integer

ID of the company that owns this MID

agent · string

Facilitator or agent responsible for the account

acquiringBank · string

Name of the acquiring bank

gatewayId · integer

Payment gateway identifier

enabledMastercard · boolean

Indicates if Mastercard is enabled

enabledVisa · boolean

Indicates if Visa is enabled

descriptor · string

Transaction descriptor used on customer bank statements

mcc · string

Merchant Category Code

acquirerBINVisa · string

Visa Acquirer Bank Identification Number

acquirerBINMastercard · string

Mastercard Acquirer Bank Identification Number

psp · string

Payment Service Provider name

maxPrice · number

Maximum allowed transaction amount

verticalId · integer

Business vertical identifier

monthlyCap · integer

Monthly volume cap for this merchant account

reservePercentage · number

Reserve percentage for held funds. Note that this must be entered as a decimal (e.g., 0.10 for 10%)

discountRatePercentage · number

Discount rate applied to transactions. Note that this must be entered as a decimal (e.g., 0.10 for 10%)

gatewayTransactionFee · number

Fee per transaction charged by the gateway

chargebackFee · number

Fee charged per chargeback

routingNumber · string

Bank routing number

accountNumber · string

Bank account number

brandId · integer

Identifier for the brand this MID is associated with

allowPremiumProgram · boolean

Indicates if the account is eligible for premium services

fullyLive · boolean

Indicates whether the MID is fully live

shorthandSuffix · string

Suffix for shorthand MID references

defaultCurrency · string

Default transaction currency

rdrFee · number

Fee for Rapid Dispute Resolution services

ethocaFee · number

Fee for Ethoca alert services

cdrnFee · number

Fee for Cardholder Dispute Resolution Network

allowRetriesFromOtherMids · boolean

Allow retrying failed transactions through other MIDs

allowInsufficientFundsRetries · boolean

Retry transactions that failed due to insufficient funds

capLimited · string<date-time>

Date and time when cap was limited

forceAllowRefunds · boolean

Allow refunds even if other restrictions apply

dynamicDescriptorEnabled · boolean

Enable dynamic descriptors

dynamicDescriptorPrefix · string

Prefix for dynamic descriptors

dynamicDescriptorPrefix_MC · string

Mastercard-specific dynamic descriptor prefix

dynamicDescriptorFormat · integer

Dynamic descriptor format code

bankAuthFee · number

Authorization fee charged by the bank

bankDeclineFee · number

Fee charged on declined transactions

bankAVSFee · number

Fee for address verification services

customFee · number

Custom transaction fee

customFeeApprovedOnly · number

Custom fee applied only to approved transactions

notes · string

Internal notes for this MID

caid · string

Custom Acquiring Identifier

chargebackMitigationProviderId · integer

ID of the chargeback mitigation provider

chargebackMitigationNotes · string

Notes about the chargeback mitigation strategy

processorPortalAccessId · integer

Identifier for processor portal access method

rowVersion · integer

Concurrency control version (timestamp)

merchantDefinedField1 · string

Custom field defined by the merchant that can be sent to the gateway

merchantDefinedField2 · string

Custom field defined by the merchant that can be sent to the gateway

merchantDefinedField3 · string

Custom field defined by the merchant that can be sent to the gateway

customField1 · string

Custom field defined by the merchant for custom use, e.g Merchant specific Status flags

customField2 · string

Custom field defined by the merchant for custom use

customField3 · string

Custom field defined by the merchant for custom use

midOwnerId · integer

Set as 0 by default or 1 if this is an external SaleShield mid

currencies · object[]

List of supported currencies with gateway credentials

Show child attributes

company · string

Company name

gateway · string

Gateway name

vertical · string

Business vertical

brand · string

Brand name

chargebackMitigationProvider · string

Name of the chargeback mitigation provider

processorPortalAccess · string

Description of processor portal access method

parentCompanyId · integer

Identifier for the parent company

parentCompany · string

Name of the parent company

requiresZip · boolean

Indicates if a ZIP/postal code is required for transactions on this merchant account

paymendStoreId · string

Paymend-defined store identifier associated with this merchant account