Skip to content

Commit 145e203

Browse files
Merge pull request CurrencyCloud#294 from CurrencyCloud/SWAGGER-317_Add_CoP_Integration_Guide
Swagger 317 add cop integration guide
2 parents 3d120d4 + 7ca160b commit 145e203

12 files changed

+737
-32
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading

data/local/pages/integration-guides/make-simple-payments.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -195,21 +195,13 @@ Content-Type: application/json
195195

196196
## Step 4: Add a beneficiary
197197

198+
If you are a client under the Sponsored or Treasury service model and contracted with The Currency Cloud Limited, then you must [verify the beneficiary's account](/guides/integration-guides/verifying-beneficiary-account) details before creating a beneficiary.
199+
198200
If you know the required details, you can go ahead and create a record for the beneficiary via the [Create Beneficiary](/api-reference/#create-beneficiary) endpoint.
199201

200202
`POST /v2/beneficiaries/create`\
201203
`Content-Type: multipart/form-data`
202204

203-
| Parameter Name | Parameter Type | Example Value |
204-
| --- | --- | --- |
205-
| `name` | Form Data | `Acme GmbH` |
206-
| `bank_account_holder_name` | Form Data | `Acme GmbH` |
207-
| `currency` | Form Data | `EUR` |
208-
| `beneficiary_country` | Form Data | `DE` |
209-
| `bank_country` | Form Data | `DE` |
210-
| `bic_swift` | Form Data | `COBADEFF` |
211-
| `iban` | Form Data | `DE89370400440532013000` |
212-
| `X-Auth-Token` | Header | `ea6d13c7bc50feb46cf978d137bc01a2` |
213205

214206
If the beneficiary is successfully created, the response message will contain full details about the beneficiary as recorded in your Currencycloud account. Note the beneficiary's unique ID (`id`). You'll need this to make a payment to the beneficiary, in the next step.
215207

data/local/pages/integration-guides/overview.md

+5
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,8 @@ This guide demonstrates how to use [push notifications](/guides/getting-started/
5757
5858
Sub-accounts (or named accounts) refer to the multi-currency eWallets you can establish for your customers, which sit within your House Account. This guide explains how to execute transactions on behalf of your customers when sub-accounts are in use.
5959
[`Read guide`](/guides/integration-guides/sub-account-activity/)
60+
61+
## Confirmation of Payee Outbound (UK)
62+
63+
Learn how to verify a beneficiary's bank account details before creating a beneficiary in order to improve customer experience and reduce misdirected payments in the UK.
64+
[`Read guide`](/guides/integration-guides/verifying-beneficiary-account/)

data/local/pages/integration-guides/pay-beneficiary-funds-different-currency.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -283,21 +283,13 @@ Content-Type: application/json
283283

284284
## Step 5: Add a beneficiary
285285

286+
If you are a client under the Sponsored or Treasury service model and contracted with The Currency Cloud Limited, then you must [verify the beneficiary's account](/guides/integration-guides/verifying-beneficiary-account) details before creating a beneficiary.
287+
286288
If you know the required details, you can go ahead and create a record for the beneficiary via the [Create Beneficiary](/api-reference/#create-beneficiary) endpoint.
287289

288290
`POST /v2/beneficiaries/create`\
289291
`Content-Type: multipart/form-data`
290292

291-
| Parameter Name | Parameter Type | Example Value |
292-
| --- | --- | --- |
293-
| `name` | Form Data | `Acme GmbH` |
294-
| `bank_account_holder_name` | Form Data | `Acme GmbH` |
295-
| `currency` | Form Data | `EUR` |
296-
| `beneficiary_country` | Form Data | `DE` |
297-
| `bank_country` | Form Data | `DE` |
298-
| `bic_swift` | Form Data | `COBADEFF` |
299-
| `iban` | Form Data | `DE89370400440532013000` |
300-
| `X-Auth-Token` | Header | `ea6d13c7bc50feb46cf978d137bc01a2` |
301293

302294
If the beneficiary is successfully created, the response message will contain full details about the beneficiary as recorded in your Currencycloud account. Note the beneficiary's unique ID (`id`). You'll need this to make a payment to the beneficiary, in the next step.
303295

data/local/pages/integration-guides/sub-account-activity.md

+2-12
Original file line numberDiff line numberDiff line change
@@ -299,22 +299,12 @@ The following response shows that your customer is holding £557,685.00, and €
299299

300300
## Step 2: Add a beneficiary at the sub-account level
301301

302+
If you are a client under the Sponsored or Treasury service model and contracted with The Currency Cloud Limited, then you must [verify the beneficiary's account](/guides/integration-guides/verifying-beneficiary-account) details before creating a beneficiary.
303+
302304
If you and your customer know the required details, you can go ahead and create a record for the beneficiary via the [Create Beneficiary](/api-reference/#create-beneficiary) endpoint.
303305

304306
**`POST /v2/beneficiaries/create`**
305307

306-
| **Parameter Name** | **Parameter Type** | **Example Value** |
307-
| --- | --- | --- |
308-
| name | Form Data | Joe Bob |
309-
| bank_account_holder_name | Form Data | Joe Bob |
310-
| currency | Form Data | EUR |
311-
| beneficiary_country | Form Data | DE |
312-
| bank_country | Form Data | DE |
313-
| bic_swift | Form Data | COBADEFF |
314-
| on_behalf_of | Form Data | ce404ead-1936-4f54-ac2a-b26ec03d5560 |
315-
| iban | Form Data | DE89370400440532013000 |
316-
| X-Auth-Token | Header | ea6d13c7bc50feb46cf978d137bc01a2 |
317-
318308
If the beneficiary is successfully created, the response message will contain full details about the beneficiary as recorded in your customer's Currencycloud sub-account. Note the beneficiary's unique ID (`id`). You'll need this to make a payment to the beneficiary, in the next step.
319309

320310
Response:

0 commit comments

Comments
 (0)