Skip to content

Commit 4e87d65

Browse files
committed
Updated API from documentation release
1 parent ae16dc0 commit 4e87d65

17 files changed

+129
-129
lines changed

api-specs/checkout/types/responses/PaymentConnectorError.raml renamed to api-specs/checkout/types/responses/ConnectorError.raml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#%RAML 1.0 DataType
22
(annotations.package): responses
33
type: ResponseMessage
4-
displayName: PaymentConnectorError
5-
discriminatorValue: payment_connector_error
4+
displayName: ConnectorError
5+
discriminatorValue: connector_error
66
description: |
7-
Generated when the [payment Connector](/../checkout/connectors-and-applications#payment-connectors) triggers an error.
7+
Generated when the [Connector](/../checkout/connectors-and-applications#payment-connectors) triggers an error.
88
properties:
99
code:
1010
type: string
@@ -14,7 +14,7 @@ properties:
1414
description: \`error`
1515
message:
1616
type: string
17-
description: Payment connector error.
17+
description: Connector error.
1818
correlationId:
1919
type: string
2020
description: Unique identifier of the event.

api-specs/checkout/types/responses/GiftCardBalanceRemoved.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: Message
44
displayName: GiftCardBalanceRemoved
55
discriminatorValue: gift_card_balance_removed
66
description: |
7-
Generated when the customer removes a gift card's balance that was initially applied as a payment method.
7+
Generated when the customer removes a gift card's balance that was initially applied as a payment integration.
88
properties:
99
code:
1010
type: string
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: NoPaymentIntegrations
5+
discriminatorValue: no_payment_integrations
6+
description: |
7+
Generated when no payment integration is set up for an [Application](/connectors-and-applications#applications). Add at least one Payment integration to the Application in the Merchant Center.
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 payment integrations configured.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.

api-specs/checkout/types/responses/NoPaymentMethods.raml

Lines changed: 0 additions & 20 deletions
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#%RAML 1.0 DataType
22
(annotations.package): responses
33
type: ResponseMessage
4-
displayName: PaymentMethodSelected
5-
discriminatorValue: payment_method_selected
4+
displayName: PaymentIntegrationLoaded
5+
discriminatorValue: payment_integration_loaded
66
description: |
7-
Generated when the customer selects the payment method.
7+
Generated when the selected payment integration is loaded.
88
properties:
99
code:
1010
type: string
@@ -14,10 +14,10 @@ properties:
1414
description: \`info`
1515
message:
1616
type: string
17-
description: Payment method selected.
17+
description: Payment integration loaded.
1818
correlationId:
1919
type: string
2020
description: Unique identifier of the event.
2121
payload:
2222
type: object
23-
description: Contains the `method` object with the `type` and `hasVendorButton` properties.
23+
description: Contains the `integration` object with the `type` and `connectorId` properties.
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#%RAML 1.0 DataType
22
(annotations.package): responses
33
type: ResponseMessage
4-
displayName: PaymentMethodLoaded
5-
discriminatorValue: payment_method_loaded
4+
displayName: PaymentIntegrationLoading
5+
discriminatorValue: payment_integration_loading
66
description: |
7-
Generated when the selected payment method is loaded.
7+
Generated when the selected payment integration is loading.
88
properties:
99
code:
1010
type: string
@@ -14,10 +14,10 @@ properties:
1414
description: \`info`
1515
message:
1616
type: string
17-
description: Payment method loaded.
17+
description: Payment integration loading.
1818
correlationId:
1919
type: string
2020
description: Unique identifier of the event.
2121
payload:
2222
type: object
23-
description: Contains the `method` object with the `type` and `connectorId` properties.
23+
description: Contains the `integration` object with the `type` and `connectorId` properties.
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#%RAML 1.0 DataType
22
(annotations.package): responses
33
type: ResponseMessage
4-
displayName: PaymentMethodLoadingError
5-
discriminatorValue: payment_method_loading_error
4+
displayName: PaymentIntegrationLoadingError
5+
discriminatorValue: payment_integration_loading_error
66
description: |
7-
Generated when the loading of the selected payment method fails.
7+
Generated when the loading of the selected payment integration fails.
88
properties:
99
code:
1010
type: string
@@ -14,10 +14,10 @@ properties:
1414
description: \`error`
1515
message:
1616
type: string
17-
description: Payment method loading failed.
17+
description: Payment integration loading failed.
1818
correlationId:
1919
type: string
2020
description: Unique identifier of the event.
2121
payload:
2222
type: object
23-
description: Contains the `method` object with the `type` and `connectorId` properties.
23+
description: Contains the `integration` object with the `type` and `connectorId` properties.

api-specs/checkout/types/responses/PaymentMethodNotAvailable.raml renamed to api-specs/checkout/types/responses/PaymentIntegrationNotAvailable.raml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#%RAML 1.0 DataType
22
(annotations.package): responses
33
type: ResponseMessage
4-
displayName: PaymentMethodNotAvailable
5-
discriminatorValue: payment_method_not_available
4+
displayName: PaymentIntegrationNotAvailable
5+
discriminatorValue: payment_integration_not_available
66
description: |
7-
Generated when there is an error with the selected payment method and the payment method is unavailable.
7+
Generated when there is an error with the selected payment integration and the payment integration is unavailable.
88
properties:
99
code:
1010
type: string
@@ -14,7 +14,7 @@ properties:
1414
description: \`warn`
1515
message:
1616
type: string
17-
description: Payment method not available.
17+
description: Payment integration not available.
1818
correlationId:
1919
type: string
2020
description: Unique identifier of the event.
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#%RAML 1.0 DataType
22
(annotations.package): responses
33
type: ResponseMessage
4-
displayName: PaymentMethodLoading
5-
discriminatorValue: payment_method_loading
4+
displayName: PaymentIntegrationSelected
5+
discriminatorValue: payment_integration_selected
66
description: |
7-
Generated when the selected payment method is loading.
7+
Generated when the customer selects the payment integration.
88
properties:
99
code:
1010
type: string
@@ -14,10 +14,10 @@ properties:
1414
description: \`info`
1515
message:
1616
type: string
17-
description: Payment method loading.
17+
description: Payment integration selected.
1818
correlationId:
1919
type: string
2020
description: Unique identifier of the event.
2121
payload:
2222
type: object
23-
description: Contains the `method` object with the `type` and `connectorId` properties.
23+
description: Contains the `integration` object with the `type` and `hasVendorButton` properties.
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: PaymentIntegrationSelectionConfirmation
5+
discriminatorValue: payment_integration_selection_confirmation
6+
description: |
7+
Generated when the customer has entered the payment integration information and moves to the next step.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Payment integration selected.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
21+
payload:
22+
type: object
23+
description: Contains the `integration` object with the `type` and `hasVendorButton` properties.

0 commit comments

Comments
 (0)