Get payment status Query the current status of a card transaction directly from the payment processor. This endpoint also updates the local transaction record if the processor reports a completed status.
GET /api/v1/card-payments/status
Authentication x-api-key: your_api_key x-api-secret: your_api_secret
Query parameters The transaction reference you supplied when initiating the payment.
The transaction amount in naira (the same value you submitted at initiation). For example, "5000" for ₦5,000.
Example request curl --request GET \ --url 'https://api.hyparrow.com/api/v1/card-payments/status?transactionRef=TXN-20240401-001&amount=5000' \ --header 'x-api-key: your_api_key' \ --header 'x-api-secret: your_api_secret'
Example response { "success" : true , "message" : "Transaction status retrieved" , "data" : { "ResponseCode" : "00" , "ResponseDescription" : "Approved by Financial Institution" , "Amount" : "500000" , "TransactionDate" : "2024-04-23T10:30:00Z" } }
Response fields true when the status query was processed successfully.
Processor response code. "00" means the transaction was approved and complete.
Human-readable description of the transaction status from the processor.
Transaction amount in kobo as returned by the processor.
ISO 8601 timestamp of when the transaction was processed.
List card transactions Returns all card payment transactions associated with your API key client account, ordered by most recent first.
GET /api/v1/card-payments/transactions
Authentication x-api-key: your_api_key x-api-secret: your_api_secret
Example request curl --request GET \ --url https://api.hyparrow.com/api/v1/card-payments/transactions \ --header 'x-api-key: your_api_key' \ --header 'x-api-secret: your_api_secret'
Example response { "success" : true , "message" : "Retrieved 2 transactions" , "data" : [ { "id" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" , "clientId" : "7e9a1b2c-3d4e-5f60-a7b8-c9d0e1f2a3b4" , "type" : "card_payment" , "status" : "completed" , "amount" : 500000 , "currency" : "NGN" , "reference" : "TXN-20240401-001" , "provider" : "interswitch" , "channel" : "card" , "responseCode" : "00" , "responseMessage" : "Approved by Financial Institution" , "completedAt" : "2024-04-23T10:30:00Z" , "createdAt" : "2024-04-23T10:29:45Z" , "updatedAt" : "2024-04-23T10:30:00Z" }, { "id" : "1c2d3e4f-5a6b-7c8d-9e0f-1a2b3c4d5e6f" , "clientId" : "7e9a1b2c-3d4e-5f60-a7b8-c9d0e1f2a3b4" , "type" : "card_payment" , "status" : "failed" , "amount" : 200000 , "currency" : "NGN" , "reference" : "TXN-20240401-002" , "provider" : "interswitch" , "channel" : "card" , "responseCode" : "51" , "responseMessage" : "Insufficient funds" , "createdAt" : "2024-04-23T09:15:00Z" , "updatedAt" : "2024-04-23T09:15:30Z" } ] }
Response fields true when the list was retrieved successfully.
Indicates how many transactions were returned.
Array of transaction objects. Show Transaction object fields
UUID of the API client that created the transaction.
Always "card_payment" for card transactions.
Transaction status: pending, processing, completed, failed, or canceled.
Transaction amount in kobo (multiply by 0.01 to get naira).
3-letter currency code, e.g. "NGN".
Your unique transaction reference.
Payment provider used to process the transaction.
Payment channel. Always "card" for card payments.
Final processor response code.
Final processor response message.
ISO 8601 timestamp of when the transaction completed. Present only for completed transactions.
ISO 8601 timestamp of when the transaction was created.
ISO 8601 timestamp of the last update.
