For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API GuideAPI ReferenceChangelog
API GuideAPI ReferenceChangelog
  • API Reference
      • API Integration
        • Legacy APIs
            • POSTMake a Payment
            • GETReview Payments
            • GETView a Payment
  • Webhook Reference
LogoLogo
API ReferenceCustomersAPI IntegrationLegacy APIsLegacy Payments

Make a Payment

POST
/v2/customers/:customer_id/payments
POST
/v2/customers/:customer_id/payments
$curl -X POST https://sandbox.currenciesdirect.com/v2/customers/cust_123456789/payments \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "recipient_id": "743512",
>  "purpose_of_transaction": "PENSION",
>  "amount": 1.91,
>  "payment_reference": "saving 225",
>  "client_reference_id": "987564823645",
>  "confirm_recipient": {
>    "customer_action": "override",
>    "request_identifier": "123456789",
>    "event_id": "AG-435435454435"
>  }
>}'
1{
2  "payment_id": "2908362",
3  "instruction_number": "0202000005923566-000000011",
4  "currency_code": "string",
5  "amount": 51749.42,
6  "recipient_details": {
7    "recipient_id": 743512,
8    "recipient_name": "Bob Nighy",
9    "country_code": "GBR"
10  },
11  "status": "PENDING",
12  "payment_reference": "saving 225",
13  "created_datetime": "2019-01-24T12:38:46Z",
14  "payment_date": "2019-01-24"
15}
<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 ```
Was this page helpful?
Previous

Review Payments

Next
Built with

Deprecated: This endpoint is deprecated. Please use Create Payment (v3) instead.

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 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 or View a Payment endpoints.

Authentication: Bearer token required

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired
Unique Customer Identifier

Request

This endpoint expects an object.
recipient_idstringRequired

The Payee ID used to identify this Recipient.

Reference: Get Recipients

purpose_of_transactionstringRequired

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

amountdoubleRequired
Amount of the payment.
payment_referencestringRequired1-35 characters

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_idstringOptional<=36 characters
Unique reference id that you want to assign to this payment for your own purposes.
confirm_recipientobjectOptional

Container for confirmation of recipient details.

This object is required only when the initial API call fails due to a Confirmation of Payee (CoP) or Verification of Payee (VoP) 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
  • SEPA Verification of Payee (VoP) Guide

Response

Ok. A payment was initiated.
payment_idstring
Payment ID
instruction_numberstring

Unique client reference to identify this conversion in future. The format will be {customerId}-{sequenceNumber}

currency_codestring

Recipient’s Currency Code.

Reference: ISO 4217

amountdouble
Amount being debited.
recipient_detailsobject
statusstring
Status of this payment.
payment_referencestring
Description to appear on the Recipient's bank statement.
created_datetimedatetime
Timestamp of the payment
payment_datedate
Date when the payment was completed.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error