/v1/platform/commerce/commands

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action*"agreement.create"

Value in

"agreement.create"

id*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

tenantId*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

agreement*

Response Body

`application/json`

curl -X POST "https://example.com/v1/platform/commerce/commands" \  -H "Content-Type: application/json" \  -d '{    "action": "agreement.create",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",    "agreement": {      "legalName": "string",      "registrationNumber": "string",      "evidence": "string",      "feeBps": 0,      "fixedFeeMinor": 0,      "gatewayFeePayer": "platform",      "refundPlatformFee": "retain"    }  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "string"}

/v1/platform/commerce/commands

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

428application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`