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

# Request a receiving account

> Set up bank receiving details for a supported currency.

**Required scope:** `fiat_wallet`

Send the currency and an Idempotency-Key. Retrying the same request returns the original result; reusing the key with changed inputs returns 409. Your business must have access to receiving accounts and permission to create them. HTTP 200 means the account is ready; HTTP 202 means the request is pending. Keep the original key when checking or retrying the request.


## OpenAPI

````yaml /openapi/public.yaml post /v1/virtual-accounts
openapi: 3.1.0
info:
  title: Ledig payments API
  version: 0.1.0
  description: >-
    Use the Ledig payments engine to receive funds, view balances, convert
    currencies and send payments.


    Choose Sandbox to test your integration or Live for production payments.
    Each endpoint explains the fields, permissions and errors you need to
    handle.


    Sign API requests with your business API key and HMAC-SHA256. Endpoints
    listing BearerAuth also accept a user access token. Follow
    https://docs.ledig.io/auth/authentication to sign your requests.
  contact:
    name: Ledig
    email: support@ledig.io
    url: https://docs.ledig.io
servers:
  - url: https://api-sandbox.ledig.io
    description: Sandbox
  - url: https://api.ledig.io
    description: Live
security:
  - LedigApiKey: []
    LedigTimestamp: []
    LedigSignature: []
tags:
  - name: Managed businesses
    description: Onboarding for businesses you manage.
  - name: System
    description: Health and availability.
  - name: Balances
    description: Your available and reserved funds by currency.
  - name: Currencies and rates
    description: Supported currencies, networks and indicative rates.
  - name: Funding accounts
    description: Fiat accounts that receive customer deposits.
  - name: Deposit wallets
    description: Crypto addresses that receive customer deposits.
  - name: Recipients
    description: Saved payout destinations.
  - name: Ledig businesses
    description: Find a business before paying through the Ledig network.
  - name: Payment options
    description: Available payout methods, fees and limits.
  - name: Quotes
    description: Confirm rates, fees and amounts before sending.
  - name: Transfers
    description: Start and track conversions and payments.
  - name: Transactions
    description: Customer transaction history.
