Flashpay API
  1. Payments
Flashpay API
  • Quick Start
    • Overview
    • Configuring the Server
    • Integrating Flashpay in Your Frontend 
  • Payments
    • New payment request
      POST
    • List payments
      GET
    • Payment details
      GET
  • Beneficiaries
    • Eligible beneficiaries list
      GET
  • Payouts
    • New payout request
      POST
    • Payout details
      GET
  1. Payments

Payment details

GET
/api/v1/payment/{id}
TRANSACTION_V1_SERVICE
Returns the full details of an existing payment that you've created througn the POST /payments endpoint. Simply supply the id of the payment we returned when the payment was created.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required

Request 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 GET 'https://example.com/api/v1/payment/'

Responses

🟢200Success
application/json
Body
id
string 
required
amount
integer 
required
ownerId
string 
required
currency
string 
required
reference
string 
required
originBankId
string  | null 
required
originAccount
string  | null 
required
originAccountName
string  | null 
required
destinationBankId
string 
required
destinationAccount
string 
required
destinationAccountName
string 
required
description
string 
required
status
string 
required
callbackUrl
string 
required
statusWebhook
string  | null 
required
createdAt
string 
required
updatedAt
string  | null 
required
expiresAt
string  | null 
required
Example
{
  "id": "szokiqnitlsqbi1g1fp9vhwo",
  "amount": 1080000,
  "ownerId": "k235v1ujhhnpwv0zmyk4by6t",
  "currency": "NGN",
  "reference": "somerandomreferenceforwatch2",
  "originBankId": null,
  "originAccount": null,
  "originAccountName": null,
  "destinationBankId": "dqv8ldz5mk4eu7ykcvrr8g84",
  "destinationAccount": "1234ABCXXX",
  "destinationAccountName": "Alphabets Inc",
  "description": "Watch purchase",
  "status": "OPEN",
  "callbackUrl": "https://pay.flashpayweb.com",
  "statusWebhook": null,
  "createdAt": "2024-06-24T16:09:59.085Z",
  "updatedAt": null,
  "expiresAt": null
}
Previous
List payments
Next
Eligible beneficiaries list
Built with