1. Payouts
Almara Pay Documentation
  • Introduction
  • Definitions
    • Data Types
    • Error Codes
    • MCCMNC Codes
  • Authorization
    • Overview
    • Token Request
      POST
    • Find Transaction Routes
      GET
    • Health Check
      GET
  • Payouts
    • Overview
    • Payment Order Request Information
    • Mobile Money Requests
      • Overview
      • Mobile Transfers- Safaricom (M-Pesa)
      • Mobile Transfers - Airtel Money
    • Payment Order Requests - Business Transfers
      POST
    • Payment Order Requests - Bank Transfers
      POST
    • Find Payment Order By OriginatorConversationId
      GET
    • Reject Order By OriginatorConversationId
      POST
  • Pay-Ins
    • Payment Links
      • Overview
      • Create Payment Link
      • Find Payment Links By Id
      • Update Payment Link
    • Express Deposits
      • Overview
      • Express Deposit Request
      • Find Express Deposit By OriginatorConversationId
    • C2B IPN (Callback)
      • C2B IPN Overview
  • Card Payments
    • Overview
    • Checkout Order Request
      POST
    • Query Checkout Request
      GET
    • Checkout Callback Request
      POST
  • Account Validation
    • Overview
    • Account Number Validation Request
      POST
    • Find KYC Status by SystemTraceAuditNumber
      GET
    • Account Validation
      POST
    • Find Account Validation Status by SystemTraceAuditNumber
      GET
  • Platform Services
    • Airtime Purchase
      • Overview
      • Airtime Purchase
      • Find Airtime Purchases By OriginatorConversationId
    • Customer Accounts
      • Balance Check
      • Find Charges By TransactionTypeId
    • Bill Payments
      • Overview
      • Bill Request Validation
      • Bill Request Payment
      • Find Bill Services
      • Find Bill Number By Service Id and Account Number
      • Find Bill Request By Originator Converstion Id
      • Bill Number
  1. Payouts

Payment Order Requests - Business Transfers

Developing
POST
/v1/payment-order/new-order
Description
Almara Pay supports outbound payments (B2B) via Business Transfers
This is for M-Pesa Paybill and M-Pesa Till Number(Buy Goods)
Note: A valid token is required for authentication as it expires after every hour. Refer to Token Request to generate a new token.

Sample Buy Goods / Till Number request#

{
	"originatorConversationId": "{{$guid}}",
	"paymentNotes": "BuyGoodsTransfer",
	"paymentOrderLines": [
		{
			"recipient": {
				"name": "JOSEPH KIMANI",
				"address": null,
				"emailAddress": null,
				"phoneNumber": null,
				"idType": null,
				"idNumber": null,
				"financialInstitution": "Mobile",
				"primaryAccountNumber": "254700836996",   // Safaricom based phone number
				"mccmnc": 63902,
				"ccy": 404,
				"country": "KE",
				"purpose": "Disbursement",
				"institutionIdentifier": "3674408"  // Till Number
			},
			"transaction": {
				"routeId": "d883e7e7-fc0e-f111-858d-062ab3a3eac8",
				"channelType": 13,
				"amount": 4500.0,
				"reference":  "{{$guid}}",
				"systemTraceAuditNumber":  "{{$guid}}",
				"accountNo": "254700000356"
			}
		}
	]
}

Sample Business Paybill request#

{
	"originatorConversationId":  "{{$guid}}",
	"paymentNotes": "PaybillTransfer",
	"paymentOrderLines": [
		{
			"recipient": {
				"name": "JULIET JOY CHERUIYOT",
				"address": null,
				"emailAddress": null,
				"phoneNumber": null,
				"idType": null,
				"idNumber": null,
				"financialInstitution": "Coop",
				"primaryAccountNumber": "4949",  // Account number
				"mccmnc": 63902,
				"ccy": 404,
				"country": "KE",
				"purpose": "Disbursement",
				"institutionIdentifier": "545500"  // Paybill number
			},
			"transaction": {
				"routeId": "F012CA13-D28F-F011-8575-062AB3A3EAC8",
				"channelType": 14,
				"amount": 3450.0,
				"reference": "{{$guid}}",
				"systemTraceAuditNumber": "{{$guid}}",
				"accountNo": "4949"  // Account number
			}
		}
	]
}

Request

Authorization

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/payment-order/new-order'
Response Response Example
{}
Modified at 2026-04-30 06:16:09
Previous
Mobile Transfers - Airtel Money
Next
Payment Order Requests - Bank Transfers
Built with