Make a Payment
<Warning>
**Deprecated**: This endpoint is deprecated. Please use [Create Payment](/api-reference/customers/api-integration/payments/create-payment) (v3) instead.
</Warning>
This will initiate the process of sending money to a Recipient. As preparation for this call you could make a GET request to the [Recipients](/api-reference/customers/api-integration/recipients/get-recipients) resource to check that the recipient has not been deleted.
**Payment Processing:**
The payment is processed in the background, meaning the API returns immediately with a success response containing a `payment_id` and initial `status` of "pending". The actual payment processing continues after the response is returned. To check the current status of the payment, make a GET request to the [Review Payments](/api-reference/customers/api-integration/legacy-ap-is/legacy-payments/review-payments) or [View a Payment](/api-reference/customers/api-integration/legacy-ap-is/legacy-payments/view-payment) endpoints.
**Authentication:** [Bearer token required](/api-guide/getting-started/authentication#oauth-20-authentication)
```mermaid
flowchart TD
A[Actor]
subgraph I1["Iteration 1"]
B["POST /v2/customers/{customerId}/payments"]
end
subgraph I2["Iteration 2"]
C["POST /v2/customers/{customerId}/payments<br/>(with confirm_recipient section)"]
end
D["Create Payment"]
E(("Success"))
F(("Stop"))
G["Error response<br/>(code and description)"]
H["CoP check failed<br/>or any other error"]
A --> B
A --> C
B -->|1| D
C -->|3| D
D -->|Success| E --> F
D -->|2| H --> G --> A
```
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
customer_id
Unique Customer Identifier
Request
This endpoint expects an object.
recipient_id
The Payee ID used to identify this Recipient.
**Reference:** [Get Recipients](http://localhost:3000/api-reference/customers/api-integration/recipients/get-recipients#response.body.recipients.recipient_id)
purpose_of_transaction
Purpose of the transaction. A list of possible values can be obtained with a GET request to the transaction-purpose resource.
Reference: Get Transaction Purposes
amount
Amount of the payment.
payment_reference
Description to appear on the Recipient’s bank statement and should not contain any special character. If recipient is UK based and is a collection account, use payment_reference of recipient. It should not contain any special character.
client_reference_id
Unique reference id that you want to assign to this payment for your own purposes.
confirm_recipient
Container for confirmation of recipient details.
This object is required only when the initial API call fails due to a [Confirmation of Payee (CoP)](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/) or [Verification of Payee (VoP)](https://www.europeanpaymentscouncil.eu/what-we-do/other-schemes/verification-payee) check failure.
If the failure is related to CoP/VoP, the API response will include a `details` field containing only the recipients whose CoP/VoP checks failed. Each recipient in `details` field will have a `request_identifier` and `event_id`, which must be used in the subsequent retry request along with the appropriate `customer_action`.
Detailed instructions for handling these scenarios can be found in:
- [UK Confirmation of Payee (CoP) Guide](/api-guide/regulatory-guides/cop-guide)
- [SEPA Verification of Payee (VoP) Guide](/api-guide/regulatory-guides/vop-guide)
Response
Ok. A payment was initiated.
payment_id
Payment ID
instruction_number
Unique client reference to identify this conversion in future. The format will be {customerId}-{sequenceNumber}
currency_code
Recipient's Currency Code.
**Reference:** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
amount
Amount being debited.
recipient_details
status
Status of this payment.
payment_reference
Description to appear on the Recipient's bank statement.
created_datetime
Timestamp of the payment
payment_date
Date when the payment was completed.