paths:
  /v1/virtual-accounts:
    post:
      tags:
        - Funding accounts
      summary: Request a receiving account
      description: Set up bank receiving details for a supported currency.
      operationId: createVirtualAccount
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - currency
              properties:
                currency:
                  type: string
                  minLength: 1
                  maxLength: 10
                provider:
                  type: string
                  minLength: 1
                  maxLength: 30
                accountName:
                  type: string
                  minLength: 1
                  maxLength: 100
                intent:
                  type: string
                  enum:
                    - resume
                    - additional
            example:
              currency: USD
              intent: resume
      responses:
        '200':
          description: The issued account or the original completed result.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    required:
                      - data
                    properties:
                      data:
                        $ref: '#/components/schemas/ClientVirtualAccount'
              example:
                status: success
                data:
                  id: account_example_001
                  profileId: profile_example_001
                  currencyCode: USD
                  accountName: Example Supplies Ltd
                  accountNumber: '0000000000'
                  bankName: Example Bank
                  bankCode: EXAMPLE
                  status: active
                  disabledAt: null
                  meta: {}
                  createdAt: '2026-01-15T10:00:00.000Z'
                  updatedAt: '2026-01-15T10:00:00.000Z'
        '202':
          description: >-
            Your receiving account request is pending. Keep the original
            idempotency key.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - status
                  - data
                properties:
                  status:
                    const: success
                  data:
                    type: object
                    additionalProperties: false
                    required:
                      - id
                      - currency
                      - status
                      - missing
                      - accountId
                    properties:
                      id:
                        type: string
                      currency:
                        type: string
                        pattern: ^[A-Z][A-Z0-9]{1,11}$
                      status:
                        type: string
                        enum:
                          - requested
                          - manual_review
                          - pending_provider
                          - completed
                      missing:
                        type: array
                        items:
                          type: string
                      accountId:
                        type:
                          - string
                          - 'null'
              example:
                status: success
                data:
                  id: account_request_example_001
                  currency: USD
                  status: requested
                  missing: []
                  accountId: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: >-
            import { createHmac } from "node:crypto";


            // Node.js 18+. Set credentials and resource values on your server.

            function required(name) {
              const value = process.env[name];
              if (!value) throw new Error(`Set ${name} before running this example.`);
              return value;
            }


            const baseUrl = process.env.LEDIG_API_BASE_URL ??
            "https://api-sandbox.ledig.io";

            const method = "POST";

            const path = `/v1/virtual-accounts`;

            const pathWithQuery = path;

            const body = {
              "currency": "USD",
              "intent": "resume"
            };

            const rawBody = JSON.stringify(body);

            const headers = { "Accept": "application/json" };

            headers["Content-Type"] = "application/json";

            // Keep this value and the same body when retrying this request.

            headers["Idempotency-Key"] = required("LEDIG_IDEMPOTENCY_KEY");

            const timestamp = Math.floor(Date.now() / 1000).toString();

            const payload =
            `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;

            headers["x-ledig-key"] = required("LEDIG_API_KEY");

            headers["x-ledig-timestamp"] = timestamp;

            headers["x-ledig-signature"] = "v1=" + createHmac("sha256",
            required("LEDIG_API_SECRET"))
              .update(payload).digest("base64");

            const response = await fetch(`${baseUrl}${pathWithQuery}`, {
              method,
              headers,
              body: rawBody,
            });

            const result = await response.json();

            // Use result in your application; do not log credentials or upload
            links.

            console.log(response.status);
components:
  parameters:
    IdempotencyKey:
      in: header
      name: Idempotency-Key
      required: true
      schema:
        type: string
      description: >-
        A unique value for this request. On endpoints that require it, retry
        with the same key and identical inputs to avoid creating the operation
        twice.
      example: example-request-001
  schemas:
    Success:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          const: success
        message:
          type: string
    ClientVirtualAccount:
      type: object
      additionalProperties: false
      description: Your business's bank receiving details and funding instructions.
      required:
        - id
        - profileId
        - currencyCode
        - accountName
        - accountNumber
        - bankName
        - bankCode
        - status
        - disabledAt
        - meta
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        profileId:
          type: string
        currencyCode:
          type: string
        accountName:
          type: string
        accountNumber:
          type: string
        bankName:
          type: string
        bankCode:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
        status:
          type: string
          enum:
            - active
            - disabled
        disabledAt:
          type:
            - string
            - 'null'
        meta:
          $ref: '#/components/schemas/ClientFundingInstructions'
    ClientFundingInstructions:
      type: object
      additionalProperties: false
      description: >-
        Current instructions for adding funds. Include the memorandum whenever
        these instructions require one.
      properties:
        network:
          type:
            - string
            - 'null'
        memorandum:
          type:
            - string
            - 'null'
        bicCode:
          type:
            - string
            - 'null'
        bankAddress:
          type: object
          additionalProperties: false
          properties:
            fullAddress:
              type:
                - string
                - 'null'
            countryCode:
              type:
                - string
                - 'null'
            city:
              type:
                - string
                - 'null'
            region:
              type:
                - string
                - 'null'
            postalCode:
              type:
                - string
                - 'null'
        transactionFee:
          type: object
          additionalProperties: false
          properties:
            value:
              type:
                - string
                - 'null'
            asset:
              type:
                - string
                - 'null'
    Error:
      type: object
      required:
        - status
        - message
        - code
      properties:
        status:
          type: string
          const: error
        message:
          type: string
        code:
          type: string
        details:
          description: >-
            Additional information to help resolve an error, such as a file
            problem, allowed amount range or remaining payment allowance. The
            fields depend on the error code.
          oneOf:
            - type: object
              additionalProperties: false
              description: >-
                File-validation details returned with HTTP 400, 413 or 422
                BAD_REQUEST.
              required:
                - validationCode
                - reasonCode
                - retryable
              properties:
                validationCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                reasonCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                retryable:
                  type: boolean
                  const: false
                documentId:
                  type: string
                  maxLength: 128
                requirementType:
                  type: string
                maxSizeBytes:
                  type: integer
                  minimum: 1
                  maximum: 1073741824
                  description: >-
                    Maximum accepted file size in bytes, when supplied with HTTP
                    413.
            - type: object
              additionalProperties: false
              required:
                - reason
              properties:
                reason:
                  type: string
                  enum:
                    - current_password_incorrect
                    - unsupported_asset_network
                    - recipient_unavailable
                    - recipient_incompatible
                    - payout_method_unavailable
                    - payout_method_incompatible
                    - network_unavailable
                    - quote_expired
                    - quote_already_used
                    - quote_changed
                    - invoice_required
                    - invoice_invalid
                    - amount_invalid
                    - amount_precision_invalid
                    - onboarding_revision_required
                    - onboarding_revision_changed
                    - onboarding_document_kind_mismatch
                precision:
                  type: integer
                  minimum: 0
                  maximum: 18
                  description: >-
                    Allowed number of decimal places when reason is
                    amount_precision_invalid.
            - type: object
              additionalProperties: false
              required:
                - period
                - sourceCurrency
                - requested
                - remaining
                - limit
                - resetsAt
                - timezone
              properties:
                period:
                  type: string
                  enum:
                    - daily
                    - monthly
                sourceCurrency:
                  type: string
                  pattern: ^[A-Z][A-Z0-9]{1,19}$
                requested:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                remaining:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                limit:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
            - type: object
              additionalProperties: false
              required:
                - sourceCurrency
                - minimumAmount
                - maximumAmount
              properties:
                sourceCurrency:
                  type: string
                minimumAmount:
                  type: string
                maximumAmount:
                  type: string
              description: >-
                Returned with HTTP 422 RATE_ROUTE_AMOUNT_OUT_OF_RANGE. These
                limits apply to the amount being converted, in the source
                currency.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - limitUsd
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                limitUsd:
                  type: string
              description: >-
                Returned with HTTP 422 PAYOUT_TRANSACTION_LIMIT_EXCEEDED. This
                per-payment limit uses USD equivalent and is separate from the
                payout method's currency limits.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - remainingUsd
                - resetsAt
                - timezone
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                remainingUsd:
                  type: string
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
              description: >-
                Returned with HTTP 422 PAYOUT_MONTHLY_LIMIT_EXCEEDED. Shows your
                business's remaining monthly allowance and when it resets.
  responses:
    BadRequest:
      description: The request is invalid. Check the error message and submitted fields.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: BAD_REQUEST
            message: Check the request fields and try again.
    Unauthorized:
      description: >-
        Authentication is missing, invalid or expired. Check your credentials
        and request signature.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: UNAUTHORIZED
            message: Authentication is required.
    Forbidden:
      description: >-
        Your account is inactive, the business selection is missing, or your
        credentials do not have the required permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: FORBIDDEN
            message: You do not have permission to perform this action.
    Conflict:
      description: >-
        The request conflicts with an existing resource or a newer saved
        version.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: CONFLICT
            message: The request conflicts with the current state of this resource.
    RateLimited:
      description: >-
        A request or operation allowance has been reached. Wait before retrying.
        If the endpoint uses an idempotency key, keep the same key for the
        retry.
      headers:
        Retry-After:
          description: The number of seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
        Cache-Control:
          description: >-
            Responses use private, no-store or no-store. Do not cache this
            response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: RATE_LIMITED
            message: Too many requests. Wait before trying again.
    ServiceUnavailable:
      description: >-
        The requested service is temporarily unavailable. Follow the retry
        guidance for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: PROVIDER_UNAVAILABLE
            message: This service is temporarily unavailable. Please try again later.
  securitySchemes:
    LedigApiKey:
      type: apiKey
      in: header
      name: x-ledig-key
      description: >-
        Your business API key ID. Keep its secret on your server and use that
        secret to sign each request.
    LedigTimestamp:
      type: apiKey
      in: header
      name: x-ledig-timestamp
      description: The current Unix timestamp in seconds, used in the signed request.
    LedigSignature:
      type: apiKey
      in: header
      name: x-ledig-signature
      description: >-
        The request's HMAC-SHA256 signature. Use the v1= prefix for supported
        own-business requests, or v2= when acting for a managed business with
        signed business-selection headers. Follow the authentication guide to
        construct and sign the exact request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.