Skip to main content
PATCH
/
api
/
v2
/
merchant
/
{merchantId}
Update merchant
curl --request PATCH \
  --url https://api.loopcrypto.xyz/api/v2/merchant/{merchantId} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>' \
  --data '
{
  "merchantName": "Loop Inc.",
  "merchantRefId": "mer_29347"
}
'
{
  "merchantId": "1234567890abcdef",
  "merchantName": "Loop Inc.",
  "merchantRefId": "1234567890",
  "payoutDestinations": [
    {
      "networkId": 1,
      "walletAddress": "0x1234567890abcdef",
      "isDefault": true,
      "payoutDestinationId": "1234567890abcdef",
      "settlementType": "Crypto"
    }
  ],
  "fiatSettlementAccount": {
    "provider": "Fern",
    "kycStatus": "pending",
    "kycLink": "https://www.google.com",
    "bankAccountStatus": "Pending",
    "bankAccountFormLink": "https://www.google.com"
  },
  "paymentTypes": [
    {
      "symbol": "USDC",
      "networkId": 1,
      "tokenId": "d9e1f2a3-b4c5-6d7e-8f9g-0h1i2j3k4l5m",
      "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "decimals": 6,
      "isDefault": true
    }
  ]
}

Authorizations

​
api-key
string
header
required
​
entity-id
string
header
required

Path Parameters

​
merchantId
string
required

The unique identifier of the merchant to update. This must be a valid merchant ID associated with your entity. Used to identify the specific merchant to update

Body

application/json
​
merchantName
string

(Optional) The new name to update for the merchant. If not provided, the existing name will be kept unchanged

Example:

"Loop Inc."

​
merchantRefId
string

(Optional) The new reference ID to update for the merchant. If not provided, the existing reference ID will be kept unchanged

Example:

"mer_29347"

Response

Ok

​
merchantId
string
required

The unique identifier for the merchant

Example:

"1234567890abcdef"

​
merchantName
string
required

The name that identifies the merchant

Example:

"Loop Inc."

​
merchantRefId
string | null
required

The unique reference ID used to identify the merchant in external systems

Example:

"1234567890"

​
payoutDestinations
object[]
required

The payout destinations supported by the organization

​
fiatSettlementAccount
object
required

The fiat settlement configuration for the entity when fiat settlement is enabled for any payout destination

​
paymentTypes
object[]
required

The payment types supported by the merchant