Skip to content

Commit c6e3250

Browse files
committed
Updated API from documentation release
1 parent 05e3fa7 commit c6e3250

File tree

5 files changed

+5
-24
lines changed

5 files changed

+5
-24
lines changed

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,9 @@ type: object
44
displayName: PaymentIntentAction
55
description: |
66
Depending on the action specified, Checkout requests the [payment service provider](/connectors-and-applications#supported-psps-payment-integration-types-and-payment-methods) (PSP) or gift card management system to capture, refund, or cancel the authorization for the given Payment.
7+
discriminator: action
78
properties:
89
action:
910
type: PaymentIntentOperation
1011
description: |
1112
Action to execute for the given [Payment](/../api/projects/payments#payment).
12-
amount?:
13-
type: Amount
14-
description: |
15-
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: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
#%RAML 1.0 DataType
22
(annotations.package): PaymentIntents
33
(annotations.beta): true
4-
type: object
4+
type: PaymentIntentAction
55
displayName: PaymentIntentCancelAction
6-
discriminator: action
76
discriminatorValue: cancelPayment
87
example: !include ../../../checkout/examples/payments/cancelPaymentAction.json
98
description: |
109
Requests to [cancel the authorization](/payments-lifecycle#authorization-cancellation) for a Payment. Checkout will cancel the [Payment](/../api/projects/payments#payment) and will request the PSP or gift card management system to proceed with the financial process to cancel the authorization.
1110
1211
You cannot request to cancel the authorization for a Payment that has already been [captured](/payments-lifecycle#payment-capture).
1312
properties:
14-
action:
15-
type: string
1613
merchantReference?:
1714
type: string
1815
description: |

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
#%RAML 1.0 DataType
22
(annotations.package): PaymentIntents
33
(annotations.beta): true
4-
type: object
4+
type: PaymentIntentAction
55
displayName: PaymentIntentCaptureAction
6-
discriminator: action
76
discriminatorValue: capturePayment
87
example: !include ../../../checkout/examples/payments/capturePaymentAction.json
98
description: |
109
Requests to [capture](/payments-lifecycle#payment-capture) the given amount from the customer. Checkout will request the PSP or gift card management system to proceed with the financial process to capture the amount.
1110
properties:
12-
action:
13-
type: string
1411
amount:
1512
description: |
1613
Amount to be captured. It must be less than or equal to the [authorized](/payments-lifecycle#authorization) amount.

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
#%RAML 1.0 DataType
22
(annotations.package): PaymentIntents
33
(annotations.beta): true
4-
type: object
4+
type: PaymentIntentAction
55
displayName: PaymentIntentRefundAction
6-
discriminator: action
76
discriminatorValue: refundPayment
87
example: !include ../../../checkout/examples/payments/refundPaymentAction.json
98
description: |
109
Requests to [refund](/payments-lifecycle#refund) the given amount to the customer. Checkout will request the PSP or gift card management system to proceed with the financial process to refund the amount.
1110
properties:
12-
action:
13-
type: string
1411
amount:
1512
description: |
1613
Amount to be refunded. It must be less than or equal to the [captured](/payments-lifecycle#payment-capture) amount.

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
#%RAML 1.0 DataType
22
(annotations.package): PaymentIntents
33
(annotations.beta): true
4-
type: object
4+
type: PaymentIntentAction
55
displayName: PaymentIntentReverseAction
6-
discriminator: action
76
discriminatorValue: reversePayment
87
example: !include ../../../checkout/examples/payments/reversePaymentAction.json
98
description: |
109
Requests to [reverse](/payment-integration-predicates) a [Payment](/../api/projects/payments#payment). Checkout reverses the Payment, and then requests the PSP or gift card management system to proceed with the relevant process to reverse the Payment.
1110
properties:
12-
action:
13-
type: string
1411
merchantReference?:
1512
type: string
1613
description: |

0 commit comments

Comments
 (0)