Sign in
Cascades

Create a Cascade

Create a new Cascade with the provided details

post/cascades

Request body

namestring required

The cascade's name

descriptionstring

The cascade's description

algorithm'roundRobin' | 'weightedRoundRobin' | 'priorityQueue' required

The algorithm to be used to route payments in the cascade

Example request

{
  "name": "My Cascade",
  "algorithm": "weightedRoundRobin",
  "gateways": [
    {
      "profile": "gwp_2QUGPTQo8As1cNIvgKlSFDxjJDd",
      "position": 1,
      "weight": 80,
      "transactionLimit": 100,
      "transactionLimitPeriod": "day",
      "transactionCap": 10000,
      "transactionCapPeriod": "day"
    }
  ]
}

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The unique identifier of the cascade

namestring required
descriptionstring nullable required
activeboolean required

Whether the cascade is active and available for routing

algorithm'roundRobin' | 'weightedRoundRobin' | 'priorityQueue' required

The algorithm used for gateway selection. Available options: roundRobin, weightedRoundRobin, priorityQueue

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "name": "My Cascade",
  "description": "Simple cascade",
  "active": true,
  "algorithm": "weightedRoundRobin",
  "gateways": [
    {
      "createdAt": "2024-02-18T12:00:00Z",
      "updatedAt": "2024-02-21T12:15:00Z",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "profile": {
        "createdAt": "2024-02-18T12:00:00Z",
        "updatedAt": "2024-02-21T12:15:00Z",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "id": "gwp_2QC7PqoUeOxQEWscJJt6B3PkvyL",
        "active": true,
        "title": "Profile #1",
        "integration": "stripe",
        "environment": "test"
      },
      "position": 1,
      "weight": 80,
      "transactionLimit": 100,
      "transactionLimitPeriod": "day",
      "transactionCap": 10000,
      "transactionCapPeriod": "month"
    }
  ],
  "lastAttempted": {
    "createdAt": "2024-02-18T12:00:00Z",
    "updatedAt": "2024-02-21T12:15:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  },
  "lastBilled": {
    "createdAt": "2024-02-18T12:00:00Z",
    "updatedAt": "2024-02-21T12:15:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.