Skip to content

Commit 279f193

Browse files
committed
Update payments
1 parent 5a6465e commit 279f193

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

source/includes/payments.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,40 +33,40 @@ curl -X POST http://api-test.cleartreasury.co.uk/api/payments \
3333
"currency": "GBP",
3434
"amount": "500",
3535
"purpose": "Making an investment",
36-
"payment_guid": "<your GUID>"
36+
"payment_reference": ""
3737
}'
3838
```
3939

4040
> Example response:
4141
4242
```json
4343
{
44-
"PaymentGuid": "<your GUID>"
44+
"PaymentGuid": "<GUID>"
4545
}
4646
```
4747

4848
### Request
4949

5050
`POST /payments?client_ref={client_ref}`
5151

52-
**Trade reference**: If this payment is not linked to a trade leave it blank, or set it to `"auto"` to attempt to automatically retrieve an available trade.
52+
**Trade reference**: If this payment is not linked to a trade leave it blank, or
53+
set it to `"auto"` to attempt to automatically retrieve an available trade.
5354

54-
| Name | Description | Required | Type | Additional information |
55-
| -------------- | ------------------------------------------------------------------------- | -------- | ------ | -------------------------------------------- |
56-
| client_ref | Client reference you're instructing the payment on behalf of | Yes | string | [`client_ref`](#create-a-client) |
57-
| beneficiary_id | ID of the beneficiary | Yes | string | [`id`](#create-a-beneficiary) |
58-
| trade_ref | Reference of the trade used to instruct this payment | Yes | string | [`trade_id`](#book-trade), `"auto"`, or `""` |
59-
| currency | Currency of the payment | Yes | string | ISO 3 letter currency code |
60-
| amount | Amount to be instructed | Yes | string | |
61-
| fee | | No | string | |
62-
| purpose | Reason for the payment | No | string | |
63-
| payment_guid | A GUID defined by yourself that can be used to retrieve the payment later | No | string | |
55+
| Name | Description | Required | Type | Additional information |
56+
| ----------------- | ------------------------------------------------------------ | -------- | ------ | -------------------------------------------- |
57+
| client_ref | Client reference you're instructing the payment on behalf of | Yes | string | [`client_ref`](#create-a-client) |
58+
| beneficiary_id | ID of the beneficiary | Yes | string | [`id`](#create-a-beneficiary) |
59+
| trade_ref | Reference of the trade used to instruct this payment | Yes | string | [`trade_id`](#book-trade), `"auto"`, or `""` |
60+
| currency | Currency of the payment | Yes | string | ISO 3 letter currency code |
61+
| amount | Amount to be instructed | Yes | string | |
62+
| purpose | Reason for the payment | No | string | |
63+
| payment_reference | Reference to attach to the payment for your records | No | string | |
6464

6565
### Response
6666

67-
| Name | Description | Type |
68-
| ----------- | ------------------------------------- | ------ |
69-
| PaymentGuid | The GUID you specified in the request | string |
67+
| Name | Description | Type |
68+
| ----------- | ---------------------------- | ------ |
69+
| PaymentGuid | The unique ID of the payment | string |
7070

7171
<!-- ## List all payments
7272

0 commit comments

Comments
 (0)