---
title: "Creating a new External Payment"
method: POST
path: "/external_payments"
tags: ["External Payments"]
---

# Creating a new External Payment

`POST /external_payments`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/external_payments`
- Auth: none declared

Creates an external payment for the specified project or invoice. If an invoice ID is provided, a
payment is only created for that invoice when it's a single project invoice and in a non-draft pending state.


This endpoint returns structured External Payment objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `external_payments` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `include` string

## Request body

- object
  - `external_payment` object
    - `workspace_id` integer, required: The ID of the project in which the payment will be created.
    - `invoice_id` integer: The ID of the invoice (if any) that is being paid by the external payment. This automatically sets the amount attribute of the payment to the amount of the specified invoice, and will override any `amount_in_cents` parameter sent.
    - `amount_in_cents` integer: Indicates that the payment is not for an invoice, and will be ignored if an `invoice_id` is provided. Must be in base cent units of the currency of the project in which the payment is created.
    - `message` string: An optional string describing the payment (255 characters maximum).

## Response `200`

External Payment has been created.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `external_payments` object
  - `users` object
  - `workspaces` object
  - `invoices` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)