> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create VertoFx Payment Request

> Create VertoFX Payment Request

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**Description:**\
The `/integrations/vertofx/payment-requests` endpoint allows creation of new payment requests through VertoFX.

**Method:** `POST`

**Request Payload:**

| Parameter     | Type   | Description                              |
| ------------- | ------ | ---------------------------------------- |
| beneficiaryId | string | ID of the beneficiary to send payment to |
| amount        | number | Amount to be sent                        |
| currency      | string | Currency code                            |
| walletId      | string | ID of the wallet to send from            |
| reference     | string | Payment reference                        |
| memo          | string | Optional memo for the payment            |

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/integrations/vertofx/payment-requests', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "beneficiaryId": "sample-beneficiaryId",
      "amount": 1,
      "currency": "sample-currency",
      "walletId": "sample-walletId",
      "reference": "sample-reference",
      "memo": "sample-memo"
    })
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
    'https://api.royalti.io/integrations/vertofx/payment-requests',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={"beneficiaryId":"sample-beneficiaryId","amount":1,"currency":"sample-currency","walletId":"sample-walletId","reference":"sample-reference","memo":"sample-memo"}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.royalti.io/integrations/vertofx/payment-requests \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"beneficiaryId":"sample-beneficiaryId","amount":1,"currency":"sample-currency","walletId":"sample-walletId","reference":"sample-reference","memo":"sample-memo"}'

  ```
</CodeGroup>


## OpenAPI

````yaml post /integrations/vertofx/payment-requests
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /integrations/vertofx/payment-requests:
    post:
      tags:
        - VertoFx
      summary: Create VertoFx Payment Request
      description: >-
        Create VertoFX Payment Request


        **Description:**  

        The `/integrations/vertofx/payment-requests` endpoint allows creation of
        new payment requests through VertoFX.


        **Method:** `POST`


        **Request Payload:**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | beneficiaryId | string | ID of the beneficiary to send payment to |

        | amount | number | Amount to be sent |

        | currency | string | Currency code |

        | walletId | string | ID of the wallet to send from |

        | reference | string | Payment reference |

        | memo | string | Optional memo for the payment |
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                beneficiaryId:
                  type: string
                  description: ID of the beneficiary to send payment to
                amount:
                  type: number
                  description: Amount to be sent
                currency:
                  type: string
                  description: Currency code
                walletId:
                  type: string
                  description: ID of the wallet to send from
                reference:
                  type: string
                  description: Payment reference
                memo:
                  type: string
                  description: Optional memo for the payment
              required:
                - beneficiaryId
                - amount
                - currency
                - walletId
                - reference
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                  message:
                    type: string
              example:
                success: true
                message: Payment request created successfully
                data:
                  paymentId: vfx-payment-123
                  status: pending
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````