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.1/payments/paymentId

Headers:

X-Request-Id:
Authorization: Bearer <access_token>

{
    "notes": "Delivery Bill",
    "payee": {
        "email": "[email protected]",
        "countryCode": "US",
        "phone": "tel:+1-613-998-7705"
    },
    "payeeAmount": {
        "number": 1001.4,
        "currency": "USD"
    },
    "status": "Sent",
    "id": 53656,
    "exchangeRate": {
        "fromAmount": 1001.4,
        "fromCurrency": "USD",
        "toAmount": 1001.4,
        "toCurrency": "USD"
    },
    "claimLink": "https://sandbox.veem.com/redirect?to=http%3A%2F%2Fsandbox-api.veem.com%2Fapi%2Fpayments%2Faccounts%2F6311%2Fpayment%2F53656%2Fredirect%3Fsecret%3Da1d36d1d-85ec-4b1c-8146-f3ba8005f2d4"
}

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:

Status

Description

Drafted

Payment is in drafted state and requires further updates.

Sent

The payment has been sent to the receiver/payee.

PendingAuth

The payment is in pending authorization by Veem.

Authorized

The payment has been authorized and is ready for processing. The money will be withdrawn from sender's bank.

InProgress

The payment has been initiated and receiver will be receiving money shortly.

Complete

The payment is complete and the receiver should have received the money.

Cancelled

The payment has been cancelled by the sender/payer.

Closed

The payment has been closed by Veem by request from the sender, or receiver, or due to an error with the payment.