Get Payment Status

Once money is sent, users can retrieve the payment to check on its status using the id field that is included in the response. The schema of the createPayment and getPayment responses are exactly the same. For Example:

GET https://sandbox-api.veem.com/veem/v1.2/payments/{paymentId}

Headers

• X-request-id: For example 48855846-628d-4177-b071-80332a116f0a
• Authorization: Bearer bearerToken

bearerToken is the Authorization token that belongs to the account created

i.e. Bearer d49e7fd4-2600-4dd4-a572-118668febbe7

see this section to generate your bearerToken

{
    "requestId": "09dc3f97-9013-4f7e-82ac-2ffb15db8c46",
    "notes": "Invoice test",
    "payee": {
        "email": "angel.solorzanosanchez+payeeaae6b3ca-845c-400d-8d1d-8b5955c87a44@veem.com",
        "countryCode": "NG",
        "phone": "tel:+234-808-232-4446"
    },
    "payeeAmount": {
        "number": 50.00,
        "currency": "USD"
    },
    "status": "Authorized",
    "goodFundsPayment": false,
    "realTimePayment": false,
    "sweepToWalletId": 2053,
    "extraInfo": {
        "customInfo": null
    },
    "id": 462454,
    "invoiceId": 455741,
    "exchangeRate": {
        "fromAmount": 50.00,
        "fromCurrency": "USD",
        "toAmount": 50.00,
        "toCurrency": "USD"
    },
    "feeInformation": {
        "payerInfo": {
            "originalAmount": 50.00,
            "feeAmount": 0.00,
            "totalAmount": 50.00,
            "currency": "USD"
        },
        "payeeInfo": {
            "originalAmount": 50.00,
            "feeAmount": 0.00,
            "totalAmount": 50.00,
            "currency": "USD"
        }
    },
    "timeCreated": "2025-02-28T10:52:15.209-08:00",
    "timeUpdated": "2025-02-28T10:53:04.878-08:00",
    "debitCreditTxn": {
        "debitTxn": {
            "id": 7436935,
            "type": "Debit",
            "status": "Initiated",
            "reversalError": null,
            "error": null
        },
        "creditTxn": {
            "id": 7436936,
            "type": "Credit",
            "status": "Pending",
            "reversalError": null,
            "error": null
        },
        "refundTxn": null
    },
    "fastTransfer": false,
    "cancelable": false,
    "payerFundingMethodType": "Wallet",
    "receiverFundingMethodType": "Wallet"
}

A payment's status will update a few times until it's completed. We recommend that you check on the status of a payment every 30 min after it's created.

The following table describes the various payment status values:

Debit/Credit Transaction Workflow

The debitCreditTxn object provides details about the debit and credit transactions associated with the payment. Here’s how the workflow operates

1. Debit Transaction
   • The debitTxn object represents the debit transaction initiated from the payer's account.
   • Possible statuses: Pending, Ready, OnHold, FeeCharged, Initiated, Rejected, Completed, Applied, Closed, RecallPending, RecallCompleted, Reversed.
   • If a reversal is attempted and fails, the reversalError field will contain details.
2. Credit Transaction
   • The creditTxn object represents the credit transaction to the payee's account.
   • Possible statuses: Pending, Ready, OnHold, FeeCharged, Initiated, Rejected, Completed, Applied, Closed, RecallPending, RecallCompleted, Reversed.
   • If a reversal is attempted and fails, the reversalError field will contain details.
3. Reversal workflow
   • If a payment needs to be reversed, the system will attempt to reverse both the debit and credit transactions.
   • The status will transition to RecallPending while the reversal is being processed and RecallCompleted once the reversal is successful.
   • Errors during reversal will be captured in the reversalError field for the respective transaction.

The following table describes the various transaction status values: