Contacts
Create beneficiary contact (Partner API)
Creates a new beneficiary contact for transfers.
Supported Contact Types:
- Mobile Money: Wave, Orange Money, MTN Mobile Money, Moov Money, DJAMO
- PI: PI-SPI transfers to a beneficiary alias (only when PI is enabled for your business)
- Bank Account: Bank transfers via RIB (Relevé d'Identité Bancaire)
Mobile Money Contact: Requires a phone number in the identifier object.
PI Contact:
Requires the beneficiary PI alias in identifier.alias (1 to 64 characters). Returns 422 when PI is not enabled for your business.
Bank Contact: Requires complete bank details including bank name, codes, account number, and RIB key.
Use Cases:
- Add payroll beneficiaries
- Register supplier payment details
- Save customer cash-out information
Authorization
ApiKey ApiKeyId X-API-KEY<token>
In: header
X-API-KEY-ID<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request schema for creating a mobile money contact
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/partner_api/contacts" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "paymentMethod": "orange", "identifier": { "number": "string" } }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "paymentMethod": "orange", "identifier": { "number": "string" }}