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

# Withdraw Marketplace Order

> [!NOTE]
>
> Available to businesses approved for the marketplace. See [Marketplace](https://docs.afriex.com/api-reference/endpoint/marketplace/introduction.md).


## OpenAPI

````yaml DELETE /api/v1/market-place/order/{orderId}
openapi: 3.1.0
info:
  title: Afriex Business API
  version: 1.0.14
  description: >-
    Welcome to the Afriex Business API. This API allows you to manage customers,

    process payments, handle payouts, and receive real-time notifications via

    webhooks.


    For detailed guidance on authentication, pagination, error handling, and

    webhooks, please refer to the [dedicated

    guides](https://docs.afriex.com) in the top bar. The guide

    provides a step-by-step instructions to help you integrate seamlessly.


    ## Testing in sandbox


    Send requests to `https://sandbox.api.afriex.com` with a sandbox API key.

    No real money moves. Deposits, payouts and virtual accounts can be tested

    on every payment method and currency your business supports.


    **When transactions complete.** A sandbox deposit or payout completes on

    its own about 5 minutes after it is created, and your webhook receives the

    final status, exactly as in production. To complete one sooner:


    - Include `SIMULATE_INSTANT` anywhere in `meta.reference` when you create
      it, and it completes in about 30 seconds.
    - Or call `POST /api/v1/transaction/{transactionId}/simulate` with
      `{"outcome": "success"}` or `{"outcome": "failed"}` to complete it now.

    **Choosing an outcome.** The last four digits of the account number, the

    phone number or the card number decide what happens. A payment method with

    none of these (an email or a wallet address) succeeds unless you complete it

    with `/simulate`:


    | Ends in | Payout | Mobile money deposit | Card deposit |

    | --- | --- | --- | --- |

    | anything else | Succeeds | Succeeds | Succeeds |

    | `0001` | Fails; your balance is refunded | Fails | Fails |

    | `0002` | Succeeds | Waits for a one-time password (see below) | Succeeds |

    | `0003` | Stays pending until you call `/simulate` | Stays pending until
    you call `/simulate` | Stays pending until you call `/simulate` |

    | `0004` | Account name lookup (`GET /api/v1/payment-method/resolve`) fails
    | Succeeds | Succeeds |

    | `0005` | Declined immediately | Declined immediately | Declined
    immediately |


    A phone number must still be a valid mobile number for its country, so keep

    the country prefix and change only the last digits, for example

    `+254712340002` in Kenya. Account name lookups return `Sandbox Test
    Account`.


    **One-time passwords.** A mobile money deposit from a wallet ending in

    `0002` returns `CUSTOMER_ACTION_REQUIRED`. Complete it with

    `POST /api/v1/transaction/{transactionId}/authorize` and the OTP `123456`;

    any other OTP returns `OTP_INCORRECT`. The deposit then completes as above.


    **Virtual accounts.** Sandbox virtual accounts receive no money on their

    own. Pay into one with

    `POST /api/v1/payment-method/virtual-account/simulate-transfer`.


    **Cards.** The API does not create card payment methods or card deposits.

    Cards are collected on the hosted checkout page; use a test card number

    whose last four digits choose the outcome.


    **Balances and webhooks.** Fund your sandbox balance with

    `POST /api/v1/org/balance/topup`, and send yourself a sample webhook with

    `POST /api/v1/webhooks/trigger`.


    ## Request IDs


    Every response, successful or not, carries an `x-request-id` header that

    identifies that one request. Log it with your request, and include it when

    you contact support about a request: it lets us find that request in our

    logs. Treat it as an opaque string; each request gets a new one.
  termsOfService: https://www.afriex.com/terms-and-condition
  contact:
    name: Afriex API Support
    email: support@afriex.com
    url: https://docs.afriex.com
  license:
    name: Proprietary
    url: https://www.afriex.com/terms-and-condition
servers:
  - url: https://sandbox.api.afriex.com
    description: Sandbox Base URL
  - url: https://api.afriex.com
    description: Production Base URL
security:
  - ApiKey: []
tags:
  - name: Balance
    description: View your business wallet balances.
  - name: Checkout Sessions
    description: Create hosted checkout sessions.
  - name: Rates
    description: Fetch real-time exchange rates.
  - name: Customers
    description: Create and manage your customers.
  - name: Payment Methods
    description: Register and resolve customer payout and collection methods.
  - name: Media
    description: Generate presigned URLs for secure file uploads.
  - name: Transactions
    description: Create and track deposits, withdrawals, and swaps.
  - name: Payment Batches
    description: >-
      Manage payment batches, their recipients and their runs.


      Where payload signing is enabled for your business, sign the JSON of the
      request body for POST and PATCH routes that take one. For GET routes with
      `page` and `limit`, and for the withdraw route, sign the query parameters
      as the server reads them, with defaults applied: a list call with no
      parameters signs `{"limit":100,"page":0}` and a withdraw with no
      `sessionId` signs `{}`. For the remaining routes (get, delete and
      remove-recipient) sign the path parameters, e.g. `{"batchId":"..."}`.
  - name: SME Registration
    description: >-
      Register your business as an SME so its virtual accounts are issued under
      its own legal entity.
  - name: Sandbox helpers
    description: >-
      Sandbox-only endpoints for testing: top up your balance, complete a
      transaction, pay into a virtual account, and send yourself a webhook.
  - name: Marketplace
    description: Create, list and withdraw marketplace orders.
  - name: Webhooks
    description: Webhook event payloads.
paths:
  /api/v1/market-place/order/{orderId}:
    parameters:
      - $ref: '#/components/parameters/x-api-signature'
      - $ref: '#/components/parameters/x-api-version'
      - name: orderId
        in: path
        required: true
        schema:
          type: string
    delete:
      tags:
        - Marketplace
      summary: Withdraw one of the current business's orders
      operationId: removeMarketPlaceOrder
      responses:
        '204':
          description: The order was withdrawn.
        '404':
          description: The order does not exist or belongs to another business.
components:
  parameters:
    x-api-signature:
      name: x-api-signature
      in: header
      required: false
      description: >-
        Signature of the request payload, used for request authentication where
        payload signing is enabled for your business.
      schema:
        type: string
    x-api-version:
      name: x-api-version
      in: header
      required: false
      description: >-
        API version in ISO 8601 format. The only supported version is
        `2026-05-18`, which is also the default when the header is omitted. Any
        other value is rejected with a `400 Bad Request`.
      schema:
        type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Static business API key issued from the dashboard. A business can

        provision **multiple API keys**, each scoped to a configurable set

        of **permissions** (e.g. read transactions, create deposits, etc).

        Permissions are chosen per key at creation time in the dashboard

        and may be revoked by deleting the key. Manage your keys and

        their permissions under **Developer → API keys** in the dashboard.


        A request whose key does not carry the permission the target

        endpoint requires is rejected with `401 Unauthorized`, the same

        response an unrecognised, malformed, revoked or disabled key

        returns. The API does not distinguish the two cases on the wire.


        See the [Permissions
        reference](https://docs.afriex.com/api-reference/permissions)

        for the permission each endpoint requires.

````

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