---
title: "partner/partners/details"
method: GET
path: "/partner/partners/details"
tags: ["Partner Endpoints"]
---

# partner/partners/details

`GET /partner/partners/details`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/partner/partners/details`
- Auth: none declared

This endpoint returns the details of a partner account created by the calling partner. Requires the PartnerCreationEnabled permission. Returns RESOURCE_NOT_FOUND when the partner account does not exist or was not created by the caller.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `PartnerAccountID` string, required

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `PartnerAccountID` string, required: APIAccountID of the partner account
  - `Name` string, required: Partner account name
  - `AccountStatus` string, required: Current onboarding status of the partner account. Empty string when no status is set yet.
  - `AccountStatusDate` string, nullable, required: Date the partner account entered its current status. Falls back to DateAdded.
  - `IsActive` boolean, required: Whether the partner account is active
  - `DateAdded` string, required: Date the partner account was created
  - `DateActivated` string, nullable, required: Date the partner account was first activated
  - `AccountNumber` string, nullable, required: Account number, assigned on activation
  - `PartnerType` string, required: Partner account type
  - `PartnerTypeLabel` string, required: Display label of the partner type. Empty string when none applies.
  - `RevShare` string, nullable, required: Revenue share percentage. Null when not applicable. Mutually exclusive with MinimumProgramFee.
  - `MinimumProgramFee` string, nullable, required: Minimum program fee. Null when not applicable. Mutually exclusive with RevShare.
  - `Country` string, required: Country name of the partner account
  - `Currency` string, required: Currency of the partner account, short form
  - `ApiKey` string: Returned only when the partner account is Active and has an active API key
  - `ApiSharedSecret` string: Returned only when the partner account is Active and has an active API key
  - `Agreement` object, required: Status of the partner agreement document.
    - `DocumentSent` boolean, required: Whether the agreement document has been sent
    - `DocumentCompleted` boolean, required: Whether the agreement document has been completed
    - `DocumentCategory` string, required: Agreement document category. Empty string for partner types with no agreement.

## Changes

- **2026-11-03** `71f251deb318`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vopay/apis/accounts/changes/partner/partners/details/get.md)

---

[API](https://skmtc.dev/vopay/apis/accounts.md) - [All operations](https://skmtc.dev/vopay/apis/accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/accounts/revisions/71f251deb318?raw)