Partner Admin

Server

Create or update a partner organization

POST

https://core.mobicred.net

/internal/staff/partners

Staff-admin endpoint used by MobiCred operators to create the durable partner record before issuing tenant credentials. Protected by staff Keycloak roles in Core.

Create or update a partner organization › Request Body

PartnerAdminUpsertRequest

code

string · pattern: ^[a-z0-9_-]{2,64}$ · required

displayName

string · maxLength: 128 · required

legalName

string · maxLength: 160

riskTier

string

countryCodes

string[]

defaultCurrency

string · minLength: 3 · maxLength: 3

object

Create or update a partner organization › Responses

Partner organization created or updated

PartnerAdminEnvelope

success

boolean · const · required

Const value:

PartnerAdmin · required

ResponseMeta · required

POST/internal/staff/partners

curl https://core.mobicred.net/internal/staff/partners \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "code": "mobicred",
  "displayName": "MobiCred",
  "legalName": "MobiCred",
  "riskTier": "LOW",
  "countryCodes": [
    "CI"
  ],
  "defaultCurrency": "XOF",
  "metadata": {}
}'

Example Request Body

{
  "code": "mobicred",
  "displayName": "MobiCred",
  "legalName": "MobiCred",
  "riskTier": "LOW",
  "countryCodes": [
    "CI"
  ],
  "defaultCurrency": "XOF",
  "metadata": {}
}

json

Example Responses

