Pazy Documentation

Vendor Payments API

curl --request GET \
  --url https://api.pazy.io/v1.0/vendor/:id/payments

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pazy.io/v1.0/vendor/:id/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.pazy.io/v1.0/vendor/:id/payments"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.pazy.io/v1.0/vendor/:id/payments")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Vendor Payments API

curl --request GET \
  --url https://api.pazy.io/v1.0/vendor/:id/payments

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pazy.io/v1.0/vendor/:id/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.pazy.io/v1.0/vendor/:id/payments"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.pazy.io/v1.0/vendor/:id/payments")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Authentication

All requests require an API key in the request headers. Headers:

Authorization: Api-Key YOUR_API_KEY

Request

Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
`id`	string	Yes	The unique identifier of the Vendor to retrieve

Query Parameters

Parameter	Type	Required	Description
`fields`	string	Yes	CSV string of extra field you want to get

Code Examples

curl -X GET https://api.pazy.io/v1.0/vendor/vendor_identifier/payments?fields=accountNumber \
  -H "Authorization: Api-Key YOUR_API_KEY"

const response = await fetch(
  "https://api.pazy.io/v1.0/vendor/vendor_identifier/payments?fields=accountNumber",
  {
    method: "GET",
    headers: {
      Authorization: "Api-Key YOUR_API_KEY",
    },
  },
);

const result = await response.json();

import requests

url = "https://api.pazy.io/v1.0/vendor/vendor_identifier/payments?fields=accountNumber"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}

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

Success Response

HTTP Status: 200 OK Response Fields:

Field	Type	Description
`ok`	boolean	Indicates whether the request was successful
`data`	object	Contains the vendor payments response data
`data.vendorPayments[].transactionId`	string	Unique transaction identifier for the payment
`data.vendorPayments[].resourceId`	string	Unique identifier of the associated resource
`data.vendorPayments[].resourceType`	string	Type of the resource e.g. `INVOICE`, `PURCHASE_ORDER`
`data.vendorPayments[].invoiceNo`	string	Human-readable invoice number
`data.vendorPayments[].currency`	string	Currency code for the payment e.g. `INR`, `USD`
`data.vendorPayments[].amount`	string	Amount paid to the vendor
`data.vendorPayments[].paidVia`	string	Payment method used e.g. `PLATFORM`, `MANUAL`
`data.vendorPayments[].paidBy`	object	Information about the user who made the payment
`data.vendorPayments[].paidBy.id`	string	Unique identifier for the user
`data.vendorPayments[].paidBy.name`	string	Name of the user
`data.vendorPayments[].paymentState`	string	Current state of the payment e.g. `FINISHED`, `PENDING`
`data.vendorPayments[].paymentDate`	string	ISO 8601 timestamp of when the payment was made
`data.vendorPayments[].utr`	string	Unique Transaction Reference number for the payment
`data.context.count`	number	Total number of vendor payments
`data.context.totalAmountByCurrency`	object	Total payment amounts grouped by currency code
`data.context.vendorBankDetails`	object	Bank account details of the vendor
`data.context.vendorBankDetails.accountName`	string	Name on the vendor’s bank account
`data.context.vendorBankDetails.accountIFSC`	string	IFSC code of the vendor’s bank
`data.context.vendorBankDetails.accountType`	string	Type of account identifier e.g. `IFSC`
`data.context.vendorBankDetails.accountNumber`	string	Vendor’s bank account number (Only if you ask for this in fields query params)

Response Example

{
  "ok": true,
  "data": {
    "vendorPayments": [
      {
        "transactionId": "<transactionId>",
        "resourceId": "<invoiceId>",
        "resourceType": "INVOICE",
        "invoiceNo": "INV-2026-001",
        "currency": "INR",
        "amount": 10,
        "paidVia": "PLATFORM",
        "paidBy": {
          "id": "<userId>",
          "name": "John Doe"
        },
        "paymentState": "FINISHED",
        "paymentDate": "2026-02-18T02:51:02.615Z",
        "utr": "<utrNumber>"
      },
      {
        "transactionId": "<transactionId>",
        "resourceId": "<invoiceId>",
        "resourceType": "INVOICE",
        "invoiceNo": "INV-2026-002",
        "currency": "INR",
        "amount": 13,
        "paidVia": "PLATFORM",
        "paidBy": {
          "id": "<userId>",
          "name": "John Doe"
        },
        "paymentState": "CONFIRMATION_PENDING",
        "paymentDate": "2026-02-10T07:39:01.460Z",
        "utr": ""
      }
    ],
    "context": {
      "count": 2,
      "totalAmountByCurrency": {
        "INR": 23
      },
      "vendorBankDetails": {
        "accountName": "John Doe",
        "accountIFSC": "ABCD0123456",
        "accountType": "IFSC",
        "accountNumber": "<accountNumber>"
      }
    }
  }
}

Error Responses

Missing Vendor ID

HTTP Status: 400 Bad Request

{
  "ok": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELD",
    "message": "Vendor ID is required"
  }
}

Vendor Not Found

HTTP Status: 404 Not Found

{
  "ok": false,
  "error": {
    "code": "VENDOR_NOT_FOUND",
    "message": "Vendor not found"
  }
}

Access Denied

HTTP Status: 403 Forbidden

{
  "ok": false,
  "error": {
    "code": "ACCESS_DENIED",
    "message": "Access denied: You can only view your own vendors or vendors where you are the vendor owner"
  }
}

Authentication Errors

HTTP Status: 401 Unauthorized

{
  "ok": false,
  "error": {
    "code": "MISSING_CREDENTIALS",
    "message": "Missing Credentials"
  }
}

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API Key"
  }
}

Permission Errors

HTTP Status: 403 Forbidden

{
  "ok": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Permission check failed - PERMISSION_CHECK_FAILED"
  }
}

Best Practices

Access Control

Only vendors you created or where you are the vendor owner are accessible (unless you have admin or auditor role)
Use the vendor id returned from the vendor creation endpoint to retrieve payments

Vendor APIs

Purchase Order APIs

Invoice APIs

Expense APIs

Payment APIs

Reimbursement APIs

User APIs

Tags APIs

GRN APIs

Inventory APIs

Download APIs

Company APIs

Tax APIs

Vendor Payments API

Authentication

Request

Path Parameters

Query Parameters

Code Examples

Success Response

Response Example

Error Responses

Missing Vendor ID

Vendor Not Found

Access Denied

Authentication Errors

Permission Errors

Best Practices

Access Control

​Authentication

​Request

​Path Parameters

​Query Parameters

​Code Examples

​Success Response

​Response Example

​Error Responses

​Missing Vendor ID

​Vendor Not Found

​Access Denied

​Authentication Errors

​Permission Errors

​Best Practices

​Access Control

Authentication

Request

Path Parameters

Query Parameters

Code Examples

Success Response

Response Example

Error Responses

Missing Vendor ID

Vendor Not Found

Access Denied

Authentication Errors

Permission Errors

Best Practices

Access Control