Create a spend control | The Penny Inc

curl -X POST https://sandbox.api.thepennyinc.com/spend_controls/ \
     -H "X-Penny-As-Business: business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "spend_control_id": "spend_control_019379d9-a170-796b-867a-a17096b67a21",
  "version": 1,
  "version_time": "2024-01-15T10:30:00Z",
  "active": true,
  "status": "active",
  "rules": [
    {
      "applicable_card_issuance_modes": [
        "managed"
      ],
      "applicable_transaction_authorizations": [
        "debit",
        "credit"
      ],
      "currency_amount_limits": {},
      "rule_id": "spend_control_rule_019370e9-c1a6-78ad-8fee-c1a68adfee20",
      "rule_type": "transaction_amount",
      "version": 1,
      "version_time": "2024-01-15T10:30:00Z"
    }
  ],
  "business_id": "business_01937b95-484e-75af-8c68-484e5afc68d3"
}

Create a new spend control owned by your business, with an initial set of rules. Configuration is typed for each rule type — see GET /spend_controls/rule_types for the supported shape per rule type.

Required permissions: spend_control:create.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

rule_configslist of objectsOptional

The rules to configure on the new spend control. Each rule_type may appear at most once.

Response

The newly created spend control.

spend_control_idstring

Penny's unique identifier for this spend control.

versioninteger

A number that increases each time this spend control's configuration changes. Use it to confirm you are looking at the latest configuration.

version_timedatetime

The date and time this spend control's configuration was last changed.

activeboolean

Whether this spend control's rules are currently being enforced against transactions.

statusenum

The current lifecycle state of the spend control. 'active' means the rules are being enforced. 'deactivated' means enforcement has been paused and can be resumed. 'deleting' means removal has been requested and is in progress. 'deleted' means the spend control has been removed and is kept only for historical reference.

Allowed values:

ruleslist of objects

The full external configuration of every rule in this spend control.

business_idstring

The identifier of the business that owns this spend control.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors