OhentPay
API Reference

Payment Requests

Payment requests operations

Fetch list of payment requests

GET
/paymentrequests

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

reference_id?string

Fetch by reference_id

currency?string

Filter by currency code

settlement_balance_id?string

Filter by settlement_balance_id

Formatuuid
status?string

Filter by status

Value in"initiated" | "processed" | "failed" | "cancelled"

Response Body

curl -X GET "https://api.ohentpay.com/paymentrequests?reference_id=9b0682dc3a6611e9a490b56deb33d08b&currency=NGN&settlement_balance_id=88fe6e8a-bd3b-11e9-821e-4180c1a9232a&status=active"
[
  {
    "id": "88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
    "market": "GB",
    "currency": "GBP",
    "amount": 100,
    "settlement_balance_id": "88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
    "reference_id": "88fe6e8acd7b11e9821e4180c1a9232a",
    "reference": "For invoice",
    "status": "initiated",
    "payment_url": "https://pay.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
    "qr_code_url": "https://pay.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a/qrcode",
    "return_url": "https://www.example.com/return_url",
    "created": "2019-09-02T13:16:47+01:00"
  }
]

Create new payment request

POST
/paymentrequests

Authorization

AuthorizationBearer <token>

In: header

Request Body

currency?string
amount?integer
settlement_balance_id?string
Formatuuid
reference_id?string

Unique reference ID to prevent duplicates

Rangevalue <= 50
reference?string
return_url?string

Response Body

curl -X POST "https://api.ohentpay.com/paymentrequests" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "id": "88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
  "market": "GB",
  "currency": "GBP",
  "amount": 100,
  "settlement_balance_id": "88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
  "reference_id": "88fe6e8acd7b11e9821e4180c1a9232a",
  "reference": "For invoice",
  "status": "initiated",
  "payment_url": "https://pay.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
  "qr_code_url": "https://pay.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a/qrcode",
  "return_url": "https://www.example.com/return_url",
  "created": "2019-09-02T13:16:47+01:00"
}
{
  "request": "error",
  "code": 400,
  "message": "Invalid request"
}

Fetch single payment request

GET
/paymentrequests/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Payment Request ID

Formatuuid

Response Body

curl -X GET "https://api.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a"
{
  "id": "88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
  "market": "GB",
  "currency": "GBP",
  "amount": 100,
  "settlement_balance_id": "88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
  "reference_id": "88fe6e8acd7b11e9821e4180c1a9232a",
  "reference": "For invoice",
  "status": "initiated",
  "payment_url": "https://pay.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a",
  "qr_code_url": "https://pay.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a/qrcode",
  "return_url": "https://www.example.com/return_url",
  "created": "2019-09-02T13:16:47+01:00"
}
Empty

Cancel a payment request

DELETE
/paymentrequests/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

Payment request ID

Formatuuid

Response Body

curl -X DELETE "https://api.ohentpay.com/paymentrequests/88fe6e8a-cd7b-11e9-821e-4180c1a9232a"
{
  "result": "ok"
}
{
  "request": "error",
  "code": 400,
  "message": "Invalid request"
}

Next

Virtual Accounts

Next

Webhooks