---
updatedAt: 2025-11-11T09:19:54.000Z
agentTools:
  projectIndex: https://convera.readme.io/llms.txt
---

# Process VOP Consent (Prefunded)

Allows customers to provide consent for VOP (Verification of Payee) payments using Prefunded architecture. Customer ID is provided in the request body. When consent is true, the VOP_Hold flag is set to false. When consent is false, the VOP_Hold flag remains true and payment status is updated to Rejected.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.1.0",
    "title": "Payments API"
  },
  "x-explorer-enabled": false,
  "servers": [
    {
      "url": "https://masspaysandbox.api.convera.com/MassPayments",
      "description": "Staging"
    },
    {
      "url": "https://api.convera.com/v1/masspayments",
      "description": "Production"
    }
  ],
  "paths": {
    "/payments/consentvop": {
      "put": {
        "tags": [
          "VOP Consent"
        ],
        "summary": "Process VOP Consent (Decoupled)",
        "description": "Allows customers to provide consent for VOP (Verification of Payee) payments using decoupled architecture. Customer ID is provided in the request body. When consent is true, the VOP_Hold flag is set to false. When consent is false, the VOP_Hold flag remains true and payment status is updated to Rejected.",
        "operationId": "Payments_PutVOPConsent",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VOPConsentRequestData"
              }
            }
          },
          "description": "VOP consent request data containing payment IDs and consent decisions",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK - VOP consent processed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VOPConsentResultData"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid request data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "VOPConsentRequestData": {
        "type": "object",
        "properties": {
          "customerId": {
            "type": "string",
            "description": "The customer ID for whom the VOP consent is being processed"
          },
          "paymentConsents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentConsentWebData"
            },
            "description": "List of payment consent data"
          }
        },
        "required": [
          "customerId",
          "paymentConsents"
        ]
      },
      "PaymentConsentWebData": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "External payment ID to take action on"
          },
          "consent": {
            "type": "boolean",
            "description": "Customer consent decision (true/false)"
          }
        },
        "required": [
          "paymentId",
          "consent"
        ]
      },
      "VOPConsentResultData": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Overall result message"
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentConsentResultData"
            },
            "description": "Individual payment consent results"
          }
        }
      },
      "PaymentConsentResultData": {
        "type": "object",
        "properties": {
          "paymentId": {
            "type": "string",
            "description": "Payment ID that was processed"
          },
          "success": {
            "type": "boolean",
            "description": "Whether the consent processing was successful"
          },
          "status": {
            "type": "string",
            "description": "Current status of the payment (Approved/Rejected)"
          },
          "errorMessage": {
            "type": "string",
            "description": "Error message if processing failed"
          }
        }
      }
    }
  }
}
```