Atualização workflow de uma negociação

Descrição: Atualiza o status de workflow de uma negociação.

Endpoint

PUT/api/v1/integration/order-commitments/{commitment_id}/workflow

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
commitment_id	Identificador da negociação na plataforma Merx.	UUID	Sim

Exemplo de Requisição

cURL

curl -X PUT \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "speciality_type": "COMMERCIAL",
    "target_status": "APPROVED",
    "issuer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user_message": "Aprovado conforme análise comercial.",
    "reviewed": false
  }' \
  "https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}/workflow"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String body = "{\"speciality_type\": \"COMMERCIAL\", \"target_status\": \"APPROVED\", \"issuer_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"user_message\": \"Aprovado conforme análise comercial.\", \"reviewed\": false}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}/workflow"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .PUT(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}/workflow',
  {
    method: 'PUT',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      speciality_type: 'COMMERCIAL',
      target_status: 'APPROVED',
      issuer_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
      user_message: 'Aprovado conforme análise comercial.',
      reviewed: false,
    }),
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}/workflow"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json"
}

payload = {
    "speciality_type": "COMMERCIAL",
    "target_status": "APPROVED",
    "issuer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user_message": "Aprovado conforme análise comercial.",
    "reviewed": False
}

response = requests.put(url, json=payload, headers=headers)
print(response.status_code)

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim
Content-Type	application/json	String	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório	Validações
speciality_type	Tipo de especialidade do workflow	Enum	Sim	BILLING, CONTRACTS, COMMERCIAL, COMPLIANCE e ADMINISTRATIVE
target_status	Status do workflow	Enum	Sim	NEW, APPROVED, PENDING, PENDING_REVIEW e REJECTED
issuer_id	Id do emissor da negociação	UUID	Sim	Id do emissor da negociação
user_message	Mensagem	String	Não	Até 1000 caracteres
reviewed	Se foi revisada	Boolean	Não	true caso tenha sido revisada. false caso não.

Respostas

• 204 - No content

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized