curl --request GET \
--url https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"process_external_id": "55555555-5555-4555-8555-555555555555",
"hub_code": "padrao",
"status": "loan_disbursed",
"proposal": {
"gross_amount": "5000.00",
"installments": 24
},
"ccb_number": "1234",
"disbursed_at": "2026-09-24T10:12:00-03:00"
}Consultar indicação
Devolve a visão atual do processo, montada no momento da consulta. Tem a mesma estrutura do data
do webhook, mas o GET é a fonte da verdade: o data do webhook é congelado quando a notificação é gravada,
enquanto o GET reflete o estado atual. Consulte-o antes de tomar uma decisão no seu sistema.
Campos que o processo ainda não tem são omitidos da resposta (não vêm como null).
Processo inexistente ou pertencente a outro parceiro: 404 REFERRAL_NOT_FOUND.
curl --request GET \
--url https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://orchestrator-partner.dev.wincred.digital/partners/v1/referrals/{process_external_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"process_external_id": "55555555-5555-4555-8555-555555555555",
"hub_code": "padrao",
"status": "loan_disbursed",
"proposal": {
"gross_amount": "5000.00",
"installments": 24
},
"ccb_number": "1234",
"disbursed_at": "2026-09-24T10:12:00-03:00"
}Authorizations
Chave de API do parceiro, entregue pelo time de integrações da Wincred. Header:
Authorization: Bearer <chave do parceiro> (o esquema Bearer não diferencia maiúsculas).
Por segurança, chave ausente, malformada, inválida ou revogada recebem a mesma resposta: 401 UNAUTHENTICATED.
Guarde a chave apenas no servidor e solicite a rotação ao time de integrações quando precisar trocá-la.
Headers
Path Parameters
Response
Visão atual do processo.
Visão do processo. Mesma estrutura no GET e no data do webhook. Campos que o processo ainda não tem são omitidos da resposta.
Último marco alcançado. Pode voltar: depois de um reset, o processo retorna a term_signed,
porque o contrato anterior foi encerrado antes do desembolso e o cliente escolhe uma nova proposta.
Prepare a sua máquina de estados para esse retorno.
| Valor | Significado |
|---|---|
awaiting_client | Link enviado, termo não assinado |
term_signed | Termo assinado, antes da criação do contrato |
contract_created | Do contrato até antes do desembolso (CCB, KYC, averbação) |
loan_disbursed | Valor desembolsado na conta do cliente (conclusão com sucesso) |
closed | Encerrado sem contratação. Termo vencido sem contrato aparece como closed no GET, mas não gera webhook |
awaiting_client, term_signed, contract_created, loan_disbursed, closed Was this page helpful?