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

# Create transfer

> Send money to a recipient's mobile money account

# Create Transfer

Initiating a single transfer allows you to send funds to a recipient from your Adullam account. Use the Create Transfer API to specify transfer details such as amount, currency, and recipient information.


## OpenAPI

````yaml post /v1/transfers
openapi: 3.0.3
info:
  title: Adullam Payment API
  version: 1.0.0
  description: >
    Adullam is a payment processing platform for mobile money transactions in
    West Africa.


    This API enables developers to:

    - Collect payments from customers via mobile money

    - Send money to recipients

    - Track transactions and account balance


    ## Authentication

    All endpoints (except auth endpoints) require Bearer token authentication.


    ## Base URL

    Production: `https://api.adullam.dev`


    ## Rate Limiting

    - 100 requests per minute

    - 1000 requests per hour
  contact:
    email: support@adullam.dev
    url: https://docs.adullam.dev
  license:
    name: Proprietary
    url: https://adullam.dev/terms
servers:
  - url: https://api.adullam.dev
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Partner authentication and token management
  - name: Payments
    description: Collect money from customers via mobile money
  - name: Transfers
    description: Send money to recipients via mobile money
  - name: Account
    description: Account and balance management
paths:
  /v1/transfers:
    post:
      tags:
        - Transfers
      summary: Create transfer
      description: Send money to a recipient's mobile money account
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTransferRequest'
      responses:
        '201':
          description: Transfer created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Transfer'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientFunds'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      schema:
        type: string
        format: uuid
      description: UUID for idempotent requests
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    CreateTransferRequest:
      type: object
      required:
        - amount
        - currency
        - recipient_phone
        - channel
      properties:
        amount:
          type: integer
          minimum: 100
          example: 10000
        currency:
          type: string
          enum:
            - XOF
          example: XOF
        recipient_phone:
          type: string
          pattern: ^\+225[0-9]{8,10}$
          example: '+22507123456'
        channel:
          type: string
          enum:
            - orangeCI
            - mtnCI
            - moovCI
            - waveCI
          example: mtnCI
        description:
          type: string
          maxLength: 200
          example: Salary payment
        reference:
          type: string
          maxLength: 100
          example: PAY_001
        metadata:
          type: object
          additionalProperties:
            type: string
          example:
            employee_id: EMP_123
    Transfer:
      type: object
      properties:
        id:
          type: string
          example: txf_abc123
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
          example: processing
        amount:
          type: integer
          example: 10000
        currency:
          type: string
          example: XOF
        recipient_phone:
          type: string
          example: '+22507123456'
        recipient_name:
          type: string
          nullable: true
          example: DIALLO IBRAHIM
        channel:
          type: string
          enum:
            - orangeCI
            - mtnCI
            - moovCI
            - waveCI
          example: mtnCI
        description:
          type: string
          example: Salary payment
        reference:
          type: string
          example: PAY_001
        ussd_reference:
          type: string
          nullable: true
          example: MP240115.1032.T98765
        fees:
          type: integer
          example: 50
        metadata:
          type: object
          additionalProperties:
            type: string
          example:
            employee_id: EMP_123
        created_at:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        completed_at:
          type: string
          format: date-time
          nullable: true
          example: null
        failure_reason:
          type: string
          nullable: true
          example: null
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - invalid_request
                - insufficient_funds
                - rate_limit_exceeded
                - channel_error
                - transaction_failed
                - server_error
              example: invalid_request
            code:
              type: string
              example: amount_too_low
            message:
              type: string
              example: Amount must be at least 100 XOF
            field:
              type: string
              nullable: true
              example: amount
            request_id:
              type: string
              example: req_abc123
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: invalid_parameter
              message: Invalid parameter provided
              request_id: req_abc123
    Unauthorized:
      description: Unauthorized - Invalid or missing authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: invalid_token
              message: Invalid or expired access token
              request_id: req_abc123
    InsufficientFunds:
      description: Insufficient funds in account
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: insufficient_funds
              code: balance_too_low
              message: Account balance is insufficient for this transfer
              request_id: req_abc123
    Conflict:
      description: Conflict - Idempotency key conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: idempotency_key_conflict
              message: Idempotency key already used with different parameters
              request_id: req_abc123
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: validation_error
              message: Amount must be at least 100 XOF
              field: amount
              request_id: req_abc123
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use the access token obtained from /v1/auth/token

````