Update merchant account profile fields (draft-friendly)

PATCH/v1/merchant-accounts/{merchantAccountId}

Authorization

AuthorizationBearer token · headerrequired

Public API key bearer token.

Path parameters

merchantAccountIdstringrequired

Query parameters

environmentstringrequired

merchantAccountIdstringrequired

Header parameters

Idempotency-Keystring

Required for production-safe retries on mutating routes. Reusing a key with a different request body returns 409.

min length 1

Request body

requiredapplication/json

environmentstring

Allowed:sandboxproduction

displayNamestring

merchantModestring

doingBusinessAsstring | null

businessPhonestring | null

businessTaxIdstring | null

phonestring | null

taxIdstring | null

emailstring | null

firstNamestring | null

lastNamestring | null

mccstring | null

urlstring | null

maxTransactionAmountnumber | null

achMaxTransactionAmountnumber | null

annualCardVolumenumber | null

principalPercentageOwnershipnumber | null

hasAcceptedCreditCardsPreviouslyboolean | null

acceptsAchboolean | null

dateOfBirthMerchantProfileDate | any

Show properties

Any of:

MerchantProfileDate

daynumberrequired

monthnumberrequired

yearnumberrequired

any

any

incorporationDateMerchantProfileDate | any

Show properties

Any of:

MerchantProfileDate

daynumberrequired

monthnumberrequired

yearnumberrequired

any

any

businessAddressMerchantAddress | any

Show properties

Any of:

MerchantAddress

line1stringrequired

line2string

citystringrequired

regionstring

postalCodestringrequired

countrystringrequired

any

any

personalAddressMerchantAddress | any

Show properties

Any of:

MerchantAddress

line1stringrequired

line2string

citystringrequired

regionstring

postalCodestringrequired

countrystringrequired

any

any

settlementBankAccountMerchantSettlementBankAccount | any

Show properties

Any of:

MerchantSettlementBankAccount

namestringrequired

accountNumberstringrequired

bankCodestringrequired

accountTypestringrequired

attemptValidationCheckboolean

any

any

associatedIdentitiesMerchantAssociatedIdentity[] | any

Show properties

Any of:

MerchantAssociatedIdentity[]

Array of MerchantAssociatedIdentity

identityRolesstring[]required

relationTypestring

firstNamestring

lastNamestring

titlestring

emailstring

phonestring

taxIdstring

principalPercentageOwnershipnumber

dateOfBirthMerchantProfileDate

Show properties

daynumberrequired

monthnumberrequired

yearnumberrequired

personalAddressMerchantAddress

Show properties

line1stringrequired

line2string

citystringrequired

regionstring

postalCodestringrequired

countrystringrequired

any

any

underwritingMerchantUnderwritingData | any

Show properties

Any of:

MerchantUnderwritingData

annualAchVolumenumber

averageAchTransferAmountnumber

averageCardTransferAmountnumber

businessDescriptionstring

creditCheckAllowedboolean

creditCheckIpAddressstring

creditCheckTimestampstring

creditCheckUserAgentstring

refundPolicystring

cardVolumeDistributionobject

Show properties

cardPresentPercentagenumber

ecommercePercentagenumber

mailOrderTelephoneOrderPercentagenumber

volumeDistributionByBusinessTypeobject

Show properties

businessToConsumerVolumePercentagenumber

consumerToConsumerVolumePercentagenumber

otherVolumePercentagenumber

any

any

metadataobject | any

Show properties

Any of:

object

object

any

any

Responses

200Success

dataobjectrequired

requestIdstringrequired

400Bad request, including malformed JSON

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

401Missing or invalid API key

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

409Conflict, including idempotency body drift

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

422Validation failed

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

429API key rate limit exceeded

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

defaultError

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

Request

curl -X PATCH "https://api.vortex.nyc/v1/merchant-accounts/string?environment=string&merchantAccountId=string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "environment": "sandbox",
  "displayName": "string",
  "merchantMode": "string",
  "doingBusinessAs": "string",
  "businessPhone": "string",
  "businessTaxId": "string",
  "phone": "string",
  "taxId": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "mcc": "string",
  "url": "string",
  "maxTransactionAmount": 0,
  "achMaxTransactionAmount": 0,
  "annualCardVolume": 0,
  "principalPercentageOwnership": 0,
  "hasAcceptedCreditCardsPreviously": true,
  "acceptsAch": true,
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "incorporationDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "businessAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "personalAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "settlementBankAccount": {
    "name": "string",
    "accountNumber": "string",
    "bankCode": "string",
    "accountType": "string",
    "attemptValidationCheck": true
  },
  "associatedIdentities": [
    {
      "identityRoles": [
        "string"
      ],
      "relationType": "string",
      "firstName": "string",
      "lastName": "string",
      "title": "string",
      "email": "string",
      "phone": "string",
      "taxId": "string",
      "principalPercentageOwnership": 0,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0
      },
      "personalAddress": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
      }
    }
  ],
  "underwriting": {
    "annualAchVolume": 0,
    "averageAchTransferAmount": 0,
    "averageCardTransferAmount": 0,
    "businessDescription": "string",
    "creditCheckAllowed": true,
    "creditCheckIpAddress": "string",
    "creditCheckTimestamp": "string",
    "creditCheckUserAgent": "string",
    "refundPolicy": "string",
    "cardVolumeDistribution": {
      "cardPresentPercentage": 0,
      "ecommercePercentage": 0,
      "mailOrderTelephoneOrderPercentage": 0
    },
    "volumeDistributionByBusinessType": {
      "businessToConsumerVolumePercentage": 0,
      "consumerToConsumerVolumePercentage": 0,
      "otherVolumePercentage": 0
    }
  },
  "metadata": {}
}'

