KulPayAPI Live

API reference

KulPay — Public API

Every operation of this gateway, with its parameters, body fields, an example request and an example of every response, errors included. Generated from openapi.json (OpenAPI 3.1, version 1.0.0).

Basics

Scopes

What each scope opens, read from the gateway's routes: a key holding a scope can call every operation listed for it.

ScopeAllowsOperations
accounts:read List every tenant.
27 operation(s)
  • GET /v1/admin/accounts/{id}/funds-flow
  • GET /v1/admin/accounts/{id}/settlement
  • GET /v1/admin/accounts/{id}/timeline
  • GET /v1/admin/approvals
  • GET /v1/admin/commission-plans
  • GET /v1/admin/fee-schedules
  • POST /v1/admin/fee-schedules/quote
  • GET /v1/admin/fee-schedules/{id}
  • GET /v1/admin/psp-reviews
  • GET /v1/admin/psps
  • GET /v1/admin/psps/{id}
  • GET /v1/admin/psps/{id}/certification/runs
  • GET /v1/admin/psps/{id}/certification/runs/{run}
  • GET /v1/admin/psps/{id}/certification/runs/{run}/events
  • GET /v1/admin/psps/{id}/certification/runs/{run}/report.json
  • GET /v1/admin/psps/{id}/certification/runs/{run}/report.pdf
  • GET /v1/admin/psps/{id}/commissions
  • GET /v1/admin/psps/{id}/configs
  • GET /v1/admin/psps/{id}/configs/{kind}/diff
  • GET /v1/admin/psps/{id}/configs/{kind}/{version}
  • GET /v1/admin/psps/{id}/go-live
  • GET /v1/admin/psps/{id}/go-live/checklist
  • GET /v1/admin/psps/{id}/kyb
  • GET /v1/admin/psps/{id}/kyb/documents/{doc}
  • GET /v1/admin/psps/{id}/logo
  • GET /v1/admin/psps/{id}/offboarding
  • GET /v1/admin/psps/{id}/technical
accounts:write Create tenants and issue their keys.
35 operation(s)
  • PUT /v1/admin/accounts/{id}/bill-balance-alert
  • PUT /v1/admin/accounts/{id}/deposit-tag
  • PUT /v1/admin/accounts/{id}/funds-flow
  • PUT /v1/admin/accounts/{id}/settlement
  • POST /v1/admin/approvals/{id}/decide
  • POST /v1/admin/commission-plans
  • POST /v1/admin/fee-schedules
  • POST /v1/admin/psps/{id}/certification/runs
  • POST /v1/admin/psps/{id}/configs/{kind}
  • POST /v1/admin/psps/{id}/configs/{kind}/{version}/rollback
  • POST /v1/admin/psps/{id}/contract
  • POST /v1/admin/psps/{id}/go-live
  • POST /v1/admin/psps/{id}/incidents
  • POST /v1/admin/psps/{id}/incidents/{incident}/resolve
  • PUT /v1/admin/psps/{id}/institution
  • POST /v1/admin/psps/{id}/kyb/decision
  • POST /v1/admin/psps/{id}/kyb/documents
  • POST /v1/admin/psps/{id}/kyb/documents/{doc}/review
  • POST /v1/admin/psps/{id}/kyb/risk-tier
  • POST /v1/admin/psps/{id}/kyb/screenings
  • POST /v1/admin/psps/{id}/kyb/screenings/run
  • PUT /v1/admin/psps/{id}/logo
  • POST /v1/admin/psps/{id}/logo/review
  • POST /v1/admin/psps/{id}/offboarding
  • POST /v1/admin/psps/{id}/offboarding/complete
  • PUT /v1/admin/psps/{id}/pilot
  • POST /v1/admin/psps/{id}/pilot/setup
  • POST /v1/admin/psps/{id}/reinstate
  • POST /v1/admin/psps/{id}/reviews
  • POST /v1/admin/psps/{id}/sandbox
  • POST /v1/admin/psps/{id}/suspension
  • POST /v1/admin/psps/{id}/transitions
  • POST /v1/admin/regulatory/templates
  • PUT /v1/admin/regulatory/templates/{id}
  • POST /v1/admin/safeguarding/accounts
admin:read Read the operator console.
35 operation(s)
  • GET /v1/admin/audit
  • GET /v1/admin/audit/verify
  • GET /v1/admin/bill-channels/{id}/access
  • GET /v1/admin/bill-payments
  • GET /v1/admin/bill-payments/{id}
  • GET /v1/admin/callbacks
  • GET /v1/admin/disputes
  • GET /v1/admin/events/dead-letters
  • GET /v1/admin/events/pipeline
  • GET /v1/admin/events/replays
  • GET /v1/admin/jobs
  • GET /v1/admin/keys (or keys:manage)
  • GET /v1/admin/payout-batches
  • GET /v1/admin/payout-batches/{id}/file
  • GET /v1/admin/psp-events
  • GET /v1/admin/psps/{id}/circuits
  • GET /v1/admin/residency
  • GET /v1/admin/risk
  • GET /v1/admin/risk/blocklist
  • GET /v1/admin/risk/reviews
  • GET /v1/admin/statement-cycles
  • GET /v1/admin/statement-files
  • GET /v1/admin/status
  • GET /v1/admin/webhooks/deliveries
  • GET /v1/admin/webhooks/deliveries/{id}
  • GET /v1/api-keys (or keys:manage)
  • GET /v1/api-keys/{id}/usage (or keys:manage)
  • GET /v1/client-ca (or keys:manage)
  • GET /v1/client-certificates (or keys:manage)
  • GET /v1/oauth-clients (or keys:manage)
  • GET /v1/payments/{id}/audit
  • GET /v1/webhook-endpoints (or webhooks:manage)
  • GET /v1/webhook-endpoints/{id} (or webhooks:manage)
  • GET /v1/webhook-endpoints/{id}/deliveries (or webhooks:manage)
  • GET /v1/webhook-schema-versions (or webhooks:manage)
admin:write Act in the operator console.
32 operation(s)
  • POST /v1/admin/audit/chains/verify
  • PUT /v1/admin/bill-channels/{id}/access
  • POST /v1/admin/bill-payments/{id}/resolve
  • POST /v1/admin/bill-payments/{id}/reverse
  • POST /v1/admin/callbacks/{id}/replay
  • POST /v1/admin/disputes
  • POST /v1/admin/disputes/{id}/decide
  • POST /v1/admin/events/dead-letters/{id}/replay
  • POST /v1/admin/events/replays
  • POST /v1/admin/jobs/{name}/run
  • POST /v1/admin/keys (or keys:manage)
  • DELETE /v1/admin/keys/{id} (or keys:manage)
  • POST /v1/admin/ledger/journals/{id}/reverse
  • POST /v1/admin/payout-batches/{id}/release
  • POST /v1/admin/psp-events/{id}/replay
  • POST /v1/admin/psps/{id}/statement-profiles/{profile_id}/fetch
  • POST /v1/admin/risk/blocklist
  • DELETE /v1/admin/risk/blocklist/{id}
  • POST /v1/admin/risk/reviews/{id}/decide
  • POST /v1/admin/risk/versions
  • POST /v1/admin/safeguarding/checks/run
  • POST /v1/admin/settlements/run
  • POST /v1/admin/test/clock/advance
  • POST /v1/api-keys (or keys:manage)
  • DELETE /v1/api-keys/{id} (or keys:manage)
  • PATCH /v1/api-keys/{id} (or keys:manage)
  • POST /v1/api-keys/{id}/roll (or keys:manage)
  • POST /v1/client-certificates (or keys:manage)
  • DELETE /v1/client-certificates/{id} (or keys:manage)
  • PUT /v1/mtls (or keys:manage)
  • POST /v1/oauth-clients (or keys:manage)
  • DELETE /v1/oauth-clients/{id} (or keys:manage)
audit:read Export signed audit bundles and read chain verification.
4 operation(s)
  • GET /v1/admin/audit/anchors
  • GET /v1/admin/audit/chains
  • POST /v1/admin/audit/exports
  • GET /v1/admin/audit/public-key
bills:artifacts See bill payments' tokens and PINs in clear; every use is recorded.
1 operation(s)
  • POST /v1/admin/bill-payments/{id}/artifacts
bills:read List billers and products, and look up customer references.
12 operation(s)
  • GET /v1/bill-commissions
  • POST /v1/bill-invoices/lookups
  • GET /v1/bill-invoices/{id}/document
  • GET /v1/bill-payments
  • POST /v1/bill-payments/lookups
  • GET /v1/bill-payments/{id}
  • GET /v1/bill-payments/{id}/receipt.pdf
  • GET /v1/billers
  • GET /v1/billers/{code}
  • GET /v1/payers/{id}
  • GET /v1/payers/{id}/invoices
  • GET /v1/payers/{id}/subscriptions
