Add gateway object to StorefrontTransaction (#1736)

Rebilly · Jan 15, 2024 · 9577a26 · 9577a26
1 parent e8eaf9a
commit 9577a26
Showing 1 changed file with 82 additions and 0 deletions.
diff --git a/openapi/components/schemas/StorefrontTransaction.yaml b/openapi/components/schemas/StorefrontTransaction.yaml
@@ -179,6 +179,88 @@ properties:
     x-basic: true
     allOf:
       - $ref: ./GatewayName.yaml
+  gateway:
+    type: object
+    description: Related gateway information.
+    readOnly: true
+    properties:
+      response:
+        description: Gateway response.
+        type: object
+        properties:
+          code:
+            description: Gateway response code.
+            type:
+              - 'string'
+              - 'null'
+          message:
+            description: Gateway response message.
+            type:
+              - 'string'
+              - 'null'
+          type:
+            description: Gateway response type.
+            type:
+              - 'string'
+              - 'null'
+          originalCode:
+            description: Raw, unmapped gateway response code.
+            type:
+              - 'string'
+              - 'null'
+          originalMessage:
+            description: Raw, unmapped gateway response message.
+            type:
+              - 'string'
+              - 'null'
+      avsResponse:
+        description: Gateway Address Verification System (AVS) response.
+        type: object
+        properties:
+          code:
+            description: Response code.
+            type:
+              - 'string'
+              - 'null'
+          message:
+            description: Response message.
+            type:
+              - 'string'
+              - 'null'
+          originalCode:
+            description: Raw response code.
+            type:
+              - 'string'
+              - 'null'
+          originalMessage:
+            description: Raw response message.
+            type:
+              - 'string'
+              - 'null'
+      cvvResponse:
+        description: Gateway Card Verification Value (CVV) response.
+        type: object
+        properties:
+          code:
+            description: Response code.
+            type:
+              - 'string'
+              - 'null'
+          message:
+            description: Response message.
+            type:
+              - 'string'
+              - 'null'
+          originalCode:
+            description: Raw response code.
+            type:
+              - 'string'
+              - 'null'
+          originalMessage:
+            description: Raw response message.
+            type:
+              - 'string'
+              - 'null'
   customFields:
     $ref: ./ResourceCustomFields.yaml
   processedTime: