API reference

Every endpoint a merchant integration can call, grouped by what it does. Each page explains the endpoint, how it authenticates, every field with its type, whether it is required and the values it accepts, an example request, and what comes back.

Charges

Take a payment from a customer by mobile money, bank or card.

• POST /v1/charges: Create a charge
• GET /v1/charges/{id}: Retrieve a charge
• POST /v1/charges/{id}/otp: Submit a charge’s one-time code
• POST /v1/charges/{id}/otp/resend: Re-send a charge’s one-time code

Payment sessions

Fix an amount on your server, then let your checkout page collect it.

• POST /v1/payment_sessions: Create a payment session
• GET /v1/payment_sessions/{id}: Retrieve a payment session
• POST /v1/payment_sessions/{id}/cancel: Cancel a payment session

Checkout

The browser half of a payment session: what a checkout page calls.

• GET /v1/checkout/sessions/{id}: Retrieve a checkout session
• POST /v1/checkout/sessions/{id}/confirm: Confirm a checkout session
• POST /v1/checkout/sessions/{id}/otp: Submit a customer’s one-time code
• POST /v1/checkout/sessions/{id}/otp/resend: Send the customer a new one-time code

Payouts

Send money from your balance to a mobile-money number or bank account, and check who holds an account first.

• POST /v1/name-enquiries: Look up who holds an account
• POST /v1/payouts: Create a payout
• GET /v1/payouts/{id}: Retrieve a payout

Refunds

Return all or part of a payment to the customer.

• POST /v1/refunds: Create a refund
• GET /v1/refunds: List a charge’s refunds
• GET /v1/refunds/{id}: Retrieve a refund

Fees

What a charge or payout would cost, before you create it.

• POST /v1/fees/quote: Quote the fees on a charge or payout

Transactions

Read any payment, payout or refund, and list them.

• GET /v1/transactions: List transactions
• GET /v1/transactions/{id}: Retrieve a transaction

Balances

What you hold, what you can withdraw, and what is still pending.

• GET /v1/balances: Retrieve balances

Settlements

The batches in which your collected money is paid out to you.

• GET /v1/settlements: List settlements
• GET /v1/settlements/{id}: Retrieve a settlement
• GET /v1/settlements/{id}/items: List a settlement’s lines
• GET /v1/withdrawals: List withdrawals

Webhooks

Endpoints PaySigna sends signed events to, and what was delivered.

• GET /v1/webhook-deliveries: List webhook deliveries
• GET /v1/webhook-deliveries/{id}: Retrieve a webhook delivery
• GET /v1/webhook-deliveries/{id}/attempts: List a delivery’s attempts
• POST /v1/webhook-deliveries/{id}/replay: Replay a webhook delivery
• POST /v1/webhook-endpoints: Create a webhook endpoint
• GET /v1/webhook-endpoints: List webhook endpoints
• GET /v1/webhook-endpoints/{id}: Retrieve a webhook endpoint
• PATCH /v1/webhook-endpoints/{id}: Update a webhook endpoint
• DELETE /v1/webhook-endpoints/{id}: Delete a webhook endpoint
• POST /v1/webhook-endpoints/{id}/rotate-secret: Rotate a webhook signing secret

Events

The event log behind webhooks, readable directly.

• GET /v1/event-types: List event types
• GET /v1/events: List events
• GET /v1/events/{id}: Retrieve an event

Billing

Products, plans, subscriptions, invoices, coupons and credit.

• POST /v1/coupons: Create a coupon
• GET /v1/coupons: List coupons
• POST /v1/coupons/{id}: Activate or deactivate a coupon
• GET /v1/coupons/{id}: Retrieve a coupon
• POST /v1/credit_notes: Issue a credit note
• GET /v1/credit_notes: List credit notes
• POST /v1/customers/{id}/credit: Give a customer credit
• GET /v1/customers/{id}/credit: Retrieve a customer’s credit
• POST /v1/invoices: Issue a one-off invoice
• GET /v1/invoices: List invoices
• GET /v1/invoices/{id}: Retrieve an invoice
• POST /v1/invoices/{id}/void: Void an invoice
• POST /v1/plans: Create a plan
• GET /v1/plans: List plans
• POST /v1/plans/{id}: Activate or deactivate a plan
• GET /v1/plans/{id}: Retrieve a plan
• POST /v1/products: Create a product
• GET /v1/products: List products
• POST /v1/products/{id}: Update a product
• GET /v1/products/{id}: Retrieve a product
• POST /v1/subscriptions: Create a subscription
• GET /v1/subscriptions: List subscriptions
• GET /v1/subscriptions/{id}: Retrieve a subscription
• POST /v1/subscriptions/{id}/cancel: Cancel a subscription
• POST /v1/subscriptions/{id}/discount: Apply a coupon to a subscription
• DELETE /v1/subscriptions/{id}/discount: Remove a subscription’s discount
• POST /v1/subscriptions/{id}/pause: Pause a subscription
• POST /v1/subscriptions/{id}/resume: Resume a subscription

Analytics

Totals over time.

• GET /v1/analytics/summary: Retrieve an analytics summary
• GET /v1/analytics/time-series: Retrieve an analytics time series

Reference

Banks, networks, countries and currencies: the codes other endpoints accept.

• GET /v1/reference/banks: List banks
• GET /v1/reference/countries: List supported countries
• GET /v1/reference/currencies: List supported currencies
• GET /v1/reference/momo-networks: List mobile-money networks

Payment links

• POST /v1/payment-links: Create a payment link
• GET /v1/payment-links: List payment links
• GET /v1/payment-links/{id}: Retrieve a payment link
• GET /v1/payment-links/{id}/payments: Payments made through a link
• POST /v1/payment-links/{id}/status: Pause, resume or archive a payment link