Skip to main content

Recuva Mandate Setup

Direct debit mandate provider via Recuva.

Configuration Keys

KeyDescription
RECUVA_MANDATE_ENABLEDEnable Recuva mandates
RECUVA_API_BASE_URLRecuva API endpoint
RECUVA_API_KEYAPI key
RECUVA_WEBHOOK_SECRETWebhook verification secret
RECUVA_INSTITUTION_CODEInstitution identifier
RECUVA_MANDATE_INITIATE_ENDPOINTMandate initiation path
RECUVA_MANDATE_RETRIEVE_ENDPOINTMandate retrieval path
RECUVA_MANDATE_CANCEL_ENDPOINTCancellation path
RECUVA_MANDATE_PAUSE_ENDPOINTPause path
RECUVA_MANDATE_REINSTATE_ENDPOINTReinstate path
RECUVA_DIRECT_DEBIT_REPAYMENT_ENDPOINTDebit repayment path
MANDATE_DEFAULT_PROVIDERSet to Recuva

Webhooks

Recuva sends callbacks to:

  • POST /api/integrations/recova/v1/{institutionId}/SmsAlert
  • POST /api/integrations/recova/v1/{institutionId}/MandateCreation
  • POST /api/integrations/recova/v1/{institutionId}/LoanBalanceUpdate
  • GET /api/integrations/recova/v1/{institutionId}/LoanDueAmount/{reference}

Troubleshooting

  • Webhook HMAC fails: Verify RECUVA_WEBHOOK_SECRET matches Recuva dashboard
  • Mandate creation returns 403: Check RECUVA_API_KEY validity