Cooperative Bank of Oromia - global-121/121-platform GitHub Wiki

Cooperative Bank of Oromia Integration Guide

This page contains information about configuring the Cooperative Bank of Oromia (Coopbank) FSP integration in a 121 Platform Instance.

Configure Environment Variables

For the Coopbank FSP integration to work for any program, several settings must be configured via environment variables:

API URLs

COOPERATIVE_BANK_OF_OROMIA_API_URL
COOPERATIVE_BANK_OF_OROMIA_AUTH_URL
  • COOPERATIVE_BANK_OF_OROMIA_API_URL: The base URL for Coopbank's main API endpoints (e.g., transfers, account validation).
  • COOPERATIVE_BANK_OF_OROMIA_AUTH_URL: The base URL for authentication (OAuth2 token retrieval). For Cooperative Bank of Oromia this is a different url.

Credentials

COOPERATIVE_BANK_OF_OROMIA_BASE64_CREDENTIALS
  • The base64-encoded credentials for authenticating with Coopbank's API.

Narrative

COOPERATIVE_BANK_OF_OROMIA_NARRATIVE
  • The transaction narrative to be sent with transfers. Should not be longer than 10 alphanumeric chars.

Program FSP Configuration

When adding Coopbank as an FSP to a program, ensure the following configuration properties are set:

  • debitAccountNumber - The account number from which funds are debited.

Payment Flow

When a payment is made to a registration with Coopbank FSP:

  • The platform authenticates with Coopbank using OAuth2.
  • A transfer request is sent to Coopbank's API, debiting the specified account and crediting the recipient's account.
  • The platform receives a response indicating success, failure, or duplicate transaction.
  • For account validation, the platform sends a request to Coopbank's account validation endpoint and processes the response. This happens in a nightly cronjob. Data can be downloaded from the platform