Skip to main content
GET
/
invoices
/
{invoiceId}
/
payment-status
Get invoice payment status
curl --request GET \
  --url https://connect.withvayu.com/invoices/{invoiceId}/payment-status \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://connect.withvayu.com/invoices/{invoiceId}/payment-status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.withvayu.com/invoices/{invoiceId}/payment-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://connect.withvayu.com/invoices/{invoiceId}/payment-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://connect.withvayu.com/invoices/{invoiceId}/payment-status"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://connect.withvayu.com/invoices/{invoiceId}/payment-status")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://connect.withvayu.com/invoices/{invoiceId}/payment-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "invoiceId": "<string>",
  "amountDue": 123,
  "amountPaid": 123,
  "total": 123,
  "dueDate": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "invoicePdfUrl": "<string>"
}
{
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"params": [
{
"param": "<string>",
"message": "<string>"
}
]
}
{
"type": "authentication_error",
"code": "authentication_failed",
"message": "<string>"
}
{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "<string>"
}
{
"type": "api_error",
"code": "internal_error",
"message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoiceId
string
required
Pattern: ^[0-9a-fA-F]{24}$

Response

Invoice payment status information including payment status, amounts, and dates.

invoiceId
string
required
Pattern: ^[0-9a-fA-F]{24}$
billingStatus
enum<string>
required

The billing status of the invoice

Available options:
None,
Paid,
Rejected,
PendingPayment,
Overdue
amountDue
number
required
amountPaid
number
required
total
number
required
dueDate
string<date-time>
paidAt
string<date-time>
invoicePdfUrl
string