Get Recipient

GET /api-access/api/recipients/{id}

Retrieve a specific recipient by ID.

Authentication

Required Headers:

Authorization: HMAC-SHA256 PUBLIC_KEY:PRIVATE_KEY
X-Origin: third-party-api
X-Timestamp: 2025-10-12T14:30:00.000Z
Content-Type: application/json

Request

Path Parameters:

Parameter	Type	Required	Description
id	string	Yes	Recipient ID

Response

Success Response (200):

{
  "data": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "country": "string",
    "withdrawal_channel": "ATM",
    "account_number": "string",
    "account_branch": "string",
    "account_type": "corporate",
    "bank_code": "string",
    "institution_number": "string",
    "transit_number": "string",
    "security_question": "string",
    "security_question_answer": "string",
    "transaction_type": "interac_send",
    "recipient_type": "reversal",
    "language": "en",
    "created_at": "2025-10-12T18:05:34.104Z",
    "updated_at": "2025-10-12T18:05:34.104Z",
    "avatar": "string",
    "provider": "string",
    "payee_name": "string",
    "payee_code": "string",
    "user_id": "string",
    "business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "success": true,
  "message": "string",
  "detail": {}
}

Response Fields:

Field	Type	Description
data	object	Recipient object
data.id	string	Recipient ID
data.first_name	string	Recipient's first name
data.last_name	string	Recipient's last name
data.email	string	Email address
data.phone	string	Phone number
data.country	string	Country code
data.withdrawal_channel	string	Withdrawal channel (e.g., ATM)
data.account_number	string	Bank account number
data.account_branch	string	Account branch
data.account_type	string	Account type
data.bank_code	string	Bank code
data.institution_number	string	Institution number
data.transit_number	string	Transit number
data.transaction_type	string	Transaction type
data.recipient_type	string	Recipient type
data.language	string	Language preference
data.provider	string	Mobile money provider
data.payee_name	string	Payee name (for bill pay)
data.payee_code	string	Payee code (for bill pay)
data.user_id	string	User ID
data.business_id	string	Business ID
data.created_at	string	Creation timestamp (ISO 8601)
data.updated_at	string	Last update timestamp (ISO 8601)

Examples

cURL

curl -X GET "https://sandbox.mara.boo/api-access/api/recipients/{id}" \
  -H "Authorization: HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY" \
  -H "X-Origin: third-party-api" \
  -H "X-Timestamp: 2025-10-12T14:30:00.000Z" \
  -H "Content-Type: application/json"

JavaScript

const recipientId = 'recipient-id-here';
const response = await fetch(`https://sandbox.mara.boo/api-access/api/recipients/${recipientId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY',
    'X-Origin': 'third-party-api',
    'X-Timestamp': '2025-10-12T14:30:00.000Z',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

Python

import requests

recipient_id = 'recipient-id-here'
response = requests.get(
    f'https://sandbox.mara.boo/api-access/api/recipients/{recipient_id}',
    headers={
        'Authorization': 'HMAC-SHA256 YOUR_PUBLIC_KEY:YOUR_PRIVATE_KEY',
        'X-Origin': 'third-party-api',
        'X-Timestamp': '2025-10-12T14:30:00.000Z',
        'Content-Type': 'application/json'
    }
)

data = response.json()

Error Responses

Status Code	Description
400	Bad Request - Invalid recipient ID format
401	Unauthorized - Invalid authentication
403	Forbidden - Missing required headers
404	Not Found - Recipient doesn't exist
500	Internal Server Error

Related

• Get Recipients
• Create Recipient