Startbutton Product API
  • Startbutton API doc
    • Get Started
    • Accept Payments
    • Server-to-Server Integration
      • S2S Integration for Virtual Accounts
        • S2S Virtual account (NGN)
        • S2S Virtual account (GHS)
        • S2S EFT (ZAR)
      • S2S Integration for Mobile Money
        • S2S MoMo (KES and GHS)
        • S2S MoMo (TZS and UGX)
        • S2S MoMo (RWF)
        • S2S MoMo XOF and XAF
    • Re-charge Card
    • Subscriptions
    • Payment Links
    • Currency Conversion
    • Get Wallet Balance
    • Transfer
      • Bank List
    • Security Measures.
      • IP Whitelisting
    • Webhook
    • Transaction Status
    • Get FX Rate
    • Under and Overpayments
    • Refunds
      • Refund Transaction Status (TSQ)
    • Available Currencies
    • FAQs
  • Advanced Security
    • Signed Payload for Transfer Requests.
Powered by GitBook
On this page
  1. Startbutton API doc

Transaction Status

Alternative to listening to events by using a webhook URL, you can request/call for the transaction status. This requires making a GET request at regular intervals to get the final status of a request.

BaseUrls

PROD : https://api.startbutton.tech

DEV/ Staging: https://api-dev.startbutton.tech

GET - {{baseurl}}/transaction/status/:reference

Authorization
Set value to Bearer SECRET_KEY

Content-type

Set value to application/json

{
    "success": true,
    "message": "transaction fetched",
    "data": {
        "transaction": {
            "gatewayReference": null,
            "_id": "64f42c68ecfd2f6f1xxxxxxx",
            "transType": "transfer",
            "status": "pending",
            "feeAmount": 1500,
            "merchantId": "64459778bf350cc65xxxxxxx",
            "transactionReference": "1481fxxxxxxx",
            "userTransactionReference": "aedxxxx",
            "isRecurrent": false,
            "createdAt": "2023-09-03T06:49:12.509Z",
            "updatedAt": "2023-09-03T06:51:11.016Z",
            "amount": 100,
            "currency": "NGN",
            "recipient": {
                "recipientName": "John Doe",
                "currency": "NGN",
                "institutionType": "nuban",
                "institutionName": "Providus Bank",
                "institutionNumber": "54004xxxxx",
                "_id": "64f33cca80649e4fxxxxxxx"
            }
        },
        "authorizationCode": null
    }
}
{
    "success": true,
    "message": "transaction fetched",
    "data": {
        "transaction": {
            "_id": "64fb69a68a6f0187bxxxxxxx",
            "transType": "collection",
            "status": "successful",
            "merchantId": "64459778bf350cc65xxxxxxx",
            "transactionReference": "401f69xxxxxx",
            "userTransactionReference": "aedxxxx",
            "customerEmail": "test1@email.com",
            "paymentCode": "ugjhxxxxx",
            "isRecurrent": false,
            "postProcess": null,
            "gatewayReference": null,
            "createdAt": "2023-09-08T18:36:22.214Z",
            "updatedAt": "2023-09-08T18:59:00.375Z",
            "feeAmount": 12.5,
            "amount": 50000,
            "currency": "NGN"
        },
        "authorizationCode": null
    }
}
{
    "success": true,
    "message": "transaction fetched",
    "data": {
        "transaction": {
            "_id": "64fb69a68a6f0187bxxxxxxx",
            "transType": "collection",
            "status": "successful",
            "merchantId": "64459778bf350cc65xxxxxxx",
            "transactionReference": "401f69xxxxxx",
            "userTransactionReference": "aedxxxx",
            "customerEmail": "test1@email.com",
            "paymentCode": "ugjhvjhvv",
            "isRecurrent": false,
            "postProcess": null,
            "gatewayReference": null,
            "createdAt": "2023-09-08T18:36:22.214Z",
            "updatedAt": "2023-09-08T18:59:00.375Z",
            "feeAmount": 12.5,
            "amount": 50000,
            "currency": "NGN"
        },
        "authorizationCode": "5cb5047xxxxxxx"
    }

amount is in fractional unit

PreviousWebhookNextGet FX Rate

Last updated 2 months ago