Proto Reference
Adullam partner gRPC APIs are defined in Protocol Buffer files under the packageofceabstudio.services.adullam.v1. This page summarizes the services and main message types.
Download the proto files
Download the v1 partner proto files and generate your own client using gRPC’s official docs:- partner_service.proto — services and request/response messages
- common.proto — shared enums and types (required by
partner_service.proto)
protoc, add the gRPC plugin, and generate client code from these .proto files.
Services
PartnerAuthenticationService
| RPC | Request | Response |
|---|---|---|
| GetToken | rpcTokenRequest (phone, password) | rpcAuthenticationToken (token) |
| RotateToken | rpcEmpty | rpcAuthenticationToken |
PartnerPaymentService
| RPC | Request | Response |
|---|---|---|
| CreatePayment | rpcCreatePaymentRequest (amount, currency, customerPhone, channel, description) | rpcPayment |
| GetPayment | rpcGetPaymentRequest (paymentId) | rpcPayment |
| ListPayments | rpcListPaymentsRequest (status, pagination, filters) | rpcListPaymentsResponse |
| RefundPayment | rpcRefundPaymentRequest (paymentId) | rpcRefund |
PartnerTransferService
| RPC | Request | Response |
|---|---|---|
| CreateTransfer | rpcCreateTransferRequest (amount, currency, recipientPhone, channel, description) | rpcTransfer |
| GetTransfer | rpcGetTransferRequest (transferId) | rpcTransfer |
| ListTransfers | rpcListTransfersRequest (status, pagination, filters) | rpcListTransfersResponse |
| ReverseTransfer | rpcReverseTransferRequest (transferId) | rpcReversal |
PartnerAccountService
| RPC | Request | Response |
|---|---|---|
| GetBalance | rpcEmpty | rpcBalance (balance, currency, lastUpdated) |
| GetAccount | rpcEmpty | rpcAccount (partnerId, businessName, phone, email, status, createdAt) |
Common enums (common.proto)
- rpcSupportedCurrency:
xof - rpcTransactionStatus:
pending,processing,completed,failed,expired - rpcPaymentChannel:
orangeCI,mtnCI,moovCI,waveCI - rpcRefundReason:
customerRequest,fraud,duplicate,error,technicalIssue,other
Key message types
- rpcPayment / rpcTransfer: id, status, amount, currency, channel, customerPhone/recipientPhone, description, reference, fees, metadata, createdAt, completedAt, failureReason, etc.
- rpcPaginationRequest: limit (max 100), cursor
- rpcPaginationResponse: hasMore, nextCursor
Generating client code
- Download the proto files from the links above (or from the gRPC overview).
- Use gRPC’s official guides for your language: grpc.io/docs/languages — they cover
protoc, language-specific plugins (e.g. Go, Java, Python, Node, Dart), and how to generate and use the client. - Run
protoc(or Buf) with your plugin; ensurecommon.protois in the same include path aspartner_service.proto. If you use the optionalbuf/validaterules, add that dependency to your include path.
Support
Need help? Contact us by email (support@adullam.dev), WhatsApp (chat), or Telegram (@adullam_official).