Claim invoice

The claim invoice feature allows for a user to accept an invoice from a party. Users of the API can use this functionality as part of an existing invoicing capability for a different provider.

Pay an invoice to a business

POST https://sandbox-api.veem.com/veem/v1.2/invoices/claim

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

Request payload

{
    "invoiceId": 455711,
    "fundingMethod": {
        "id": 4559,
        "type": "Bank"
    }
}

invoiceId: the invoice you want to claim

fundingMethod: the funding method object you want to use for paying the invoice (id and type)

Response payload

{
    "requestId": "29552b04-6247-4928-beaf-89f6b7391285",
    "notes": "Invoice test",
    "payee": {
        "email": "angel.solorzanosanchez+payee8f2db742-44a1-4ac8-a3b2-a44fa803c2d6@veem.com",
        "countryCode": "NG",
        "phone": "tel:+234-808-232-4446"
    },
    "payeeAmount": {
        "number": 50.00,
        "currency": "USD"
    },
    "status": "Claimed",
    "goodFundsPayment": false,
    "realTimePayment": false,
    "id": 462165,
    "invoiceId": 455711,
    "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-18T12:03:24.243-08:00",
    "timeUpdated": "2025-02-18T12:03:24.903-08:00",
    "debitCreditTxn": {
        "debitTxn": null,
        "creditTxn": null,
        "refundTxn": null
    },
    "fastTransfer": false,
    "cancelable": true,
    "payerFundingMethodType": "Bank",
    "receiverFundingMethodType": "Wallet"
}