Initiating Checkout

Start a checkout session with POST /v1/checkout. This creates a hosted payment page and returns a checkout id and url.

Example request

curl --location 'https://sandbox.api.platnova.co/v1/checkout' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_JWT_TOKEN' \
  --data-raw '{
    "email": "[email protected]",
    "amount": 2000.15,
    "currency": "ngn",
    "payment_options": [
      {
        "id": "defi"
      }
    ]
  }'

Request fields

email: Customer email for the checkout.
amount: Amount to collect.
currency: Currency code (for example ngn).
payment_options: Optional. The ways the payer may pay. Leave it out to offer every method that is live for the currency — that is the recommended default, and new methods reach your payers as we switch them on. Send it only to restrict the checkout to specific methods. Supported id values:

`id`	What the payer does	Currencies
`tag_transfer`	Pays from their Platnova wallet by scanning a QR code	all
`bank_transfer`	Transfers to a one-time account number	NGN
`card`	Enters their card on a secure page	NGN, USD, EUR, GBP, CAD
`apple_pay`	One tap on an iPhone, iPad or Mac	USD, EUR, GBP, CAD (NGN soon)
`google_pay`	One tap in Chrome or on Android	USD, EUR, GBP, CAD (NGN soon)
`opay`	Approves the payment in their OPay app	NGN
`bank_account`	Picks their bank and approves in that bank’s own app or online banking	NGN
`ussd`	Dials a code from any phone, no internet banking needed	NGN
`mobile_money`	Approves a prompt on their phone, paying from a Ghanaian, Kenyan, Ugandan, Rwandan or Tanzanian wallet in that currency at Platnova’s rate	all
`crypto`	Pays in crypto	all

A method that is not live for the checkout’s currency is left off the page even if you list it. Mobile money is cross-currency: the payer sees what they will pay in their own currency, you are settled the checkout amount in yours, and the conversion is Platnova’s, not yours. novatag and defi are accepted as older spellings of tag_transfer and crypto.

Payment option values

To restrict a checkout, list the methods you want:

[
  { "id": "bank_transfer" },
  { "id": "ussd" },
  { "id": "opay" },
  { "id": "card" }
]

To offer everything, omit payment_options from the request.

Example response

{
  "status": true,
  "data": {
    "amount": 2000.15,
    "currency": "ngn",
    "id": "3e584f08-6a55-4b15-a97f-364a7d21071e",
    "email": "[email protected]",
    "url": "https://pay.platnova.com/3e584f08-6a55-4b15-a97f-364a7d21071e",
    "status": "pending",
    "success_url": "https://platnova.com/process?status=successful",
    "cancel_url": "https://platnova.com/process?status=cancelled",
    "source": "platform",
    "entity": {
      "category": "Technology",
      "country_code": "NG",
      "created_at": "2025-09-14T20:00:41.114031Z",
      "description": "A leading technology solutions provider g",
      "dial_code": "+234",
      "id": "67fa2a59-5d73-4f9c-be49-2a3a8c391cde",
      "legal_name": "Techies 2 Ltd",
      "name": "Techies 2 Ltd",
      "phone": "8012345678",
      "status": "ACTIVE",
      "username": "techies2ltd"
    },
    "payment_options": [
      {
        "id": "defi"
      }
    ],
    "created_at": "2026-05-05T15:57:19Z"
  },
  "error": [],
  "message": "operation was successful"
}

Use data.url to redirect your customer to complete payment. Keep data.id so you can retrieve this checkout later with the get endpoint.

Get Started

Customers

Cards

Virtual Accounts

Payments

Payment Links

Checkout

Invoices

Transactions

Wallets

Webhooks

Example request

Request fields

Payment option values

Example response

​Example request

​Request fields

​Payment option values

​Example response

Example request

Request fields

Payment option values

Example response