bills:write Quote and pay bills, airtime and vouchers.
7 operation(s)
  • POST /v1/bill-invoices/{id}/engagements
  • POST /v1/bill-payments
  • POST /v1/bill-payments/quotes
  • POST /v1/bill-payments/{id}/resend
  • POST /v1/payers
  • POST /v1/payers/{id}/subscriptions
  • DELETE /v1/payers/{id}/subscriptions/{sid}
compliance:read Read suspicious-activity cases (compliance only).
2 operation(s)
  • GET /v1/admin/compliance/cases
  • GET /v1/admin/compliance/cases/{id}
compliance:write Open, investigate and decide suspicious-activity cases (compliance only).
4 operation(s)
  • POST /v1/admin/compliance/cases
  • POST /v1/admin/compliance/cases/{id}/approve
  • POST /v1/admin/compliance/cases/{id}/decision
  • POST /v1/admin/compliance/cases/{id}/notes
connectors:read Read connector bindings.
14 operation(s)
  • GET /v1/admin/billers
  • GET /v1/admin/billers/{code}
  • GET /v1/admin/code-mappings
  • GET /v1/admin/code-mappings/{provider}
  • GET /v1/admin/credentials
  • GET /v1/admin/data-transfers
  • GET /v1/admin/data-transfers/export
  • GET /v1/admin/float-topups
  • GET /v1/admin/routing
  • POST /v1/admin/routing/dry-run
  • POST /v1/admin/routing/lookup-preview
  • GET /v1/admin/routing/versions/{version}
  • GET /v1/admin/supply-connectors
  • GET /v1/admin/supply-drivers
connectors:write Change connector bindings and platform rules.
20 operation(s)
  • POST /v1/admin/billers
  • PATCH /v1/admin/billers/{code}
  • POST /v1/admin/billers/{code}/certification
  • POST /v1/admin/billers/{code}/products
  • PATCH /v1/admin/billers/{code}/products/{product}
  • PUT /v1/admin/billers/{code}/products/{product}/channels
  • POST /v1/admin/billers/{code}/products/{product}/limits
  • POST /v1/admin/billers/{code}/products/{product}/offers
  • POST /v1/admin/billers/{code}/products/{product}/offers/refresh
  • POST /v1/admin/billers/{code}/status
  • POST /v1/admin/code-mappings/{provider}
  • POST /v1/admin/credentials
  • POST /v1/admin/credentials/{id}/rotate
  • PATCH /v1/admin/data-transfers/{connector}
  • POST /v1/admin/routing/versions
  • POST /v1/admin/routing/versions/{version}/rollback
  • POST /v1/admin/supply-connectors
  • PATCH /v1/admin/supply-connectors/{name}
  • POST /v1/admin/supply-connectors/{name}/float-topups
  • POST /v1/admin/supply-connectors/{name}/probe
events:read Read the account's events and catch up on webhooks.
3 operation(s)
  • GET /v1/event-types (or webhooks:manage)
  • GET /v1/events
  • GET /v1/events/{id}
invoices:read A biller reads the invoices it presented.
8 operation(s)
  • GET /v1/biller/engagement-digest
  • GET /v1/biller/invoices
  • GET /v1/biller/invoices/{number}
  • GET /v1/biller/invoices/{number}/document
  • GET /v1/biller/invoices/{number}/events
  • GET /v1/biller/remittances
  • GET /v1/biller/remittances/{id}/report.csv
  • GET /v1/biller/reports/daily
invoices:write A biller presents, changes and cancels its invoices.
7 operation(s)
  • PUT /v1/biller/engagement-digest
  • POST /v1/biller/invoice-files
  • POST /v1/biller/invoices
  • PATCH /v1/biller/invoices/{number}
  • DELETE /v1/biller/invoices/{number}/document
  • PUT /v1/biller/invoices/{number}/document
  • POST /v1/biller/reports/daily
keys:manage Issue, list and revoke the account's own API keys.
17 operation(s)
  • GET /v1/admin/keys (or admin:read)
  • POST /v1/admin/keys (or admin:write)
  • DELETE /v1/admin/keys/{id} (or admin:write)
  • GET /v1/api-keys (or admin:read)
  • POST /v1/api-keys (or admin:write)
  • DELETE /v1/api-keys/{id} (or admin:write)
  • PATCH /v1/api-keys/{id} (or admin:write)
  • POST /v1/api-keys/{id}/roll (or admin:write)
  • GET /v1/api-keys/{id}/usage (or admin:read)
  • GET /v1/client-ca (or admin:read)
  • GET /v1/client-certificates (or admin:read)
  • POST /v1/client-certificates (or admin:write)
  • DELETE /v1/client-certificates/{id} (or admin:write)
  • PUT /v1/mtls (or admin:write)
  • GET /v1/oauth-clients (or admin:read)
  • POST /v1/oauth-clients (or admin:write)
  • DELETE /v1/oauth-clients/{id} (or admin:write)
payers:write A biller enrols its customers to receive its bills on KulPay channels.
5 operation(s)
  • GET /v1/biller/notices
  • PUT /v1/biller/notices
  • GET /v1/biller/payers
  • POST /v1/biller/payers
  • DELETE /v1/biller/payers/{ref}
payments:capture Capture authorised payments.
1 operation(s)
  • POST /charges/{id}/capture
payments:read Read payments and their receipts.
9 operation(s)
  • GET /files
  • GET /files/{id}
  • GET /files/{id}/content
  • GET /methods
  • GET /payments/{id}/files
  • GET /payments/{provider_payment_id}
  • GET /transactions
  • GET /v1/disputes
  • GET /v1/disputes/{id}
payments:refund Refund payments.
1 operation(s)
  • POST /refunds
payments:write Create payments and cancel them.
6 operation(s)
  • POST /charges
  • POST /charges/{id}/complete-action
  • POST /charges/{id}/void
  • POST /files
  • POST /v1/disputes/{id}/accept
  • POST /v1/disputes/{id}/evidence
payouts:approve Approve or reject payouts above the approval threshold.
2 operation(s)
  • POST /v1/payouts/{id}/approve
  • POST /v1/payouts/{id}/reject
payouts:read Read payouts and the available balance.
4 operation(s)
  • GET /payouts/{provider_payout_id}
  • GET /v1/balance
  • GET /v1/payouts
  • GET /v1/payouts/{id}
payouts:write Send payouts and look up beneficiary names.
4 operation(s)
  • POST /payouts
  • POST /v1/name-lookups (or transactions:write)
  • POST /v1/name-lookups/{lookup_id}/select (or transactions:write)
  • POST /v1/payouts
psp:configure Configure the PSP's own capability matrix and orientation.
16 operation(s)
  • GET /v1/psps/{id}/capabilities
  • PUT /v1/psps/{id}/capabilities
  • GET /v1/psps/{id}/commissions
  • POST /v1/psps/{id}/credit-reconciliations
  • GET /v1/psps/{id}/credit-report
  • GET /v1/psps/{id}/keys
  • POST /v1/psps/{id}/keys
  • DELETE /v1/psps/{id}/keys/{key_id}
  • GET /v1/psps/{id}/orientation
  • PUT /v1/psps/{id}/orientation
  • GET /v1/psps/{id}/retry-policy
  • PUT /v1/psps/{id}/retry-policy
  • GET /v1/psps/{id}/statement-endpoints
  • GET /v1/psps/{id}/statement-profiles
  • PUT /v1/psps/{id}/statement-profiles
  • POST /v1/psps/{id}/statement-profiles/preview
reconciliation:read Read statements, matches and exceptions.
36 operation(s)
  • GET /v1/admin/bill-commissions
  • GET /v1/admin/bill-recon
  • GET /v1/admin/credit-reconciliations
  • GET /v1/admin/deposit-credits
  • GET /v1/admin/deposit-credits/{id}
  • GET /v1/admin/interop/dashboard
  • GET /v1/admin/outcome-queries
  • GET /v1/admin/payment-exceptions
  • GET /v1/admin/psps/{id}/credit-report
  • GET /v1/admin/reconciliation/fee-claims
  • GET /v1/admin/reconciliation/health
  • GET /v1/admin/reconciliation/periods
  • GET /v1/admin/reconciliation/periods/{period}/checklist
  • GET /v1/admin/reconciliation/periods/{period}/report
  • GET /v1/admin/reconciliation/statements
  • GET /v1/admin/reconciliation/statements/{id}
  • GET /v1/admin/reconciliation/statements/{id}/lines
  • GET /v1/admin/regulatory/runs
  • GET /v1/admin/regulatory/runs/{id}/file
  • GET /v1/admin/regulatory/templates
  • GET /v1/admin/remittances
  • GET /v1/admin/remittances/{id}/report.csv
  • GET /v1/admin/safeguarding/accounts
  • GET /v1/admin/safeguarding/checks
  • GET /v1/admin/safeguarding/checks/{id}/report
  • GET /v1/ledger/accounts
  • GET /v1/ledger/journals
  • GET /v1/ledger/journals/{id}
  • GET /v1/psp-settlements
  • GET /v1/reconciliation/exceptions
  • GET /v1/reconciliation/exceptions/{id}
  • GET /v1/statements
  • GET /v1/statements/{id}
  • GET /v1/statements/{id}/lines
  • GET /v1/statements/{id}/matches
  • GET /v1/statements/{id}/original
