> ## 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.

# Settle a payment request by reference

> Settle a payment request located by its card-provider reference.

Settles a payment request you identify by its card-provider reference instead of its ID: the account comes from `paymentRequestReference.cardProviderReference` (`type` + `referenceId`) and the request from its `externalId`. Behavior and response — including the `{ "fiat": <number>, "crypto": "<string>" }` amount objects — match [settling by ID](/api-reference/Finance-API/payment-requests/settle-a-payment-request).

Send a unique `idempotencyKey`; repeating the same key and body returns the original result.

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


## OpenAPI

````yaml api-reference/Finance-API-Specs.yaml POST /payment-requests/settlements
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:
  /payment-requests/settlements:
    post:
      tags:
        - Payment Requests
      summary: Settle a payment request by card-provider reference
      description: >
        Settles a payment request identified by its card-provider reference
        instead of a path ID: the request is located from
        `paymentRequestReference.cardProviderReference` (`type` + `referenceId`)
        and its `externalId`. Behaviour and response match [settle a payment
        request](#operation/settlePaymentRequest).
      operationId: settlePaymentRequestByReference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettlePaymentRequestByReferenceInput'
            example:
              paymentRequestReference:
                cardProviderReference:
                  type: paymentology
                  referenceId: ACC-12345
                externalId: TID-67890
              amount: 25
              currency: USD
              idempotencyKey: 7c9e6679-7425-40de-944b-e07fc1f90ae7
      responses:
        '202':
          description: Settlement accepted; on-chain processing is asynchronous
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SinglePaymentRequestResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    SettlePaymentRequestByReferenceInput:
      type: object
      required:
        - paymentRequestReference
        - amount
        - currency
        - idempotencyKey
      description: Settles a payment request identified by its card-provider reference.
      properties:
        paymentRequestReference:
          $ref: '#/components/schemas/PaymentRequestReference'
        amount:
          type: number
          description: Final settlement amount, in the authorized fiat currency
        currency:
          type: string
          minLength: 1
          description: Must match the authorized currency
        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'
    PaymentRequestReference:
      type: object
      required:
        - cardProviderReference
        - externalId
      description: >-
        Identifies a payment request by the card-provider reference of its
        account plus the request's `externalId` — used by the "by reference"
        settle/reverse endpoints.
      properties:
        cardProviderReference:
          $ref: '#/components/schemas/CardProviderReference'
        externalId:
          type: string
          minLength: 1
          description: The payment request's externalId (e.g. the card-provider TID)
    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
    CardProviderReference:
      type: object
      required:
        - type
        - referenceId
      properties:
        type:
          type: string
          minLength: 1
          description: Card provider type identifier (case-sensitive)
        referenceId:
          type: string
          minLength: 1
          description: Unique reference ID from the card provider
    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.
    Conflict:
      description: Resource conflict / optimistic-lock failure (409)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: concurrent-modification
                message: >-
                  This request has been modified by another user. Please refresh
                  and try again.
    UnprocessableEntity:
      description: >-
        Idempotency conflict — the key was reused with a different body, or
        replays an operation that originally failed (422)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            errors:
              - code: idempotency-conflict
                message: >-
                  This idempotency key was already used with a different
                  request.
    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: {}

````