GET
/
v1
/
flows
/
{id}
curl --request GET \
  --url https://api.malga.io/v1/flows/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "identificador único do fluxo"
    },
    "paymentMethod": {
      "type": "string",
      "description": "método de pagamento a qual aquele fluxo é relacionado"
    },
    "clientId": {
      "type": "string",
      "description": "identificador do cliente dono do fluxo"
    },
    "merchants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "merchantId": {
            "type": "string",
            "description": "identificador do merchant relacionado ao fluxo"
          }
        }
      }
    },
    "parentId": {
      "type": "string",
      "description": "identificador do fluxo que originou o novo"
    },
    "restoredFrom": {
      "type": "string",
      "description": "identificador do fluxo do qual este foi restaurado"
    },
    "createdAt": {
      "type": "string",
      "description": "data e hora em que o fluxo foi criado (UTC)"
    },
    "flow": {
      "type": "object",
      "description": "dados do fluxo que será cadastrado"
    }
  },
  "example": {
    "id": "b4ced0dd-2136-4bce-a231-364e93554073",
    "merchants": [
      {
        "merchantId": "z1babb21-6a4c-987d-89db-11d3af737ee1"
      }
    ],
    "paymentMethod": "credit",
    "clientId": "f1babb21-6a4c-323d-12db-69d3af407ee1",
    "parentId": "g1babb21-6a4c-987d-89db-11d3af737ee1",
    "createdAt": "2023-03-22T20:45:06.020Z",
    "flow": {
      "version": "0.0.0",
      "root": [
        {
          "rule": "provider",
          "id": "z1babb21-6a4c-987d-89db-11d3af737ee1"
        }
      ]
    },
    "restoredFrom": "df601922-e024-6394-8f12-af21ec4218b1"
  }
}

Authorizations

X-Client-Id
string
headerrequired
X-Api-Key
string
headerrequired

Path Parameters

id
string
required

flow id

Response

200 - application/json
id
string

identificador único do fluxo

paymentMethod
string

método de pagamento a qual aquele fluxo é relacionado

clientId
string

identificador do cliente dono do fluxo

merchants
object[]
parentId
string

identificador do fluxo que originou o novo

restoredFrom
string

identificador do fluxo do qual este foi restaurado

createdAt
string

data e hora em que o fluxo foi criado (UTC)

flow
object

dados do fluxo que será cadastrado