reconciliation:write Import statements and resolve exceptions.
25 operation(s)
  • PUT /v1/admin/billers/{code}/remit-account
  • POST /v1/admin/billers/{code}/remittances
  • POST /v1/admin/cash-deposits/{id}/resolve
  • POST /v1/admin/deposit-credits/{id}/resolve
  • POST /v1/admin/deposit-credits/{id}/reverse
  • POST /v1/admin/payment-exceptions/{id}/resolve
  • POST /v1/admin/reconciliation/lines/{lineID}/resolve
  • POST /v1/admin/reconciliation/periods/{period}/close
  • POST /v1/admin/reconciliation/statements
  • POST /v1/admin/reconciliation/statements/{id}/close
  • POST /v1/admin/reconciliation/statements/{id}/run
  • POST /v1/admin/regulatory/runs/{id}/receipt
  • POST /v1/admin/regulatory/runs/{id}/submit
  • POST /v1/admin/regulatory/templates/{id}/run
  • POST /v1/admin/remittances/{id}/paid
  • POST /v1/admin/remittances/{id}/pay
  • POST /v1/admin/supply-connectors/{name}/reconcile
  • POST /v1/psp-settlements
  • POST /v1/reconciliation/exceptions/{id}/actions
  • POST /v1/reconciliation/exceptions/{id}/assign
  • POST /v1/reconciliation/exceptions/{id}/comments
  • POST /v1/reconciliation/matches
  • POST /v1/statements
  • POST /v1/statements/{id}/match
  • POST /v1/statements/{id}/reparse
settlements:read Read settlement batches and statements.
3 operation(s)
  • GET /v1/settlements
  • GET /v1/settlements/{id}
  • GET /v1/settlements/{id}/report
transactions:read Read a transaction's timeline, stages and reversals.
9 operation(s)
  • GET /v1/cash-deposits
  • GET /v1/cash-deposits/intents
  • GET /v1/cash-deposits/intents/{id}
  • GET /v1/cash-deposits/{id}
  • GET /v1/psp/transactions
  • GET /v1/psp/transactions/{id}
  • GET /v1/transactions/{id}/reversals
  • GET /v1/transactions/{id}/stages
  • GET /v1/transactions/{id}/timeline
transactions:write Reverse transactions.
7 operation(s)
  • POST /v1/cash-deposits
  • POST /v1/cash-deposits/intents
  • POST /v1/cash-deposits/intents/{id}/confirm
  • POST /v1/name-lookups (or payouts:write)
  • POST /v1/name-lookups/{lookup_id}/select (or payouts:write)
  • POST /v1/psp/transactions
  • POST /v1/transactions/{id}/reversals
webhooks:manage Manage webhook endpoints and replay deliveries.
15 operation(s)
  • GET /v1/event-types (or events:read)
  • GET /v1/webhook-endpoints (or admin:read)
  • POST /v1/webhook-endpoints
  • DELETE /v1/webhook-endpoints/{id}
  • GET /v1/webhook-endpoints/{id} (or admin:read)
  • PATCH /v1/webhook-endpoints/{id}
  • PUT /v1/webhook-endpoints/{id}/contacts
  • GET /v1/webhook-endpoints/{id}/deliveries (or admin:read)
  • POST /v1/webhook-endpoints/{id}/enable
  • POST /v1/webhook-endpoints/{id}/pause
  • POST /v1/webhook-endpoints/{id}/roll-secret
  • PUT /v1/webhook-endpoints/{id}/schema-versions
  • PUT /v1/webhook-endpoints/{id}/signing
  • POST /v1/webhook-endpoints/{id}/test
  • GET /v1/webhook-schema-versions (or admin:read)
webhooks:replay Replay webhook deliveries.
3 operation(s)
  • POST /v1/admin/webhooks/verify
  • POST /v1/webhook-deliveries/{id}/replay
  • POST /v1/webhook-endpoints/{id}/replay

Endpoints

Partners 4

Bill payments 78

Charges 4

Refunds 1

Payouts 13

Disputes 7

Payments 10

Manual evidence 1

Admin 25

Audit 11

Reconciliation 45

Ledger 29

Events 19

Event pipeline 8

PSP onboarding 69

Reference 8

Compliance 6

Files 5

Diagnostics 1

Methods 1

Transactions 1

Connectors 3

Authentication 4

Risk 7

Routing 6

Webhooks 2