Flashpay API
  1. Payments
Flashpay API
  • Quick Start
    • Overview
    • Configuring the Server
    • Integrating Flashpay in Your Frontend 
  • Payments
    • New payment intent
      POST
    • List payments by merchant id
      GET
    • Payment details by payment ID
      GET
    • Payment details by destination account
      GET
  1. Payments

New payment intent

POST
/api/v1/payment
The first step is to submit the details of the payment you'd like to initiate. We'll validate that all the required data is supplied.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json

Example
{
    "amount": 9980000,
    "currency": "NGN",
    "description": "Watch purchase",
    "reference": "somerandomreferenceforwatch",
    "expiresAt": null
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://example.com/api/v1/payment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 9980000,
    "currency": "NGN",
    "description": "Watch purchase",
    "reference": "somerandomreferenceforwatch",
    "expiresAt": null
}'

Responses

🟢201Success
application/json
Body

Example
{
    "id": "string",
    "amount": 0,
    "ownerId": "string",
    "currency": "string",
    "reference": "string",
    "originBankId": null,
    "originAccount": null,
    "originAccountName": null,
    "destinationBankId": "string",
    "destinationAccount": "string",
    "destinationAccountName": "string",
    "description": "string",
    "status": "string",
    "callbackUrl": "string",
    "statusWebhook": "string",
    "idempotencyKey": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "expiresAt": "string"
}
Modified at 2025-07-28 18:01:54
Previous
Integrating Flashpay in Your Frontend 
Next
List payments by merchant id
Built with