Upload Payment Verification Details

curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>' \
  --data '
{
  "buyer_name": "John Doe",
  "type_of_goods": "GOODS",
  "product_description": "Electronics and accessories",
  "buyer_address": "123 Main Street, City, State",
  "invoice_number": "INV-2025-001",
  "buyer_postal_code": "12345",
  "hs_code": "8517.12.00"
}
'

import requests

url = "https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/"

payload = {
    "buyer_name": "John Doe",
    "type_of_goods": "GOODS",
    "product_description": "Electronics and accessories",
    "buyer_address": "123 Main Street, City, State",
    "invoice_number": "INV-2025-001",
    "buyer_postal_code": "12345",
    "hs_code": "8517.12.00"
}
headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "X-Merchant-ID": "<api-key>",
    "X-API-Version": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'X-Merchant-ID': '<api-key>',
    'X-API-Version': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    buyer_name: 'John Doe',
    type_of_goods: 'GOODS',
    product_description: 'Electronics and accessories',
    buyer_address: '123 Main Street, City, State',
    invoice_number: 'INV-2025-001',
    buyer_postal_code: '12345',
    hs_code: '8517.12.00'
  })
};

fetch('https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/', 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://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'buyer_name' => 'John Doe',
    'type_of_goods' => 'GOODS',
    'product_description' => 'Electronics and accessories',
    'buyer_address' => '123 Main Street, City, State',
    'invoice_number' => 'INV-2025-001',
    'buyer_postal_code' => '12345',
    'hs_code' => '8517.12.00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Version: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>",
    "X-Merchant-ID: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/"

	payload := strings.NewReader("{\n  \"buyer_name\": \"John Doe\",\n  \"type_of_goods\": \"GOODS\",\n  \"product_description\": \"Electronics and accessories\",\n  \"buyer_address\": \"123 Main Street, City, State\",\n  \"invoice_number\": \"INV-2025-001\",\n  \"buyer_postal_code\": \"12345\",\n  \"hs_code\": \"8517.12.00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("X-Merchant-ID", "<api-key>")
	req.Header.Add("X-API-Version", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("X-Merchant-ID", "<api-key>")
  .header("X-API-Version", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"buyer_name\": \"John Doe\",\n  \"type_of_goods\": \"GOODS\",\n  \"product_description\": \"Electronics and accessories\",\n  \"buyer_address\": \"123 Main Street, City, State\",\n  \"invoice_number\": \"INV-2025-001\",\n  \"buyer_postal_code\": \"12345\",\n  \"hs_code\": \"8517.12.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/")

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

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-Merchant-ID"] = '<api-key>'
request["X-API-Version"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"buyer_name\": \"John Doe\",\n  \"type_of_goods\": \"GOODS\",\n  \"product_description\": \"Electronics and accessories\",\n  \"buyer_address\": \"123 Main Street, City, State\",\n  \"invoice_number\": \"INV-2025-001\",\n  \"buyer_postal_code\": \"12345\",\n  \"hs_code\": \"8517.12.00\"\n}"

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

{
  "success": true,
  "message": "Payment verification details uploaded successfully; order updated.",
  "data": {
    "uploaded_documents": [
      {
        "doc_name": "importer_name",
        "doc_type": "VALUE",
        "doc_status": "VERIFIED",
        "remarks": null,
        "added_on": null,
        "last_updated_on": null
      }
    ],
    "missing_documents": [],
    "errors": []
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

POST

payments

{uid}

upload-verification-details

Upload Payment Verification Details

curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>' \
  --data '
{
  "buyer_name": "John Doe",
  "type_of_goods": "GOODS",
  "product_description": "Electronics and accessories",
  "buyer_address": "123 Main Street, City, State",
  "invoice_number": "INV-2025-001",
  "buyer_postal_code": "12345",
  "hs_code": "8517.12.00"
}
'

import requests

url = "https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/"

payload = {
    "buyer_name": "John Doe",
    "type_of_goods": "GOODS",
    "product_description": "Electronics and accessories",
    "buyer_address": "123 Main Street, City, State",
    "invoice_number": "INV-2025-001",
    "buyer_postal_code": "12345",
    "hs_code": "8517.12.00"
}
headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "X-Merchant-ID": "<api-key>",
    "X-API-Version": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'X-Merchant-ID': '<api-key>',
    'X-API-Version': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    buyer_name: 'John Doe',
    type_of_goods: 'GOODS',
    product_description: 'Electronics and accessories',
    buyer_address: '123 Main Street, City, State',
    invoice_number: 'INV-2025-001',
    buyer_postal_code: '12345',
    hs_code: '8517.12.00'
  })
};

fetch('https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/', 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://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'buyer_name' => 'John Doe',
    'type_of_goods' => 'GOODS',
    'product_description' => 'Electronics and accessories',
    'buyer_address' => '123 Main Street, City, State',
    'invoice_number' => 'INV-2025-001',
    'buyer_postal_code' => '12345',
    'hs_code' => '8517.12.00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Version: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>",
    "X-Merchant-ID: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/"

	payload := strings.NewReader("{\n  \"buyer_name\": \"John Doe\",\n  \"type_of_goods\": \"GOODS\",\n  \"product_description\": \"Electronics and accessories\",\n  \"buyer_address\": \"123 Main Street, City, State\",\n  \"invoice_number\": \"INV-2025-001\",\n  \"buyer_postal_code\": \"12345\",\n  \"hs_code\": \"8517.12.00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("X-Merchant-ID", "<api-key>")
	req.Header.Add("X-API-Version", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("X-Merchant-ID", "<api-key>")
  .header("X-API-Version", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"buyer_name\": \"John Doe\",\n  \"type_of_goods\": \"GOODS\",\n  \"product_description\": \"Electronics and accessories\",\n  \"buyer_address\": \"123 Main Street, City, State\",\n  \"invoice_number\": \"INV-2025-001\",\n  \"buyer_postal_code\": \"12345\",\n  \"hs_code\": \"8517.12.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-pacb-uat.eximpe.com/pg/payments/{uid}/upload-verification-details/")

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

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-Merchant-ID"] = '<api-key>'
request["X-API-Version"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"buyer_name\": \"John Doe\",\n  \"type_of_goods\": \"GOODS\",\n  \"product_description\": \"Electronics and accessories\",\n  \"buyer_address\": \"123 Main Street, City, State\",\n  \"invoice_number\": \"INV-2025-001\",\n  \"buyer_postal_code\": \"12345\",\n  \"hs_code\": \"8517.12.00\"\n}"

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

{
  "success": true,
  "message": "Payment verification details uploaded successfully; order updated.",
  "data": {
    "uploaded_documents": [
      {
        "doc_name": "importer_name",
        "doc_type": "VALUE",
        "doc_status": "VERIFIED",
        "remarks": null,
        "added_on": null,
        "last_updated_on": null
      }
    ],
    "missing_documents": [],
    "errors": []
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Overview

The Upload Payment Verification Details endpoint allows you to upload payment verification details for a payment. This updates the associated order with the provided information and uploads the verification details to the payment gateway. Use this endpoint when you receive a PAYMENT_DETAILS_MISSING webhook, or a VERIFICATION_NEEDED webhook with verification_status of ACTION_REQUIRED, and need to supply the missing or corrected verification fields.

When this applies

Credits that land in a Virtual Bank Account create a payment against an order. If that order is missing any of the fields required for payment verification, the platform emits PAYMENT_DETAILS_MISSING listing exactly which fields are absent. This endpoint is how you supply them programmatically, rather than editing the order in the dashboard.

Verification flow

Payment recorded

A credit is received and a payment is created against the order.

Missing fields reported

If verification fields are absent, the PAYMENT_DETAILS_MISSING webhook fires with a details_missing array naming each one.

Supply the details

Call this endpoint with the missing fields for that payment uid.

Verification outcome

The VERIFICATION_NEEDED webhook reports the result — VERIFIED, IN_REVIEW, or ACTION_REQUIRED with the fields still needing attention.

Test Data

When testing this API in the sandbox environment, you must use the following specific test values for the API to work correctly:

buyer_name: John
buyer_postal_code: 560034
product_description: This is a test product for test purpose.

Requests using other values will not verify successfully in sandbox.

Authorizations

X-Client-ID

string

header

required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret

string

header

required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-Merchant-ID

string

header

required

Merchant Identifier - The unique ID for the merchant account. This is required for PSP (Payment Service Provider) merchants who manage multiple merchant accounts. You can find merchant IDs in the Merchant Management section of the dashboard.

X-API-Version

string

header

required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Path Parameters

uid

string

required

UID of the payment for which to upload verification details.

Body

application/json

buyer_name

string

required

Name of the buyer/importer.

Maximum string length: 255

type_of_goods

enum<string>

required

Type of goods.

Available options:

GOODS,

PHYSICAL_GOODS,

DIGITAL_GOODS,

SERVICE

product_description

string

required

Description of the product/goods.

buyer_address

string

required

Buyer's address.

invoice_number

string

required

Invoice number.

Maximum string length: 255

buyer_postal_code

string

required

Buyer's postal/ZIP code.

Maximum string length: 10

hs_code

string

HS code. Required when type_of_goods is GOODS, PHYSICAL_GOODS, or DIGITAL_GOODS; optional for SERVICE.

Maximum string length: 30

Response

Payment verification details uploaded successfully; order updated.

success

boolean

message

string

data

object

Show child attributes

Order

Payment

Merchant

Settlement

Refund

Virtual Bank Accounts

LRS

Webhooks

Upload Payment Verification Details

Overview

When this applies

Verification flow

Test Data

Authorizations

Path Parameters

Body

Response

​Overview

​When this applies

​Verification flow

​Test Data

Authorizations

Path Parameters

Body

Response

Overview

When this applies

Verification flow

Test Data