Skip to content

Commit bfbd178

Browse files
committed
Updated API from documentation release
1 parent 5076237 commit bfbd178

File tree

8 files changed

+30
-10
lines changed

8 files changed

+30
-10
lines changed
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"action": "cancelPayment"
3-
}
2+
"action": "cancelPayment",
3+
"merchantReference": "example-reference"
4+
}

api-specs/checkout/examples/payments/capturePayment.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"amount": {
66
"centAmount": 10000,
77
"currencyCode": "EUR"
8-
}
8+
},
9+
"merchantReference": "example-reference"
910
}
1011
]
11-
}
12+
}

api-specs/checkout/examples/payments/capturePaymentAction.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"amount": {
44
"centAmount": 10000,
55
"currencyCode": "EUR"
6-
}
7-
}
6+
},
7+
"merchantReference": "example-reference"
8+
}

api-specs/checkout/examples/payments/refundPaymentAction.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"amount": {
44
"centAmount": 10000,
55
"currencyCode": "EUR"
6-
}
7-
}
6+
},
7+
"merchantReference": "example-reference"
8+
}

api-specs/checkout/types/payment-intents/PaymentIntentAction.raml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,12 @@ properties:
88
action:
99
type: PaymentIntentOperation
1010
description: |
11-
Action to execute for the given Payment.
11+
Action to execute for the given [Payment](/../api/projects/payments#payment).
1212
amount?:
1313
type: common.Amount
1414
description: |
1515
Amount to be captured or refunded.
16+
merchantReference?:
17+
type: string
18+
description: |
19+
A merchant-defined identifier associated with the Payment to track and reconcile the Payment Intent Action on the merchant's side. For example, an invoice number.

api-specs/checkout/types/payment-intents/PaymentIntentCancelAction.raml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ description: |
1313
properties:
1414
action:
1515
type: string
16+
merchantReference?:
17+
type: string
18+
description: |
19+
A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.

api-specs/checkout/types/payment-intents/PaymentIntentCaptureAction.raml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ properties:
1515
description: |
1616
Amount to be captured. It must be less than or equal to the [authorized](/payments-lifecycle#authorization) amount.
1717
type: common.Amount
18+
merchantReference?:
19+
type: string
20+
description: |
21+
A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.

api-specs/checkout/types/payment-intents/PaymentIntentRefundAction.raml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ description: |
1111
properties:
1212
action:
1313
type: string
14-
amount?:
14+
amount:
1515
description: |
1616
Amount to be refunded. It must be less than or equal to the [captured](/payments-lifecycle#payment-capture) amount.
1717
type: common.Amount
18+
merchantReference?:
19+
type: string
20+
description: |
21+
A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.

0 commit comments

Comments
 (0)