const response = await fetch("https://api.vortex.nyc/v1/merchant-accounts/string?environment=string&merchantAccountId=string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "environment": "sandbox",
  "displayName": "string",
  "merchantMode": "string",
  "doingBusinessAs": "string",
  "businessPhone": "string",
  "businessTaxId": "string",
  "phone": "string",
  "taxId": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "mcc": "string",
  "url": "string",
  "maxTransactionAmount": 0,
  "achMaxTransactionAmount": 0,
  "annualCardVolume": 0,
  "principalPercentageOwnership": 0,
  "hasAcceptedCreditCardsPreviously": true,
  "acceptsAch": true,
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "incorporationDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "businessAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "personalAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "settlementBankAccount": {
    "name": "string",
    "accountNumber": "string",
    "bankCode": "string",
    "accountType": "string",
    "attemptValidationCheck": true
  },
  "associatedIdentities": [
    {
      "identityRoles": [
        "string"
      ],
      "relationType": "string",
      "firstName": "string",
      "lastName": "string",
      "title": "string",
      "email": "string",
      "phone": "string",
      "taxId": "string",
      "principalPercentageOwnership": 0,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0
      },
      "personalAddress": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
      }
    }
  ],
  "underwriting": {
    "annualAchVolume": 0,
    "averageAchTransferAmount": 0,
    "averageCardTransferAmount": 0,
    "businessDescription": "string",
    "creditCheckAllowed": true,
    "creditCheckIpAddress": "string",
    "creditCheckTimestamp": "string",
    "creditCheckUserAgent": "string",
    "refundPolicy": "string",
    "cardVolumeDistribution": {
      "cardPresentPercentage": 0,
      "ecommercePercentage": 0,
      "mailOrderTelephoneOrderPercentage": 0
    },
    "volumeDistributionByBusinessType": {
      "businessToConsumerVolumePercentage": 0,
      "consumerToConsumerVolumePercentage": 0,
      "otherVolumePercentage": 0
    }
  },
  "metadata": {}
})
});

import requests

response = requests.patch(
    "https://api.vortex.nyc/v1/merchant-accounts/string?environment=string&merchantAccountId=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "environment": "sandbox",
  "displayName": "string",
  "merchantMode": "string",
  "doingBusinessAs": "string",
  "businessPhone": "string",
  "businessTaxId": "string",
  "phone": "string",
  "taxId": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "mcc": "string",
  "url": "string",
  "maxTransactionAmount": 0,
  "achMaxTransactionAmount": 0,
  "annualCardVolume": 0,
  "principalPercentageOwnership": 0,
  "hasAcceptedCreditCardsPreviously": True,
  "acceptsAch": True,
  "dateOfBirth": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "incorporationDate": {
    "day": 0,
    "month": 0,
    "year": 0
  },
  "businessAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "personalAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "settlementBankAccount": {
    "name": "string",
    "accountNumber": "string",
    "bankCode": "string",
    "accountType": "string",
    "attemptValidationCheck": True
  },
  "associatedIdentities": [
    {
      "identityRoles": [
        "string"
      ],
      "relationType": "string",
      "firstName": "string",
      "lastName": "string",
      "title": "string",
      "email": "string",
      "phone": "string",
      "taxId": "string",
      "principalPercentageOwnership": 0,
      "dateOfBirth": {
        "day": 0,
        "month": 0,
        "year": 0
      },
      "personalAddress": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
      }
    }
  ],
  "underwriting": {
    "annualAchVolume": 0,
    "averageAchTransferAmount": 0,
    "averageCardTransferAmount": 0,
    "businessDescription": "string",
    "creditCheckAllowed": True,
    "creditCheckIpAddress": "string",
    "creditCheckTimestamp": "string",
    "creditCheckUserAgent": "string",
    "refundPolicy": "string",
    "cardVolumeDistribution": {
      "cardPresentPercentage": 0,
      "ecommercePercentage": 0,
      "mailOrderTelephoneOrderPercentage": 0
    },
    "volumeDistributionByBusinessType": {
      "businessToConsumerVolumePercentage": 0,
      "consumerToConsumerVolumePercentage": 0,
      "otherVolumePercentage": 0
    }
  },
  "metadata": {}
},
)

Response

{
  "data": {},
  "requestId": "string"
}