Skip to main content

​
Adullam gRPC API Overview

The Adullam gRPC API exposes the same partner capabilities as the REST API over a binary protocol, suited for performance-sensitive or server-to-server integration: authentication, payments, transfers, and account.

​
Why gRPC?

  • Lower latency and smaller payloads than JSON over REST.
  • Strong typing via Protocol Buffers; generate clients for your language from the .proto files.
  • Streaming support where needed.

​
Services

Adullam defines four partner-facing gRPC services in the package ofceabstudio.services.adullam.v1:
ServiceDescription
PartnerAuthenticationServiceGetToken, RotateToken
PartnerPaymentServiceCreatePayment, GetPayment, ListPayments, RefundPayment
PartnerTransferServiceCreateTransfer, GetTransfer, ListTransfers, ReverseTransfer
PartnerAccountServiceGetBalance, GetAccount

​
Download the v1 partner proto files

Download the Protocol Buffer definitions for the partner API (v1) and use them with the gRPC tooling for your language to generate your own client.
FileDescription
partner_service.protoPartner services and messages (auth, payments, transfers, account)
common.protoShared enums and types (currency, status, channel, pagination)
Place both files in the same directory (e.g. protos/v1/). partner_service.proto imports common.proto. It also references buf/validate/validate.proto; for code generation you can use Buf or include the buf validate dependency.

​
Generate your own client

Use the official gRPC documentation for your language to install the compiler and plugins, then generate client code from the downloaded .proto files: Typical flow: install protoc, add the gRPC plugin for your language, then run something like: 
protoc -I protos/v1 --go_out=... --go-grpc_out=... protos/v1/*.proto

​
Authentication

Send the access token (obtained via REST POST /v1/auth/token or gRPC GetToken) in gRPC metadata using the key authorization:
  • Metadata key: authorization
  • Value: the token only (no Bearer prefix)

​
Support

Need help? Contact us by email (support@adullam.dev), WhatsApp (chat), or Telegram (@adullam_official).