Class HunterTechPayClient

java.lang.Object

com.huntertechpay.client.HunterTechPayClient

public class HunterTechPayClient
extends Object

Main client for HunterTechPay API.

Example usage:

 HunterTechPayClient client = new HunterTechPayClient.Builder()
     .apiKey("your_api_key")
     .secretKey("your_secret_key")
     .build();

 PaymentRequest request = PaymentRequest.builder()
     .phoneNumber("+237690000000")
     .amount(5000.0)
     .currency("XAF")
     .country("CM")
     .serviceCode("CM_OMCMR_CASHOUT")
     .partnerId("order-123")
     .build();

 PaymentResponse response = client.initiatePayment(request);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HunterTechPayClient.Builder

Method Summary

Modifier and Type	Method	Description
PaymentResponse	checkStatus(String partnerId)	Check payment status by partner ID.
PaymentResponse	deposit(PaymentRequest request)	Deposit (CASHIN) - From mobile money to wallet.
BalanceResponse	getBalance(String currency)	Get account balance.
ProvidersResponse	getProviders()	Get available payment providers.
ProvidersResponse	getProviders(String countryCode)	Get available payment providers for a specific country.
TransactionListResponse	getTransactions(int page, int limit)	Get list of transactions.
PaymentResponse	initiatePayment(PaymentRequest request)	Initiate a new payment.
KYCVerificationResponse	kyc(KYCVerificationRequest request)	Verify KYC (Know Your Customer) information for a phone number.
WebhookEvent	parseWebhookEvent(String payload)	Parse webhook event.
boolean	verifyWebhookSignature(String payload, long timestamp, String signature)	Verify webhook signature.
PaymentResponse	withdraw(PaymentRequest request)	Withdraw (CASHOUT) - From wallet to mobile money.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

initiatePayment

public PaymentResponse initiatePayment(PaymentRequest request)
                                throws HunterTechPayException

Initiate a new payment.

Parameters:

request - Payment request details

Returns:

Payment response with transaction ID

Throws:

HunterTechPayException - if request fails

deposit

public PaymentResponse deposit(PaymentRequest request)
                        throws HunterTechPayException

Deposit (CASHIN) - From mobile money to wallet.

Parameters:

request - Payment request details

Returns:

Payment response with transaction ID

Throws:

HunterTechPayException - if request fails

withdraw

public PaymentResponse withdraw(PaymentRequest request)
                         throws HunterTechPayException

Withdraw (CASHOUT) - From wallet to mobile money.

Parameters:

request - Payment request details

Returns:

Payment response with transaction ID

Throws:

HunterTechPayException - if request fails

getProviders

public ProvidersResponse getProviders()
                               throws HunterTechPayException

Get available payment providers.

Returns:

List of all available providers

Throws:

HunterTechPayException - if request fails

getProviders

public ProvidersResponse getProviders(String countryCode)
                               throws HunterTechPayException

Get available payment providers for a specific country.

Parameters:

countryCode - Country code (CM, SN, CI, etc.)

Returns:

List of providers for the specified country

Throws:

HunterTechPayException - if request fails

checkStatus

public PaymentResponse checkStatus(String partnerId)
                            throws HunterTechPayException

Check payment status by partner ID.

Parameters:

partnerId - Your unique reference ID

Returns:

Payment status

Throws:

HunterTechPayException - if request fails

kyc

public KYCVerificationResponse kyc(KYCVerificationRequest request)
                            throws HunterTechPayException

Verify KYC (Know Your Customer) information for a phone number.

Parameters:

request - KYC verification request details

Returns:

KYC verification response with customer information

Throws:

HunterTechPayException - if request fails

getTransactions

public TransactionListResponse getTransactions(int page,
 int limit)
                                        throws HunterTechPayException

Get list of transactions.

Parameters:

page - Page number (1-based)

limit - Number of transactions per page

Returns:

List of transactions

Throws:

HunterTechPayException - if request fails

getBalance

public BalanceResponse getBalance(String currency)
                           throws HunterTechPayException

Get account balance.

Parameters:

currency - Currency code (XAF or XOF)

Returns:

Balance information

Throws:

HunterTechPayException - if request fails

verifyWebhookSignature

public boolean verifyWebhookSignature(String payload,
 long timestamp,
 String signature)

Verify webhook signature.

Parameters:

payload - Webhook payload as JSON string

timestamp - Timestamp from X-Hunter-Timestamp header

signature - Signature from X-Hunter-Signature header

Returns:

true if signature is valid

parseWebhookEvent

public WebhookEvent parseWebhookEvent(String payload)
                               throws HunterTechPayException

Parse webhook event.

Parameters:

payload - Webhook payload as JSON string

Returns:

Parsed webhook event

Throws:

HunterTechPayException - if parsing fails