Get Payments

post
Get Payments

https://api.payant.ng/payments
Request
Response
Headers
Authorization
required
string
Your Payant secret key prefixed with "Bearer "
Query Parameters
start
optional
string
Start Date DD/MM/YYYY
end
optional
string
End Date DD/MM/YYYY
offset
optional
string
Current Page. Defaults to 0
limit
optional
string
Records to return count 1 - 50
method
optional
string
Channel of payment received Card, Bank, USSD, mCash, QR
client_id
optional
string
Client ID
200: OK
{
"status": "success",
"data": {
"period": "custom",
"start": "01/12/2016",
"end": "31/12/2016",
"payments": [
{
"company_id": "1",
"client_id": "1",
"invoice_id": "1",
"expense_id": "",
"amount": "50000.00",
"currency": "NGN",
"transaction_date": "1482105600",
"status": "success",
"reference_code": "j9CbiTN0oJe4vWhglyS2",
"payment_id": "",
"referrer": "",
"gateway_response": "",
"message": "",
"channel": "Cash",
"type": "Invoice",
"created_at": "2016-12-21 18:46:30",
"updated_at": "2016-12-21 18:46:30",
"id": 1,
invoice: {
"id": 1,
"company_id": "1",
"client_id": "1",
"reference_code": "j9CbiTN0oJe4vWhglyS2",
"payment_id": null,
"fee_bearer": "client",
"mail_status": "unsent",
"status": "0",
"due_date": "1483056000",
"created_at": "2016-12-21 18:46:30",
"updated_at": "2016-12-21 18:46:30",
"deleted_at": null,
"items": [
{
"id": "1",
"company_id": "1",
"client_id": "1",
"name": "Website Design",
"description": "5 Pages Website plus 1 Year Web Hosting",
"quantity": "1",
"unit_cost": "50000.00",
"status": "0",
"due_date": "1483056000",
"created_at": "2016-12-21 17:19:10",
"updated_at": "2016-12-21 17:19:10",
"deleted_at": null
}
]
},
"client": {
"id": 1
"company_id": 1,
"name": "Albert Specialist Hospital",
"first_name": "Albert",
"last_name": "Jane",
"email": "jane@alberthospital.com",
"phone": "+2348012345678",
"website": "http://www.alberthospital.com",
"address": "Wase II",
"type": "Customer",
"settlement_bank": "",
"account_name": "",
"account_number": "",
"status": "1",
"created_at": "2016-12-21 17:19:10",
"updated_at": "2016-12-21 17:19:10",
"deleted_at": null
}
}
]
}
}

Request

curl https://api.payant.ng/payments \
-H "Content-Type: application/json" \
-H "Authorization: Bearer SECRET_KEY" \
-X POST

Response

{
"status": "success",
"data": {
"period": "custom",
"start": "01/12/2016",
"end": "31/12/2016",
"payments": [
{
"company_id": "1",
"client_id": "1",
"invoice_id": "1",
"expense_id": "",
"amount": "50000.00",
"currency": "NGN",
"transaction_date": "1482105600",
"status": "success",
"reference_code": "j9CbiTN0oJe4vWhglyS2",
"payment_id": "",
"referrer": "",
"gateway_response": "",
"message": "",
"channel": "Cash",
"type": "Invoice",
"created_at": "2016-12-21 18:46:30",
"updated_at": "2016-12-21 18:46:30",
"id": 1,
invoice: {
"id": 1,
"company_id": "1",
"client_id": "1",
"reference_code": "j9CbiTN0oJe4vWhglyS2",
"payment_id": null,
"fee_bearer": "client",
"mail_status": "unsent",
"status": "0",
"due_date": "1483056000",
"created_at": "2016-12-21 18:46:30",
"updated_at": "2016-12-21 18:46:30",
"deleted_at": null,
"items": [
{
"id": "1",
"company_id": "1",
"client_id": "1",
"name": "Website Design",
"description": "5 Pages Website plus 1 Year Web Hosting",
"quantity": "1",
"unit_cost": "50000.00",
"status": "0",
"due_date": "1483056000",
"created_at": "2016-12-21 17:19:10",
"updated_at": "2016-12-21 17:19:10",
"deleted_at": null
}
]
},
"client": {
"id": 1
"company_id": 1,
"name": "Albert Specialist Hospital",
"first_name": "Albert",
"last_name": "Jane",
"email": "jane@alberthospital.com",
"phone": "+2348012345678",
"website": "http://www.alberthospital.com",
"address": "Wase II",
"type": "Customer",
"settlement_bank": "",
"account_name": "",
"account_number": "",
"status": "1",
"created_at": "2016-12-21 17:19:10",
"updated_at": "2016-12-21 17:19:10",
"deleted_at": null
}
}
]
}
}