---
title: "Create new payment"
method: POST
path: "/v1/payments"
tags: ["Card payments"]
---

# Create new payment

`POST /v1/payments`

Create a new payment for the account associated to the Authorisation token. The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

## Request body

- CreateCardPaymentRequest — The Payment Request Payload
  - `amount` integer, required — amount in pence
  - `reference` string, required — payment reference
  - `description` string, required — payment description
  - `language` 'ENGLISH' | 'WELSH' — ISO-639-1 Alpha-2 code of a supported language to use on the payment pages
  - `email` string — email
  - `return_url` string, required — service return url
  - `delayed_capture` boolean — delayed capture flag
  - `metadata` ExternalMetadata
    - `metadata` object
  - `prefilled_cardholder_details` PrefilledCardholderDetails
    - `cardholder_name` string — prefilled cardholder name
    - `billing_address` Address — A structure representing the billing address of a card
      - `line1` string
      - `line2` string
      - `postcode` string
      - `city` string
      - `country` string

## Response `201`

Created

- CreatePaymentResult
  - `amount` integer
  - `state` PaymentState — A structure representing the current state of the payment in its lifecycle.
    - `status` string — Current progress of the payment in its lifecycle
    - `finished` boolean — Whether the payment has finished
    - `message` string — What went wrong with the Payment if it finished with an error - English message
    - `code` string — What went wrong with the Payment if it finished with an error - error code
  - `description` string
  - `reference` string
  - `language` 'ENGLISH' | 'WELSH'
  - `payment_id` string
  - `payment_provider` string
  - `return_url` string
  - `created_date` string
  - `delayed_capture` boolean
  - `_links` PaymentLinks — links for payment
    - `self` Link — A link related to a payment
      - `href` string
      - `method` string
    - `next_url` Link — A link related to a payment
      - `href` string
      - `method` string
    - `next_url_post` PostLink — A POST link related to a payment
      - `type` string
      - `params` object
      - `href` string
      - `method` string
    - `events` Link — A link related to a payment
      - `href` string
      - `method` string
    - `refunds` Link — A link related to a payment
      - `href` string
      - `method` string
    - `cancel` PostLink — A POST link related to a payment
      - `type` string
      - `params` object
      - `href` string
      - `method` string
    - `capture` PostLink — A POST link related to a payment
      - `type` string
      - `params` object
      - `href` string
      - `method` string
  - `provider_id` string
  - `metadata` object
  - `refund_summary` RefundSummary — A structure representing the refunds availability
    - `status` string — Availability status of the refund
    - `amount_available` integer — Amount available for refund in pence
    - `amount_submitted` integer — Amount submitted for refunds on this Payment in pence
  - `settlement_summary` SettlementSummary — A structure representing information about a settlement
    - `capture_submit_time` string — Date and time capture request has been submitted (may be null if capture request was not immediately acknowledged by payment gateway)
    - `captured_date` string — Date of the capture event

## Other responses

- `400` — Bad request
- `401` — Credentials are required to access this resource
- `422` — Invalid attribute value: description. Must be less than or equal to 255 characters length
- `429` — Too many requests
- `500` — Downstream system error

## Changes

- **2019-08-01** `6e01c8022b87` — 2 info
  - api tag `Card payments` added
  - api tag `Card Payments` removed
- **2019-07-31** `f8066d82895d` — 1 info
  - api operation id `newPayment` removed and replaced with `Create a payment`
- **2019-07-31** `ef50a2b1c4f1` — 1 info
  - api tag `Card Payments` added
- **2019-02-22** `89daf4ffa64f` — 2 info
  - api operation id `Create a payment` removed and replaced with `newPayment`
  - api tag `Card payments` removed

[Change history](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/changes/v1/payments/post.md)

---

[API](https://skmtc.dev/alphagov/apis/gov-uk-pay-api.md) · [All operations](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/llms.txt) · [OpenAPI document](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/revisions/6e01c8022b87?raw)