GET
/
merchantAccounts
/
{merchantAccountId}
Retrieve a Merchant Account
curl --request GET \
  --url https://prod.api.palomma.com/v0/merchantAccounts/{merchantAccountId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "01HPR8QBF5QKA313RPBSKYB7DS",
  "description": "<string>",
  "unsettledAmount": 500000,
  "payoutLimitBalance": 200000,
  "type": "aggregator",
  "availableBalance": 1000000,
  "payinsEnabled": true,
  "payoutsEnabled": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
merchantAccountId
string
required

Unique identifier of the merchant account.

Response

Merchant Account retrieved successfully.

​
id
string

Unique identifier for this Merchant Account.

Example:

"01HPR8QBF5QKA313RPBSKYB7DS"

​
description
string

Text configured on creation to identify the Merchant Account.

​
unsettledAmount
number

Amount of money in the Merchant Account that is not yet settled.

Example:

500000

​
payoutLimitBalance
number

Remaining balance for which payouts can be made. This balance is set optionally to restrict the amount of money that can be paid out from the Merchant Account. It can be replenished by contacting us.

Example:

200000

​
type
enum<string>

Type of the Merchant Account. Merchant Accounts are either aggregator or gateway. Aggregator accounts maintain a balance in Palomma which can be used to make payout requests while gateway accounts automatically withdraw funds on creation of Payin Settlements recurringly.

Available options:
aggregator,
gateway
​
availableBalance
number

Amount of money in the Aggregator Merchant Account that has been settled and is available for payout. Not applicable for Gateway Merchant Accounts.

Example:

1000000

​
payinsEnabled
boolean

Whether payins are enabled for Gateway Merchant Account. Only applicable for Gateway Merchant Accounts, as aggregator accounts are always able to receive payins.

​
payoutsEnabled
boolean

Whether payouts are enabled for Gateway Merchant Account. Only applicable for Gateway Merchant Accounts, as aggregator accounts are always able to make payouts.