# Payments API

> API reference, version 1.0. Source: https://hub.ozow.com/api-reference/payments-api/

Payments API for Ozow that allows for payments, refunds, settlements, and more.

## Servers

- `https://api.ozow.com` - Production
- `https://stagingapi.ozow.com` - Staging

## Authentication

- `BearerToken` (http)
  - The token generated by the `Get API token` operation. The same token is used for every request until it expires.
- `ApiKey` (apiKey)
  - The unique API key for the merchant. See [Prerequisites and onboarding](../../getting-started/prerequisites-and-onboarding.md) for where to find it.

## Operations

### Payments

- `POST /postpaymentrequest` - Create Payment Request
- `GET /GetTransactionByReference` - Get Transaction By Reference
- `GET /GetTransaction` - Get Transaction
- `GET /GetTransactionReport` - Get Transaction Report

### Authorization

- `POST /token` - Get API token

### Refunds

- `POST /secure/refunds/submit` - Submit refund
- `GET /secure/refunds/getrefunds` - Get refunds
- `GET /secure/refunds/getrefund` - Get refund
- `GET /secure/refunds/getrefundsbytransactionid` - Get refunds by transaction ID

### Settlements

- `GET /secure/settlements` - Get Settlements
- `GET /secure/settlements/getsitesettlements` - Get Site Settlements

### Bulk payments

- `POST /secure/bulkpaymentrequests/create` - Create Bulk Payment Request
- `GET /secure/bulkpaymentrequests/getbulkjobbyreference` - Get Bulk Job Status

### Bank deposits

- `POST /secure/banktransfer/single` - Create Unique Reference
- `POST /secure/banktransfer/multiple` - Create Static Reference
- `GET /secure/banktransfer/bankingdetails` - Get Banking Details

## Webhooks

Sent by Ozow to your notification URL.

- Transaction notification
- Refund notification
- Bulk job result notification