The
/payment/
endpoint allows creation of payment records with transaction details, currency information, and associated files.
Method:POST
Request Payload:
Parameter | Type | Description |
---|---|---|
user | string | User ID associated with the payment |
title | string | Title/description of the payment |
transactionDate | string | Date and time of the transaction |
currency | string | Currency code (e.g., USD, NGN) |
amount | number | Amount in the specified currency |
amountUSD | number | Amount converted to USD |
conversionRate | number | Exchange rate used for conversion |
memo | string | Additional notes about the payment |
files | array | Array of file names associated with the payment |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Request Body
Example Request
Request Schema
Field | Type | Required | Description |
---|---|---|---|
user | string | ✅ | User ID associated with the payment |
title | string | ✅ | Title/description of the payment |
transactionDate | string | ✅ | Date and time of the transaction |
currency | string | ✅ | Currency code (e.g., USD, NGN) |
amount | number | ✅ | Amount in the specified currency |
amountUSD | number | ✅ | Amount converted to USD |
conversionRate | number | ❌ | Exchange rate used for conversion |
memo | string | ❌ | Additional notes about the payment |
files | array | ❌ | Array of file names associated with the payment |
Responses
✅ 201 - Success
⚠️ 400 - Bad Request
⚠️ 401 - Unauthorized
❌ 500 - Internal Server Error
Tags
Payment
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
User ID associated with the payment
Title/description of the payment
Date and time of the transaction
Currency code (e.g., USD, NGN)
Amount in the specified currency
Amount converted to USD
Exchange rate used for conversion
Additional notes about the payment
Array of file names associated with the payment