Skip to main content
GET
/
pg
/
vba
/
{virtual_account_id}
/
payments
List VBA Payments
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/vba/{virtual_account_id}/payments/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>'
{
  "success": true,
  "message": "VBA payments retrieved successfully",
  "data": {
    "count": 42,
    "page": 1,
    "page_size": 10,
    "next": "https://api.example.com/pg/vba/a1b2c3d4/payments/?page=2&page_size=10",
    "previous": null,
    "results": [
      {
        "payment_id": "550e8400-e29b-41d4-a716-446655440001",
        "order_id": "660e8400-e29b-41d4-a716-446655440002",
        "status": "SUCCESS",
        "amount": 100.5,
        "payment_utr": "UTR123456789012",
        "created_at": "2025-02-10T14:30:00Z"
      }
    ]
  }
}

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' or '2.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

​
virtual_account_id
string
required

Virtual account ID of the VBA.

Query Parameters

​
page
integer

Page number for pagination.

Required range: x >= 1
​
page_size
integer
default:250

Number of items per page. Default is 250, maximum is 1000.

Required range: 1 <= x <= 1000

Response

VBA payments retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"VBA payments retrieved successfully"

​
data
object