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

# Create recipient

> Register an NGN bank recipient.

Recipient creation is idempotent and must use a unique request ID.


## OpenAPI

````yaml post /v2/ramp/{storeId}/banking/recipients
openapi: 3.0.3
info:
  title: Bullring Partner API
  version: 1.0.0
  description: >-
    Signed NGN partner endpoints. The playground can show request and response
    schemas; generate X-Digital-Signature from the exact raw request bytes
    before sending.
  license:
    name: Proprietary
    url: https://www.bullring.finance/tos
servers:
  - url: https://sandbox-api.bullring.finance
    description: Sandbox
  - url: https://api.bullring.finance
    description: Production
security:
  - partnerSignature: []
tags:
  - name: Deposits
    description: NGN deposit instructions, deposit history and sandbox simulation.
  - name: Recipients
    description: NGN bank recipient registration and lookup.
  - name: Withdrawals
    description: NGN withdrawal creation and status lookup.
  - name: Conversion quotes
    description: Read-only exchange and fee quotes.
paths:
  /v2/ramp/{storeId}/banking/recipients:
    post:
      tags:
        - Recipients
      summary: Create an NGN recipient
      operationId: createRecipient
      parameters:
        - $ref: '#/components/parameters/StoreId'
        - $ref: '#/components/parameters/SignatureHeaders'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipientRequest'
      responses:
        '201':
          description: Created recipient
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipient'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '502':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    StoreId:
      name: storeId
      in: path
      required: true
      schema:
        type: string
        format: uuid
    SignatureHeaders:
      name: X-Key-Id
      in: header
      required: true
      description: >-
        Also send X-Timestamp, X-Idempotency-Id and X-Digital-Signature. Sign
        the exact raw request bytes.
      schema:
        type: string
        example: prod-2026-02
  schemas:
    RecipientRequest:
      type: object
      required:
        - currency
        - payment_rail
        - bank_name
        - account_number
        - bank_code
      properties:
        currency:
          type: string
          example: NGN
        payment_rail:
          type: string
          example: BANK_TRANSFER
        bank_name:
          type: string
          example: Parkway
        account_number:
          type: string
          example: '8120001540'
        bank_code:
          type: string
          example: '058'
    Recipient:
      type: object
      properties:
        id:
          type: string
          format: uuid
        account_owner_name:
          type: string
        active:
          type: boolean
        currency:
          type: string
        account_id:
          type: string
        payment_rail:
          type: string
        bank_name:
          type: string
        last_4:
          type: string
    ApiError:
      type: object
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
        code:
          type: string
        message: {}
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
              code:
                type: string
              message: {}
    Unauthorized:
      description: Missing or invalid signature
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Scope or store access denied
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Idempotency or state conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServerError:
      description: Temporary service failure
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    partnerSignature:
      type: apiKey
      in: header
      name: X-Key-Id
      description: >-
        This selects the registered RSA public key. Also send X-Timestamp,
        X-Idempotency-Id and X-Digital-Signature.

````

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