Sign in
Entries

Create a directory entry

Register a new directory entry. The combination of rail + identifier must be unique. Global entries (no tenantId) are visible to all tenants.

post/api/directory/entries

Headers

x-tenant-idstring required

Request body

railstring required
identifierstring required
tenantIdstring nullable
gatewaystring nullable
currenciesstring[]
priorityinteger
routingInfoobject
status'ACTIVE' | 'SUSPENDED'

Response

Entry created

idstring uuid
railstring

Payment rail type (e.g. mobile_money, bank_transfer, card)

identifierstring

Unique identifier within the rail

tenantIdstring nullable

Owning tenant ID, null for global entries

gatewaystring nullable

Gateway provider name

currenciesstring[]

Supported ISO 4217 currency codes

priorityinteger

Routing priority (lower = preferred)

routingInfoobject

Arbitrary gateway-specific routing metadata

status'ACTIVE' | 'SUSPENDED'
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.