Sign in
Payment Rules

List payment rules

get/payment_rules

Query parameters

account_idstring

Only return rules belonging to this account. Defaults to the account the request is acting for.

status'active' | 'inactive' | 'deleted'

Only return rules with this status.

action'allow' | 'block' | 'review' | 'enforce_3ds'

Only return rules that take this action.

order'created_at'

The field to sort by.

direction'asc' | 'desc'

The sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

A list of payment rules

Example response

{
  "data": [
    {
      "account_id": "biz_xxxxxxxxxxxxxx",
      "action": "block",
      "conditions": {
        "all": [
          {
            "field": "risk_score",
            "operator": "gte"
          }
        ]
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "id": "prule_xxxxxxxxxxxxxx",
      "metadata": {},
      "name": "Block high risk",
      "status": "active",
      "updated_at": "2026-01-01T12:00:00.000Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 3 of the 74 revisions of this API.52

  • 78e1ed7366cd1See the full diff
    • ●

      added the new card_bin enum value to the ///// response property for the response status

      response-property-enum-value-added

  • ef86d14ef69141See the full diff
    • ●

      added the new amount_in_usd enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new in_cidr enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new ip_address enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new review enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value review to the query request parameter action

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ff3a765735631See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 74 revisions, 1 has no diff computed.