{
  "success": true,
  "data": {
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "partnerCode": "mobicred",
    "displayName": "MobiCred",
    "status": "ACTIVE",
    "countryCodes": [
      "CI"
    ]
  },
  "meta": {
    "requestId": "req_01j2mobicred",
    "timestamp": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Create or update a partner tenant

POST

https://core.mobicred.net

/internal/staff/partners/{partnerCode}/tenants

Create or update a partner tenant › path Parameters

partnerCode

string · pattern: ^[a-z0-9_-]{2,64}$ · required

Lowercase partner code issued by MobiCred.

Create or update a partner tenant › Request Body

PartnerTenantAdminUpsertRequest

tenantId

string · pattern: ^[a-z0-9_-]{2,64}$ · required

displayName

string · maxLength: 128 · required

environment

string

countryCodes

string[]

object

Create or update a partner tenant › Responses

Partner tenant created or updated

PartnerTenantAdminEnvelope

success

boolean · const · required

Const value:

PartnerTenantAdmin · required

ResponseMeta · required

POST/internal/staff/partners/{partnerCode}/tenants

curl https://core.mobicred.net/internal/staff/partners/:partnerCode/tenants \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tenantId": "mobicred-core",
  "displayName": "MobiCred Core/App",
  "environment": "PRODUCTION",
  "countryCodes": [
    "CI"
  ],
  "metadata": {}
}'

Example Request Body

{
  "tenantId": "mobicred-core",
  "displayName": "MobiCred Core/App",
  "environment": "PRODUCTION",
  "countryCodes": [
    "CI"
  ],
  "metadata": {}
}

json

Example Responses

{
  "success": true,
  "data": {
    "partnerTenantId": "00000000-0000-0000-0000-000000000000",
    "partnerCode": "mobicred",
    "tenantId": "mobicred-core",
    "displayName": "MobiCred Core/App",
    "environment": "PRODUCTION",
    "status": "ACTIVE",
    "countryCodes": [
      "CI"
    ]
  },
  "meta": {
    "requestId": "req_01j2mobicred",
    "timestamp": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Issue or rotate a partner API credential

POST

https://core.mobicred.net

/internal/staff/partners/{partnerCode}/credentials

Creates a hashed partner API credential for one tenant. The raw apiKey is returned once in the response and is never stored in Core.

Issue or rotate a partner API credential › path Parameters

partnerCode

string · pattern: ^[a-z0-9_-]{2,64}$ · required

Lowercase partner code issued by MobiCred.

Issue or rotate a partner API credential › Request Body

PartnerCredentialIssueRequest

tenantId

string · required

credentialKey

string

Public credential key sent as X-API-Key-Id.

scopes

string[]

expiresAt

string · date-time

object

Issue or rotate a partner API credential › Responses

Partner credential issued; store apiKey in a secret manager

PartnerCredentialEnvelope

success

boolean · const · required

Const value:

PartnerCredentialIssued · required

ResponseMeta · required

POST/internal/staff/partners/{partnerCode}/credentials

curl https://core.mobicred.net/internal/staff/partners/:partnerCode/credentials \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tenantId": "mobicred-core",
  "credentialKey": "mobile-bff",
  "scopes": [
    "users:write",
    "users:read"
  ],
  "expiresAt": "2024-08-25T15:00:00Z",
  "metadata": {}
}'

Example Request Body

{
  "tenantId": "mobicred-core",
  "credentialKey": "mobile-bff",
  "scopes": [
    "users:write",
    "users:read"
  ],
  "expiresAt": "2024-08-25T15:00:00Z",
  "metadata": {}
}

json

Example Responses

{
  "success": true,
  "data": {
    "partnerCode": "mobicred",
    "tenantId": "mobicred-core",
    "credentialId": "00000000-0000-0000-0000-000000000000",
    "credentialKey": "mobile-bff",
    "apiKey": "mk_returned-once",
    "scopes": [
      "users:write",
      "users:read"
    ],
    "expiresAt": "2024-08-25T15:00:00Z"
  },
  "meta": {
    "requestId": "req_01j2mobicred",
    "timestamp": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Create or update partner tenant access policy

PUT

https://core.mobicred.net

/internal/staff/partners/{partnerCode}/access-policies

Defines IP allowlist and route scopes for one partner tenant. Partner API routes fail closed when no active policy allows the caller IP and operation scope.

Create or update partner tenant access policy › path Parameters

partnerCode

string · pattern: ^[a-z0-9_-]{2,64}$ · required

Lowercase partner code issued by MobiCred.

Create or update partner tenant access policy › Request Body

PartnerAccessPolicyUpsertRequest

tenantId

string · required

name

string · required

ipAllowlist

string[] · required

scopes

string[]

countryCodes

string[]

rateLimitPerMinute

integer

object

Create or update partner tenant access policy › Responses

Partner access policy created or updated

PartnerAccessPolicyEnvelope

success

boolean · const · required

Const value:

PartnerAccessPolicy · required

ResponseMeta · required

PUT/internal/staff/partners/{partnerCode}/access-policies

curl https://core.mobicred.net/internal/staff/partners/:partnerCode/access-policies \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tenantId": "mobicred-core",
  "name": "MobiCred internal app access",
  "ipAllowlist": [
    "127.0.0.1/32",
    "10.0.0.0/8"
  ],
  "scopes": [
    "users:write",
    "users:read"
  ],
  "countryCodes": [
    "CI"
  ],
  "rateLimitPerMinute": 120,
  "metadata": {}
}'

Example Request Body

{
  "tenantId": "mobicred-core",
  "name": "MobiCred internal app access",
  "ipAllowlist": [
    "127.0.0.1/32",
    "10.0.0.0/8"
  ],
  "scopes": [
    "users:write",
    "users:read"
  ],
  "countryCodes": [
    "CI"
  ],
  "rateLimitPerMinute": 120,
  "metadata": {}
}

json

Example Responses

{
  "success": true,
  "data": {
    "policyId": "00000000-0000-0000-0000-000000000000",
    "partnerCode": "mobicred",
    "tenantId": "mobicred-core",
    "name": "MobiCred internal app access",
    "status": "ACTIVE",
    "ipAllowlist": [
      "127.0.0.1/32",
      "10.0.0.0/8"
    ],
    "scopes": [
      "users:write",
      "users:read"
    ],
    "countryCodes": [
      "CI"
    ]
  },
  "meta": {
    "requestId": "req_01j2mobicred",
    "timestamp": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Payments Partner API

Create or update a partner organization

POST

https://core.mobicred.net

/internal/staff/partners

Staff-admin endpoint used by MobiCred operators to create the durable partner record before issuing tenant credentials. Protected by staff Keycloak roles in Core.

Create or update a partner organization › Request Body

PartnerAdminUpsertRequest

code

string · pattern: ^[a-z0-9_-]{2,64}$ · required

displayName

string · maxLength: 128 · required

legalName

string · maxLength: 160

riskTier

string

countryCodes

string[]

defaultCurrency

string · minLength: 3 · maxLength: 3

object

Create or update a partner organization › Responses

Partner organization created or updated

PartnerAdminEnvelope

success

boolean · const · required

Const value:

PartnerAdmin · required

ResponseMeta · required

Create or update a partner tenant

POST

https://core.mobicred.net

/internal/staff/partners/{partnerCode}/tenants

Create or update a partner tenant › path Parameters

partnerCode

string · pattern: ^[a-z0-9_-]{2,64}$ · required

Lowercase partner code issued by MobiCred.

Create or update a partner tenant › Request Body

PartnerTenantAdminUpsertRequest

tenantId

string · pattern: ^[a-z0-9_-]{2,64}$ · required

displayName

string · maxLength: 128 · required

environment

string

countryCodes

string[]

object

Create or update a partner tenant › Responses

Partner tenant created or updated

PartnerTenantAdminEnvelope

success

boolean · const · required

Const value:

PartnerTenantAdmin · required

ResponseMeta · required

Issue or rotate a partner API credential

POST

https://core.mobicred.net

/internal/staff/partners/{partnerCode}/credentials

Creates a hashed partner API credential for one tenant. The raw apiKey is returned once in the response and is never stored in Core.

Issue or rotate a partner API credential › path Parameters

partnerCode

string · pattern: ^[a-z0-9_-]{2,64}$ · required

Lowercase partner code issued by MobiCred.

Issue or rotate a partner API credential › Request Body

PartnerCredentialIssueRequest

tenantId

string · required

credentialKey

string

Public credential key sent as X-API-Key-Id.

scopes

string[]

expiresAt

string · date-time

object

Issue or rotate a partner API credential › Responses

Partner credential issued; store apiKey in a secret manager

PartnerCredentialEnvelope

success

boolean · const · required

Const value:

PartnerCredentialIssued · required

ResponseMeta · required

Create or update partner tenant access policy

PUT

https://core.mobicred.net

/internal/staff/partners/{partnerCode}/access-policies

Defines IP allowlist and route scopes for one partner tenant. Partner API routes fail closed when no active policy allows the caller IP and operation scope.

Create or update partner tenant access policy › path Parameters

partnerCode

string · pattern: ^[a-z0-9_-]{2,64}$ · required

Lowercase partner code issued by MobiCred.

Create or update partner tenant access policy › Request Body

PartnerAccessPolicyUpsertRequest

tenantId

string · required

name

string · required

ipAllowlist

string[] · required

scopes

string[]

countryCodes

string[]

rateLimitPerMinute

integer

object

Create or update partner tenant access policy › Responses

Partner access policy created or updated

PartnerAccessPolicyEnvelope

success

boolean · const · required

Const value:

PartnerAccessPolicy · required

ResponseMeta · required