---
title: "List payment rules"
method: GET
path: "/payment/v1/rules"
tags: ["Fiat Payments"]
---

# List payment rules

`GET /payment/v1/rules`

## Request

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

Retrieves a list of all payment rules configured for your account.

## Response `200`

OK

- PaymentRuleResponse[]
  - `id` string, uuid: Unique identifier for the payment rule. You can use this value to update the rule via [`/payment/v1/rules/{id}](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-rule-update).
  - `reference` string
  - `trigger` string
  - `status` string: Rule status. `ACTIVE` while the rule applies to incoming pay-ins on the wallet.
  - `fees` object
    - `customerFee` object
      - `amount` number
      - `currency` string
  - `originator` object
    - `currency` string
    - `walletId` string
  - `beneficiary` object
    - `currency` string
    - `entity` object
      - `legalName` string
      - `type` string
      - `relationshipType` string
      - `registrationNumber` string
      - `address` object
        - `addressLine1` string
        - `addressLine2` string
        - `city` string
        - `region` string: State or region. Sent as `stateCode` in the create request.
        - `postCode` string: Postal code. Sent as `postalCode` in the create request.
        - `country` string
    - `cryptoAddresses` object: Destination crypto address, sent as `cryptoAddress` in the create request. The address is returned in the `addresses` array.
      - `network` string
      - `addresses` string[]
      - `tag` string
  - `metadata` Metadata: Custom metadata key-value pairs. Structure: key: value. Restrictions: - Maximum five keys. - Each key maximum length 50 characters. - Each value maximum length 100 characters. - Keys and values must be simple strings.
  - `updatedAt` string, date-time
  - `createdAt` string, date-time

## Other responses

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

## Changes

- **2026-06-16** `97d6c0d2fe2e`: 3 breaking, 3 warning, 3 info
  - the `details/errors` response's property type changed from `object` to `array` for status `400`
  - the `details/errors` response's property type changed from `object` to `array` for status `401`
  - the `details/errors` response's property type changed from `object` to `array` for status `403`
  - removed the optional property `details/errors/requestBody` from the response with the `400` status
  - …5 more

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/payment/v1/rules/get.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)