json icon

Authorize Payment

v1.0.0commands

Command to authorize payment for the total of a checked-out cart.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "AuthorizePayment",
4  "description": "Command to authorize payment for the total of a checked-out cart",
5  "type": "object",
6  "properties": {
7    "cartId": {
8      "description": "Identifier of the cart being checked out",
9      "type": "string",
10      "format": "uuid"
11    },
12    "customerId": {
13      "description": "Identifier of the customer paying",
14      "type": "string",
15      "format": "uuid"
16    },
17    "amount": {
18      "description": "Amount to authorize, in minor units (e.g. cents)",
19      "type": "integer",
20      "minimum": 0
21    },
22    "currency": {
23      "description": "ISO 4217 currency code",
24      "type": "string",
25      "pattern": "^[A-Z]{3}$"
26    }
27  },
28  "required": ["cartId", "amount", "currency"]
29}
30

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions