Skip to content

Commit 5e042a9

Browse files
committed
Updated API from documentation release
1 parent 472c32a commit 5e042a9

File tree

4 files changed

+25
-0
lines changed

4 files changed

+25
-0
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"action": "reversePayment",
3+
"merchantReference": "example-reference"
4+
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ description: |
1111
[Refunds](ctp:checkout:type:PaymentIntentRefundAction) the given Payment amount.
1212
cancelPayment: |
1313
[Cancels](ctp:checkout:type:PaymentIntentCancelAction) an authorized Payment.
14+
reversePayment: |
15+
[Reverses](ctp:checkout:type:PaymentIntentReverseAction) a Payment.
1416
enum:
1517
- capturePayment
1618
- refundPayment
1719
- cancelPayment
20+
- reversePayment
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): PaymentIntents
3+
(annotations.beta): true
4+
type: object
5+
displayName: PaymentIntentReverseAction
6+
discriminator: action
7+
discriminatorValue: reversePayment
8+
example: !include ../../../checkout/examples/payments/reversePaymentAction.json
9+
description: |
10+
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.
11+
properties:
12+
action:
13+
type: string
14+
merchantReference?:
15+
type: string
16+
description: |
17+
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/types.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ PaymentIntentAction: !include payment-intents/PaymentIntentAction.raml
9494
PaymentIntentCaptureAction: !include payment-intents/PaymentIntentCaptureAction.raml
9595
PaymentIntentRefundAction: !include payment-intents/PaymentIntentRefundAction.raml
9696
PaymentIntentCancelAction: !include payment-intents/PaymentIntentCancelAction.raml
97+
PaymentIntentReverseAction: !include payment-intents/PaymentIntentReverseAction.raml
9798
PaymentIntent: !include payment-intents/PaymentIntent.raml
9899
# Payment Errors
99100
ErrorObject: !include error/ErrorObject.raml

0 commit comments

Comments
 (0)