Skip to main content
A recipient is a saved destination for payments outside Ledig. Create the recipient, check its approval status, then use its ID when requesting a payment quote.

Choose the destination details

Required details depend on the currency, country and payment method. Use the current bank and mobile money options provided in your dashboard or integration setup. Contact support@ledig.io if you need those options for your integration. Send destination values as strings in the fields array. Fiat recipients require currency and country. Bank and mobile money recipients, except ZAR, also require legalEntityType and the corresponding name fields: Use the recipient’s correct legal name. Ledig builds the account holder name from these fields.

Create a bank recipient

This NGN example uses a fictional business and account number. Replace the account details and bank values with your recipient’s details. Use the bank code and name from the available bank options.
NGN account numbers contain ten digits. For an individual, use legalEntityType: "individual" and replace businessName with firstName, lastName and, when needed, middleName. Other currencies may require additional bank or address details. Where manual bank entry is available, supply the required bank details directly instead of inventing a bank code.

Crypto destinations

Call GET /v1/recipient-requirements/crypto-networks to get supported payout networks and assets. Use the exact returned network identifier. Create a crypto recipient with this request shape, replacing the network and address placeholders:
currency and country are optional for crypto_address. If you include a currency, it must be supported on the selected network. Add a memo field when the recipient’s receiving instructions require one. Confirm the address, network and any memo with the recipient. A valid address format alone does not confirm that it is the correct destination. Keep sandbox and live destinations separate.

Check approval status

Read GET /v1/recipients/{id} after creating the recipient: Approval may happen automatically, so use the returned status. Check active and usableForPayout before offering the recipient as a payment destination. usableForPayout is a selection hint, not permission to send. Use payoutReadiness to explain the saved recipient state: Reading a recipient does not run new payment checks. None of these states guarantees that a payment will succeed. Payment options and quotes check your chosen currency, amount and destination; sending checks eligibility again. If payment options return 423 COMPLIANCE_REVIEW_REQUIRED, keep the recipient and wait for review. Do not automatically retry or create a replacement to get around the review. Contact support@ledig.io when you need an update.

Use or remove a recipient

For a payout, supply the approved recipient ID to payment options and use a returned paymentMethodIds value in your quote. GET /v1/recipients lists recipients using cursor pagination. DELETE /v1/recipients/{id} removes a recipient from future use; past payment history remains available. To pay another Ledig business, use its business ID instead of creating a recipient. See Pay a Ledig business.