Transactions

A Transaction is a name given to a query submitted to CAF services. The resource called transactions provides the ability for direct consumption of all active services using a single API request containing the data of an individual or company.

Create transactions

This resource is responsible for creating a new transaction using the received data. As it is a workflow-based solution, creating a workflow on Trust platform is required before using this service.
Permission required: Transactions create

POSThttps://api.public.caf.io/v1/orchestrations/transactions

Header parameters

Body

application/json

workflowId*string

Workflow unique identifier. It is created in Trust platform.

parameters*object

Company data that can be included within the transaction request data.

metadataobject

Free to add any kind of attribute, ideal for linking IDs or other information in the transaction.

Response

201400401403404500

Success

Body

application/json

requestIdstring

Request unique identifier.

messagestring

Success message.

dataobject

Response data.

Request

JavaScriptCurl

const response = await fetch('https://api.public.caf.io/v1/orchestrations/transactions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "workflowId": "text",
      "parameters": {}
    }),
});
const data = await response.json();

Response

{
  "requestId": "text",
  "message": "text",
  "data": {
    "transactionId": "text"
  }
}

List transactions

Get your transaction list summarized with pagination and filters.
Permission required: Transactions read

GEThttps://api.public.caf.io/v1/orchestrations/transactions

Query parameters

Header parameters

Response

200400401403500

Success

Body

application/json

requestIdstring

Request unique identifier.

messagestring

Success message.

dataobject

Response data.

paginationobject

Request

JavaScriptCurl

const response = await fetch('https://api.public.caf.io/v1/orchestrations/transactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "requestId": "text",
  "message": "text",
  "data": {
    "items": [
      {
        "id": "text",
        "status": "APPROVED",
        "workflowId": "text",
        "createdAt": "text"
      }
    ]
  },
  "pagination": {
    "previousPage": "text",
    "nextPage": "text"
  }
}

Get transaction

Retrieve the result data of a transaction.
Permission required: Transactions read

GEThttps://api.public.caf.io/v1/orchestrations/transactions/{transactionId}

Path parameters

transactionId*string

Transaction unique identifier. It must be a valid id.

Header parameters

Response

200400401403404500

Successful operation

Body

application/json

requestIdstring

Request unique identifier.

messagestring

Success message.

dataobject

Response data.

Request

JavaScriptCurl

const response = await fetch('https://api.public.caf.io/v1/orchestrations/transactions/{transactionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "requestId": "text",
  "message": "text",
  "data": {
    "id": "text",
    "status": "APPROVED",
    "createdAt": "text",
    "updatedAt": "text",
    "workflowId": "text",
    "validations": [
      {
        "ruleId": "text",
        "ruleName": "text",
        "status": "APPROVED",
        "createdAt": "text"
      }
    ]
  }
}

Update transaction manual reviews

Update reviews in a transaction that have pending reviews.
If your workflow contains more than one rule in the same step, it will be necessary to change all rule statuses for the flow to proceed/complete.
Permission required: Manual reviews update

PATCHhttps://api.public.caf.io/v1/orchestrations/transactions/{transactionId}/manual-reviews

Path parameters

transactionId*string

Transaction identifier.

Header parameters

Body

application/json

reviewsarray of object

List containing all the reviews that will be updated on the transaction.

Response

200400401404500

Success

Body

application/json

requestIdstring

messagestring

dataobject

Response data.

Request

JavaScriptCurl

const response = await fetch('https://api.public.caf.io/v1/orchestrations/transactions/{transactionId}/manual-reviews', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "requestId": "text",
  "message": "Transaction reviewed successfully",
  "data": {
    "transactionId": "text"
  }
}