---
title: "POST /external-payments"
method: POST
path: "/external-payments"
tags: ["External Payments"]
---

# POST /external-payments

`POST /external-payments`

Creates a new external payment

## Request body

- CreateExternalPaymentRequest — Request body for creating an external payment
  - `transactionId` string, required — Transaction ID (used as idempotency key). Must be unique per workspace.
  - `amount` string, required — Amount in smallest currency unit (e.g., cents)
  - `accountReference` string, required — Reference to the external account
  - `invoiceId` string, required — ID of the invoice this payment is for
  - `counterpartyId` string, required — External ID of the counterparty making the payment

## Response `201`

Success

- ExternalPaymentSuccessResponse
  - `data` ExternalPayment, required — External payment object
    - `workspaceId` string, required — Workspace ID this payment belongs to
    - `transactionId` string, required — Transaction ID (idempotency key)
    - `amount` string, required — Amount in smallest currency unit (represented as string for bigint)
    - `accountReference` string, required — Reference to the external account
    - `invoiceId` string, required — ID of the invoice this payment is for
    - `counterpartyId` string, required — External ID of the counterparty making the payment
    - `created` string, date-time, required — ISO 8601 timestamp when the payment was created
    - `modified` string, date-time — ISO 8601 timestamp when the payment was last modified

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `500` — Internal server error

## Changes

- **2026-01-27** `ec5eb2a41457` — 2 info
  - the endpoint scheme security `oauth2` was added to the API
  - the endpoint scheme security `Bearer` was removed from the API

[Change history](https://skmtc.dev/fragment-dev/apis/fragment-payments-api/changes/external-payments/post.md)

---

[API](https://skmtc.dev/fragment-dev/apis/fragment-payments-api.md) · [All operations](https://skmtc.dev/fragment-dev/apis/fragment-payments-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fragment-dev/apis/fragment-payments-api/revisions/ec5eb2a41457?raw)