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

# Create a payment request

> Request settlement of a payment from an account's crypto balance.

Creates a payment request for an account, reserving funds from its wallet for settlement. The response carries the request `status` (`PENDING`/`RESERVED`) and an `executions` array with the on-chain `transactionHash`; the amount moves to the wallet's `reserved` balance. Send a unique `idempotencyKey` per request ([safe retries](/getting-started/conventions#idempotency)).

**Concept guide:** [Payment requests](/guides/finance/payment-requests)

<Note>The account must be **verified**, and (self-custody) its wallet **`ACTIVE`** with an allowance, before a payment can be reserved. See [Account verification](/guides/finance/kyc-verification) and [Approving transfers without gas](/guides/finance/permits-and-allowances).</Note>

<Info>`amount` and `originalAmount` are returned as **objects** — `{ "fiat": <number>, "crypto": "<string>" }` — not scalars. There is **no GET endpoint** for payment requests: the full object (including `executions`) is only returned on this create call, so persist the response if you need it later.</Info>


## OpenAPI

````yaml api-reference/Finance-API-Specs.yaml POST /accounts/{accountId}/payment-requests
openapi: 3.1.0
info:
  title: Venly Finance API
  description: >
    REST API for the Venly Finance platform:

    - Party management (Individuals & Organisations)

    - Account management with party association

    - Wallet balances & token allowances on supported chains (Base, Avalanche)

    - Virtual bank account assignment for global payments (EUR SEPA)

    - Fiat-to-crypto payment sessions (pay-in)

    - Account-to-account fiat & crypto transfers

    - EIP-2612 permits and payment requests


    ## Authentication


    All endpoints use OAuth2 client credentials. Obtain a token first, then
    include it in every request:


    **Step 1 — Get a token:**

    ```bash

    curl -X POST
    https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
    \
      -H "Content-Type: application/x-www-form-urlencoded" \
      -d "grant_type=client_credentials&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}"
    ```


    **Step 2 — Use the token:**

    ```

    Authorization: Bearer {access_token}

    ```


    Tokens expire after **5 minutes**. Implement refresh logic in your client.
  version: 1.1.0
  contact:
    name: Venly Support
    email: support@venly.io
    url: https://docs.venlyfinance.com
  license:
    name: Proprietary
  x-logo:
    url: https://venlyfinance.com/logo.png
  x-security-contact: security@venly.io
servers:
  - url: https://api.venlyfinance.com/v1
    description: Production
  - url: https://api-staging.venlyfinance.com/v1
    description: Staging
security:
  - OAuth2: []
tags:
  - name: Parties
    description: Party management (Individuals & Organisations)
  - name: Accounts
    description: Account management, party-role associations
  - name: Wallets
    description: Blockchain wallet balances
  - name: Virtual Bank Accounts
    description: Virtual bank account payment references for global payments
  - name: Fiat-to-crypto Payment Sessions
    description: Fiat-to-crypto payment session creation
  - name: Payment Requests
    description: Payment request management for card provider integrations
  - name: Transfers
    description: Fiat and crypto transfer operations between accounts
  - name: Permits
    description: EIP-712 permit signature management for token approvals
  - name: Allowances
    description: Token allowance management for wallets
