POST
Create or update a PSP connection (BYOK)

Authorizations

X-Reevit-Key
string
header
required

API key for server-to-server authentication

Headers

X-Org-Id
string
required

Organization identifier for multi-tenancy

Idempotency-Key
string

Idempotency key for safe retries

Body

application/json
provider
enum<string>
required
Available options:
paystack,
hubtel,
flutterwave,
monnify,
mpesa,
pawapay,
moolre,
stripe
credentials
object
required
id
string
mode
enum<string>
default:live
Available options:
sandbox,
live
status
enum<string>
default:active
Available options:
active,
inactive
capabilities
object
routing_hints
object
labels
string[]

Up to 20 lowercase labels (letters, numbers, -, _)

workflow_id
string

Optional workflow invoked for payments routed through this connection

Response

Created

id
string
provider
string
mode
string
status
string
capabilities
object
routing_hints
object
labels
string[]
workflow_id
string
fee_structure
object
total_calls
integer<int64>
successful_calls
integer<int64>
failed_calls
integer<int64>
total_latency_ms
integer<int64>
last_success_at
string<date-time>
last_failure_at
string<date-time>
health_score
number<float>
health_status
string
last_validated_at
string<date-time>
last_validation_status
string
last_validation_error
string
validation_failures
integer
name_match_status
enum<string>

Result of the PSP account-name verification check run after credential validation. unknown — check has not run yet or the PSP does not support it. match — the merchant's registered name matches the PSP account name. mismatch — the names do not match; the connection may still be usable but should be reviewed.

Available options:
unknown,
match,
mismatch
created_at
string<date-time>
updated_at
string<date-time>