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

# Register a bank account to pay out to (reviewed first)



## OpenAPI

````yaml /openapi.json post /v1/payout_recipients
openapi: 3.1.0
info:
  title: One Pay API
  version: 0.1.0
  description: >-
    One API to collect payments and send payouts across Africa. Amounts are
    integers in minor units (XAF francs, NGN kobo). Guides: the One Pay
    developer docs.
servers:
  - url: https://onepay-api-eiy9.onrender.com
    description: One Pay (your key decides test or live)
  - url: http://localhost:3000
    description: Local development
security:
  - bearerAuth: []
paths:
  /v1/payout_recipients:
    post:
      tags:
        - Payouts
      summary: Register a bank account to pay out to (reviewed first)
      operationId: postV1PayoutRecipients
      parameters:
        - $ref: '#/components/parameters/OptionalIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePayoutRecipientRequest'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipient'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    OptionalIdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: Your unique key for this request; retries reuse it.
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    CreatePayoutRecipientRequest:
      type: object
      properties:
        currency:
          type: string
          const: NGN
        bank_code:
          type: string
          pattern: ^\d{3,6}$
        account_number:
          type: string
          pattern: ^\d{10}$
        name:
          type: string
          minLength: 1
          maxLength: 100
      required:
        - currency
        - bank_code
        - account_number
      additionalProperties: false
    Recipient:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          const: bank_account
        currency:
          type: string
          enum:
            - XAF
            - NGN
        bank_code:
          type: string
        account_number_last4:
          type: string
        name:
          type:
            - string
            - 'null'
        account_name:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - pending_review
            - approved
            - rejected
        status_reason:
          type:
            - string
            - 'null'
        mode:
          type: string
          enum:
            - test
            - live
        created_at:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
      required:
        - id
        - type
        - currency
        - bank_code
        - account_number_last4
        - name
        - account_name
        - status
        - status_reason
        - mode
        - created_at
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
          required:
            - code
            - message
            - request_id
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your secret key: sk_test_... or sk_live_...'

````

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