Synapse API

REST:
  Sandbox:    https://sandbox.synapse.axon.com
  Production: https://synapse.axon.com

gRPC:
  Sandbox:    sandbox.synapse.axon.com:443
  Production: synapse.axon.com:443

{
  "source_format": "pacs.008",
  "target_format": "pix_payment",
  "message": "<Document xmlns='urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08'>...</Document>",
  "options": {
    "validate": true,
    "enrich": true
  }
}

{
  "transformation_id": "tr_abc123",
  "source_format": "pacs.008",
  "target_format": "pix_payment",
  "result": {
    "end_to_end_id": "E12345678901234567890123456789012",
    "amount": 150.00,
    "currency": "BRL",
    "debtor": {
      "name": "JOAO SILVA",
      "document": "***.***.789-00"
    },
    "creditor": {
      "name": "EMPRESA ABC LTDA",
      "document": "**.***.567/0001-**"
    }
  },
  "created_at": "2026-02-07T10:30:00Z"
}

{
  "message_type": "PACS008",
  "channel": "PRIMARY",
  "params": {
    "transactions": [{
      "amount": 15000,
      "debtor": {
        "ispb": "12345678",
        "name": "JOAO SILVA",
        "document": "12345678900",
        "account_num": "123456",
        "account_type": "CACC"
      },
      "creditor": {
        "ispb": "87654321",
        "name": "EMPRESA ABC LTDA",
        "document": "12345678000199",
        "account_num": "654321",
        "account_type": "CACC"
      },
      "purpose": "OTHR"
    }],
    "local_instrument": "DICT"
  }
}

{
  "message_type": "PACS002",
  "params": {
    "original_end_to_end_id": "E12345678202601011200abcdefghijk",
    "status": "ACCC"
  }
}

{
  "message_type": "PACS004",
  "params": {
    "original_end_to_end_id": "E12345678202601011200abcdefghijk",
    "amount": 15000,
    "return_reason": "MD06"
  }
}

{
  "id": "msg_abc123",
  "biz_msg_idr": "M12345678abcdefghijklmnopqrstuvw",
  "message_type": "PACS008",
  "status": "queued"
}

{
  "messages": [
    {
      "id": "msg_abc123",
      "type": "pacs.008",
      "direction": "INBOUND",
      "status": "PROCESSED",
      "source_ispb": "12345678",
      "destination_ispb": "87654321",
      "end_to_end_id": "E12345678901234567890123456789012",
      "created_at": "2026-02-07T10:30:00Z"
    }
  ],
  "total": 1
}

{
  "url": "https://sua-api.com/webhooks/synapse",
  "secret": "whsec_abc123",
  "events": ["pacs.008", "pacs.002", "camt.054"],
  "active": true
}

{
  "id": "wh_abc123",
  "url": "https://sua-api.com/webhooks/synapse",
  "events": ["pacs.008", "pacs.002", "camt.054"],
  "active": true,
  "created_at": "2026-02-07T10:30:00Z"
}

{
  "status": "ok",
  "version": "2.0.0",
  "database": "ok"
}

syntax = "proto3";

package synapse.v1;

service TransformationService {
  // Transforma uma mensagem ISO 20022
  rpc Transform(TransformRequest) returns (TransformResponse);

  // Stream de transformacoes em lote
  rpc TransformStream(stream TransformRequest) returns (stream TransformResponse);

  // Lista transformacoes suportadas
  rpc ListTransformations(ListTransformationsRequest) returns (ListTransformationsResponse);
}

message TransformRequest {
  string source_format = 1;
  string target_format = 2;
  bytes message = 3;
  TransformOptions options = 4;
}

message TransformResponse {
  string transformation_id = 1;
  bytes result = 2;
  TransformationStatus status = 3;
}

enum TransformationStatus {
  SUCCESS = 0;
  VALIDATION_ERROR = 1;
  PARSE_ERROR = 2;
  UNSUPPORTED_FORMAT = 3;
}

package main

import (
    "context"
    "log"

    synapsev1 "github.com/axon-fintech/synapse-go/v1"
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials"
)

func main() {
    creds := credentials.NewClientTLSFromCert(nil, "")
    conn, err := grpc.Dial("synapse.axon.com:443",
        grpc.WithTransportCredentials(creds),
        grpc.WithPerRPCCredentials(apiKeyAuth{"your-api-key"}),
    )
    if err != nil {
        log.Fatal(err)
    }
    defer conn.Close()

    client := synapsev1.NewTransformationServiceClient(conn)

    resp, err := client.Transform(context.Background(), &synapsev1.TransformRequest{
        SourceFormat: "pacs.008",
        TargetFormat: "pix_payment",
        Message:      []byte(pacs008XML),
    })
    if err != nil {
        log.Fatal(err)
    }

    log.Printf("Transformation ID: %s", resp.TransformationId)
}