Skip to content

Commit 1f9b4cb

Browse files
Document refund payload fields (#761)
1 parent bb1e8f1 commit 1f9b4cb

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

legacy/src/api/payment-requests/payment-requests.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,6 +1014,7 @@ One of either `assetId`, `transactionId` or `authorization` must be provided.
10141014
"amount": "6190",
10151015
"currency": "NZD",
10161016
},
1017+
"externalRef": "e8df06e2-13a5-48b4-b670-3fd6d815fe0a",
10171018
"lineItems": [
10181019
{
10191020
name: 'Coffee Grounds',
@@ -1070,6 +1071,17 @@ One of either `assetId`, `transactionId` or `authorization` must be provided.
10701071

10711072
{% endreqspec %}
10721073

1074+
{% h4 Fields %}
1075+
1076+
| Field | Type | Description |
1077+
| :------------------------- | :---------------- | :--------------------------------------------------------------------------------------------------------------- |
1078+
| value | {% dt Monetary %} | The value of the refund. Must be less than 100000000 and positive. |
1079+
| externalRef | String | An external reference to the refund. |
1080+
| merchantConfigId | String {% opt %} | The [Merchant Config][] id of the refunding merchant when refunding a `farmlands.nzd.*` payment. |
1081+
| lineItems | Array {% opt %} | **Experimental** The [Line Items](#line-item) being refunded. |
1082+
| confirmationIdempotencyKey | String {% opt %} | Required when refunding a Pre Auth Confirmation. Should be the same as the idempotencyKey used for Confirmation. |
1083+
| invoiceRef | String {% opt %} | A reference to an invoice for the refund. Must be less than or equal to 128 characters. |
1084+
10731085
{% h4 Example response payload %}
10741086

10751087
{% json %}

0 commit comments

Comments
 (0)