---
title: "Update payment rule"
method: PATCH
path: "/payment/v1/rules/{id}"
tags: ["Fiat Payments"]
---

# Update payment rule

`PATCH /payment/v1/rules/{id}`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/payment/v1/rules/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/payment/v1/rules/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Partially updates a previously created payment rule. Only properties included in the request are updated; omitted fields remain unchanged. Setting a nullable property to null clears it.

## Path parameters

- `id` string, uuid, required

## Request body

- object: Any subset of updatable fields may be provided.
  - `fees` object: Use to charge a fee from your end customer.
    - `customerFee` MoneyFeeV2
      - `amount` number, required: Fee amount in fiat or crypto currency units.
      - `currency` string, required: Currency code. Supports both fiat (ISO-4217) and cryptocurrencies.
  - `beneficiary` object: Details about the recipient of the crypto funds.
    - `currency` string: The cryptocurrency being sent.
    - `entity` union
      - PaymentRuleIndividualUpdate
        - `type` 'INDIVIDUAL': Entity type
        - `customerIdentifier` string: Unique customer reference.
        - `firstName` string: First name
        - `lastName` string: Last name
        - `dateOfBirth` string, date: Date of birth in YYYY-MM-DD format
        - `address` PaymentRuleAddress
          - `addressLine1` string, required: Main address
          - `addressLine2` string: Apartment numbers or suite number
          - `postalCode` string, required: Postal code
          - `city` string, required: City
          - `country` string, required: 2-letter country code in the ISO 3166-1 alpha-2 format.
          - `stateCode` string: 2-letter state code. **Required for US customers**.
        - `relationshipType` 'SELF_OWNED' | 'THIRD_PARTY': Relationship type
      - PaymentRuleCompanyUpdate
        - `type` 'COMPANY': Entity type
        - `customerIdentifier` string: Unique customer reference.
        - `legalName` string: Legal company name
        - `registrationNumber` string: Company registration number.
        - `address` PaymentRuleAddress
          - `addressLine1` string, required: Main address
          - `addressLine2` string: Apartment numbers or suite number
          - `postalCode` string, required: Postal code
          - `city` string, required: City
          - `country` string, required: 2-letter country code in the ISO 3166-1 alpha-2 format.
          - `stateCode` string: 2-letter state code. **Required for US customers**.
        - `relationshipType` 'SELF_OWNED' | 'THIRD_PARTY': Relationship type
    - `cryptoAddress` PaymentRuleCryptoAddressUpdate: Crypto destination details.
      - `network` 'TRON' | 'ETHEREUM' | 'LITECOIN' | 'BITCOIN' | 'RIPPLE' | 'DOGECOIN' | 'SOLANA' | 'ALGORAND' | 'CARDANO' | 'BINANCE' | 'POLYGON' | 'BITCOIN_CASH' | 'ARC' | 'ARBITRUM' | 'BASE': Blockchain network.
      - `address` string: Crypto wallet address.
      - `tag` string: Optional tag for certain cryptocurrencies (e.g., XRP, XLM).

## Response `200`

Rule updated.

- object

## Other responses

- `400`: Bad request.
- `401`: Unauthorized.
- `403`: Forbidden.

## Changes

- **2026-11-06** `c386d436bf2c`: 13 breaking, 2 warning, 3 info
  - the request property `beneficiary/cryptoAddress/address` became not nullable
  - the request property `beneficiary/cryptoAddress/tag` became not nullable
  - the request property `beneficiary/entity/anyOf[#/components/schemas/PaymentRuleCompanyUpdate]/customerIdentifier` became not nullable
  - the request property `beneficiary/entity/anyOf[#/components/schemas/PaymentRuleCompanyUpdate]/legalName` became not nullable
  - …14 more
- **2026-06-16** `97d6c0d2fe2e`: 1 warning, 1 info
  - removed the request property `cryptoAddress`
  - added the new optional request property `beneficiary/cryptoAddress`

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/payment/v1/rules/:id/patch.md)

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)