Payments

Get wallet policy

Retrieves payment policy rules for a custody wallet. Policies are payment controls layered on top of custody-managed wallets.

get/v1/payments/wallets/{walletId}/policies

Path parameters

walletIdstring required

Provider wallet ID — the walletId field returned by GET /v1/wallets. The wallet record id and the public key are not accepted.

Example:privy_wallet_123

Provider wallet ID — the walletId field returned by GET /v1/wallets. The wallet record id and the public key are not accepted.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

Wallet policy

Example response

{
  "data": {
    "policy": {
      "walletId": "privy_wallet_123",
      "controlProfile": {
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z",
        "activatedAt": "2025-01-01T00:00:00.000Z"
      },
      "audit": {
        "recentEvaluations": [
          {
            "walletOperationId": "wop_example",
            "policyEvaluationId": "peval_example",
            "operationFamily": "payment",
            "operationType": "payment_transfer_execute",
            "asset": "USDC",
            "amount": "100.00",
            "destination": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU",
            "reasonCode": "wallet_policy_match",
            "reason": "Operation family payment matched policy.",
            "approvalRequestId": "appr_example",
            "operationCreatedAt": "2025-01-01T00:00:00.000Z",
            "operationUpdatedAt": "2025-01-01T00:00:00.000Z",
            "evaluatedAt": "2025-01-01T00:00:00.000Z"
          }
        ]
      }
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 4 of the 13 revisions of this API.8614

Aug 25, 2026a04e2929537f22See the full diff
- ▲
  added subschema #2 subschema #6 to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added subschema #2 subschema #6 to the /// response property oneOf list for the response status
  response-property-one-of-added
- ○
  removed subschema #2 subschema #6 from the //// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed subschema #2 subschema #6 from the /// response property oneOf list for the response status
  response-property-one-of-removed
Aug 19, 2026f138f2b5866329See the full diff
- ▲
  added subschema #1 subschema #2 subschema #6 to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added subschema #1 subschema #2 subschema #6 to the /// response property oneOf list for the response status
  response-property-one-of-added
- ○
  removed the issuance enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed the payment enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed the program enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed the provider_admin enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed the ramp enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed the raw_sign enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed the transfer enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed subschema #1 subschema #2 subschema #6 from the //// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed subschema #1 subschema #2 subschema #6 from the /// response property oneOf list for the response status
  response-property-one-of-removed
Aug 15, 20263e302bba53864See the full diff
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new SERVICE_UNAVAILABLE enum value to the / response property for the response status
  response-property-enum-value-added
Aug 12, 2026f6134b5daa7f423See the full diff
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required

Full history