paths:
  /accounts/{accountId}/payment-requests:
    post:
      tags:
        - Payment Requests
      summary: Create payment request for account
      description: >
        Creates a payment request for an account, reserving funds from its
        wallet for the payment. The response returns `status: RESERVED`, moves
        the reserved amount into the wallet's `reserved` balance, and includes
        an `executions` array — each entry carrying its on-chain
        `transactionHash`. Send a unique `idempotencyKey` per request.
      operationId: createPaymentRequest
      parameters:
        - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentRequestInput'
            example:
              amount: 25
              currency: USD
              externalId: order-67890
              description: 'Order #67890'
              idempotencyKey: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '201':
          description: Payment request created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SinglePaymentRequestResponse'
              example:
                success: true
                result:
                  id: d4e5f6a7-b8c9-4012-8345-6789abcdef01
                  accountId: b2a1f0e9-8c7d-4e3a-9f21-0a1b2c3d4e5f
                  amount:
                    fiat: 25
                    crypto: '25.000000'
                  originalAmount:
                    fiat: 25
                    crypto: '25.000000'
                  currency: USD
                  externalId: order-67890
                  description: 'Order #67890'
                  status: RESERVED
                  executions:
                    - id: e5f6a7b8-c9d0-4123-9456-789abcdef012
                      walletPairId: f6a7b8c9-d0e1-4234-a567-89abcdef0123
                      type: AUTHORIZATION
                      chain: BASE
                      asset: USDC
                      amount: 25
                      exchangeRate: 1
                      status: RESERVED
                      transactionHash: >-
                        0xa1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2
                      createdAt: '2026-01-15T09:30:00Z'
                      updatedAt: '2026-01-15T09:30:02Z'
                  createdAt: '2026-01-15T09:30:00Z'
                  updatedAt: '2026-01-15T09:30:02Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    AccountId:
      name: accountId
      in: path
      required: true
      description: Unique account identifier
      schema:
        type: string
        format: uuid
      example: b2a1f0e9-8c7d-4e3a-9f21-0a1b2c3d4e5f
  schemas:
    CreatePaymentRequestInput:
      type: object
      required:
        - amount
        - currency
        - idempotencyKey
      properties:
        amount:
          type: number
          description: Payment amount
        currency:
          type: string
          minLength: 1
          description: Currency code (e.g. EUR, USD)
        externalId:
          type: string
          description: Optional external reference ID
        description:
          type: string
          description: Optional payment description
        idempotencyKey:
          type: string
          minLength: 1
          description: Unique key to prevent duplicate operations on retry
    SinglePaymentRequestResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            result:
              $ref: '#/components/schemas/PaymentRequest'
    BaseResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful
    PaymentRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
        accountId:
          type: string
          format: uuid
        amount:
          $ref: '#/components/schemas/PaymentRequestAmount'
        originalAmount:
          $ref: '#/components/schemas/PaymentRequestAmount'
        settlementAmount:
          $ref: '#/components/schemas/PaymentRequestAmount'
        settledAmount:
          $ref: '#/components/schemas/PaymentRequestAmount'
        shortfallAmount:
          $ref: '#/components/schemas/PaymentRequestAmount'
        currency:
          type: string
        externalId:
          type: string
        description:
          type: string
        status:
          $ref: '#/components/schemas/PaymentRequestStatus'
        settledAt:
          type: string
          format: date-time
          description: >-
            When settlement completed (terminal SETTLED /
            SETTLED_WITH_SHORTFALL)
        reversalReason:
          $ref: '#/components/schemas/ReversalReason'
        reversalDescription:
          type: string
          description: Optional free-text reason supplied on reversal
        reversedAt:
          type: string
          format: date-time
          description: When the reversal completed
        executions:
          type: array
          items:
            $ref: '#/components/schemas/PaymentExecution'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      description: Error response wrapper
      properties:
        success:
          type: boolean
          description: Always false for error responses
          example: false
        errors:
          type: array
          description: List of errors that occurred
          items:
            $ref: '#/components/schemas/ErrorBody'
        result:
          type: object
          nullable: true
          description: Null or omitted when success is false
    PaymentRequestAmount:
      type: object
      description: >-
        Payment amount, expressed in both the request fiat currency and the
        settled crypto amount. `amount` is the request's current value;
        `originalAmount` preserves the value at creation time (the two can
        diverge after an adjustment).
      properties:
        fiat:
          type: number
          description: Amount in the request `currency` (e.g. USD)
        crypto:
          type: string
          description: Settled crypto amount as a decimal string (e.g. USDC)
    PaymentRequestStatus:
      type: string
      description: Status of a payment request
      enum:
        - PENDING
        - RESERVED
        - SETTLING
        - SETTLED
        - SETTLED_WITH_SHORTFALL
        - REVERSING
        - REVERSED
        - FAILED
    ReversalReason:
      type: string
      description: Why a payment request was reversed (recorded for audit).
      enum:
        - CUSTOMER_CANCELLATION
        - MERCHANT_VOID
        - ACQUIRER_FAILURE
        - NETWORK_DECLINE
        - OTHER
    PaymentExecution:
      type: object
      description: A single on-chain settlement attempt for a payment request
      properties:
        id:
          type: string
          format: uuid
        walletPairId:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/PaymentExecutionType'
        chain:
          $ref: '#/components/schemas/BlockchainNetwork'
        asset:
          type: string
        amount:
          type: number
        exchangeRate:
          type: number
        status:
          $ref: '#/components/schemas/PaymentExecutionStatus'
        transactionHash:
          type: string
        errorMessage:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorBody:
      type: object
      description: Individual error details
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid-request
        message:
          type: string
          description: Human-readable error message
          example: The request contains invalid parameters.
    PaymentExecutionType:
      type: string
      description: The role an execution plays in a payment request's lifecycle.
      enum:
        - AUTHORIZATION
        - INCREMENTAL_AUTHORIZATION
        - AUTHORIZATION_ADJUSTMENT
        - SETTLEMENT
        - SETTLEMENT_OVERAGE
        - REFUND
        - REVERSAL
    BlockchainNetwork:
      type: string
      description: Supported blockchain network
      enum:
        - AVALANCHE
        - BASE
        - POLYGON
    PaymentExecutionStatus:
      type: string
      description: Status of a single payment-request execution
      enum:
        - PENDING
        - RESERVED
        - SETTLED
        - REVERSED
        - FAILED
  responses:
    BadRequest:
      description: Request validation failed (400)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: invalid-request
                message: The request contains invalid parameters.
    Unauthorized:
      description: Authentication required or failed (401)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: unauthenticated
                message: Please authenticate to perform this action.
    Forbidden:
      description: Caller lacks the required authority/role (403)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: forbidden
                message: You do not have permission to access this resource.
    NotFound:
      description: Resource not found (404)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: account-not-found
                message: The requested resource was not found.
    InternalServerError:
      description: Unexpected server error (500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: internal-error
                message: An unexpected error occurred. Please try again later.
  securitySchemes:
    OAuth2:
      type: oauth2
      description: >
        OAuth2 client credentials flow. Token endpoints:

        - Staging:
        https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

        - Production:
        https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
      flows:
        clientCredentials:
          tokenUrl: >-
            https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
          scopes: {}

````