BluebulbAPI
    API reference/Payments received
    GET

    Get a payment

    Rolling out
    GET{baseUrl}/api/payins/{id}

    Returns one payment into a sub-wallet.

    This endpoint is part of an API release that is still rolling out. Fields and endpoints marked Rolling out may not be available on your account yet.

    Authentication

    Send your API key and a request signature on every call. Requests must also come from an IP address on your allowlist — see Authentication.

    Headers

    x-api-key
    required
    string
    Your API key, <appId>.<secret>. See Authentication.
    X-Signature
    required
    string
    Base64 RSA-SHA256 signature of the request. See Request signing.
    X-Signature-Timestamp
    required
    string
    Unix time in milliseconds used in the signature. Must be within 5 minutes of Orbita's clock.

    Path parameters

    id
    required
    string (uuid)
    The payment ID.

    Response

    data is a payment. Every response is wrapped in the standard envelope.

    id
    string (uuid)
    Payment ID.
    virtualAccountId
    string (uuid)
    ID of the sub-wallet that was paid into.
    amount
    number
    Amount received.
    currency
    string
    Always ngn.
    payerName
    string | null
    Name on the account that paid, when the bank provides it.
    payerAccountNumber
    string | null
    Account number that paid, when the bank provides it.
    payerBankName
    string | null
    Bank that paid from, when the bank provides it.
    providerReference
    string
    The bank's reference for the payment. Unique per payment, and the same value as reference in the funding webhook.
    status
    string
    completed once the amount has been credited to your NGN balance; pending while it's being credited; failed if it couldn't be.
    resultingWalletBalance
    number | null
    Your NGN balance straight after this payment was credited.
    createdAt
    string (datetime)
    When the payment arrived.

    Errors

    Errors specific to this endpoint:

    404
    Payment record not found
    No payment with this ID belongs to your business.

    Plus the errors every endpoint can return — authentication, signing, rate limiting and server errors. See Responses & errors.