Skip to content

Commit b04bdc7

Browse files
committed
Updated API from documentation release
1 parent e1b9231 commit b04bdc7

11 files changed

+212
-0
lines changed

api-specs/checkout/types/payment-integrations/PaymentComponentType.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ displayName: PaymentComponentType
55
enum:
66
- Component
77
- DropIn
8+
- Express
89
(annotations.enumDescriptions):
910
Component: Each payment method component renders just a single payment method.
1011
DropIn: A component that renders all the payment methods.
12+
Express: A component that renders Express Payments.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: ExpressContainerNotFound
5+
discriminatorValue: express_container_not_found
6+
description: |
7+
Generated when the container element specified in the `expressId` option is not found in the DOM.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`error`
15+
message:
16+
type: string
17+
description: Express container not found.
18+
payload:
19+
type: object
20+
description: Contains the `id` of the container that was not found.
21+
correlationId:
22+
type: string
23+
description: Unique identifier of the event.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: ExpressMultipleContainersFound
5+
discriminatorValue: express_multiple_containers_found
6+
description: |
7+
Generated when multiple elements with the `data-ctc-express` attribute are found without an `expressId` specified. Use the `expressId` option to specify which container to use.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`error`
15+
message:
16+
type: string
17+
description: Multiple elements with data-ctc-express attribute found. Use expressId to specify which container to use.
18+
payload:
19+
type: object
20+
description: Contains the `count` property indicating the number of containers found.
21+
correlationId:
22+
type: string
23+
description: Unique identifier of the event.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: ExpressPaymentCancelled
5+
discriminatorValue: express_payment_cancelled
6+
description: |
7+
Generated when the customer cancels the Express Payments process.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Express Payments process cancelled.
18+
payload:
19+
type: object
20+
description: Contains the `paymentReference` and `method` object with the `type` property (if available).
21+
correlationId:
22+
type: string
23+
description: Unique identifier of the event.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: ExpressPaymentCompleted
5+
discriminatorValue: express_payment_completed
6+
description: |
7+
Generated when the Express Payments process is completed.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Express payment for `{orderId}` completed.
18+
payload:
19+
type: object
20+
description: Contains the `order` object with the `id` property.
21+
correlationId:
22+
type: string
23+
description: Unique identifier of the event.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: ExpressPaymentFailed
5+
discriminatorValue: express_payment_failed
6+
description: |
7+
Generated when the Express Payments process fails.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`error`
15+
message:
16+
type: string
17+
description: Express payment failed.
18+
payload:
19+
type: object
20+
description: Contains the `paymentReference`, `error`, and `method` object with the `type` property (if available).
21+
correlationId:
22+
type: string
23+
description: Unique identifier of the event.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: ExpressPaymentIntegrationNotAvailable
5+
discriminatorValue: express_payment_integration_not_available
6+
description: |
7+
Generated when a requested Express Payments integration is not available. This can happen when using `mountMethod()` with a payment method that is not configured or not available for the current session.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`warn`
15+
message:
16+
type: string
17+
description: Express Payments integration not available.
18+
payload:
19+
type: object
20+
description: Contains the `integration` object with the `type` property indicating the requested payment integration type, and `availableMethods` array listing the available payment methods.
21+
correlationId:
22+
type: string
23+
description: Unique identifier of the event.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: ExpressPaymentInterrupted
5+
discriminatorValue: express_payment_interrupted
6+
description: |
7+
Generated when the Express Payments process is interrupted by the seller's callback.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Express Payments process was interrupted by a callback.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: ExpressPaymentStarted
5+
discriminatorValue: express_payment_started
6+
description: |
7+
Generated when the customer clicks an Express Payments button and the Express Payment process starts.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Express payment started.
18+
payload:
19+
type: object
20+
description: Contains the `integration` object with the `type` property.
21+
correlationId:
22+
type: string
23+
description: Unique identifier of the event.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: NoExpressPaymentIntegrations
5+
discriminatorValue: no_express_payment_integrations
6+
description: |
7+
Generated when no express payment integrations are configured.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`error`
15+
message:
16+
type: string
17+
description: There are no Express Payments integrations configured.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.

0 commit comments

Comments
 (0)