HOhoneycoin
Cross-border Requests

Create a Cross-border Request

Changed on

Create a transfer with senderId and beneficiaryId. Returns senderAmount, senderCurrency, receiverCurrency, requiredDocuments and documents, with quote:null. Obtain a quote separately before charging. Nonempty document requirements start at documents_required; an empty list starts at pending_charge. Creation does not collect funds. Complete supporting document review before charging. Production and sandbox support momo and bank collections, subject to account collection availability. Source currencies are KES/NGN and destination currency is CNY, subject to route availability. Both purpose and subPurpose are required for every new request; see the schema for accepted values.

post/api/b2b/cross-border/requests

Request

  • Base URL
    https://api-v2.honeycoin.app
  • URL
    https://api-v2.honeycoin.app/api/b2b/cross-border/requests
  • Auth
    API key in header Authorization

Request body

senderIdstring required

An active sender ID belonging to your account in this environment.

purpose'salary' | 'service_payment' | 'goods_payment' | 'family_support' required
subPurpose'clothes_bags_shoes' | 'daily_supplies_and_cosmetics' | 'electronics_and_home_appliances' | 'toys_kids_babies' | 'interpretation_service' | 'translation_service' | 'human_resource_service' | 'estate_agency_service' | 'software_development_service' | 'web_design_or_development_service' | 'drafting_legal_service' | 'legal_related_certification_service' | 'accounting_service' | 'tax_service' | 'architectural_decoration_design_service' | 'advertising_service' | 'market_research_service' | 'exhibition_booth_service' | 'other_service' required

Required for every purpose in production and sandbox. All purposes accept this shared 19-value list. Select the exact lowercase value describing the payment; omitted, null, empty, or unsupported values are rejected. Use clothes_bags_shoes; the former clothes_bags_shoees spelling is not accepted.

amountnumber required

Amount to collect in chargeCurrency; returned as senderAmount. Obtain a quote with the same source amount before charging.

chargeCurrency'KES' | 'NGN' required

Accepted source currencies; collection availability depends on your account and method.

receiverCurrency'CNY' required
externalReferencestring required

Your unique reference for the request, unique within your account.

requestType'transfer' required

Use transfer for this flow. Collection requests are not supported.

beneficiaryIdstring required

An active saved beneficiary belonging to your account in this environment.

Example request

{
  "chargeDetails": {
    "phoneNumber": "254712345678",
    "momoOperatorId": "mpesa"
  }
}

Response

Successful response.

successtrue required

Changes