VRPlatformVRPlatform
ContactsPayments

/contacts/{contactId}/payouts

List the selected contact's active payout transactions newest first. Authenticated owners may request only contact IDs in their server-derived owner access; unauthorized contacts return an opaque not-found response. Property managers and owner-preview sessions may request a selected team contact. The response is an owner-facing projection with the linked owner statement and its listing, the payout balance, and its payments with status and settlements. Payouts linked to more than one statement return no owner statement rather than a misleading listing. Bank, reconciliation, journal, connection, and provider routing fields are excluded.

Required scope: transactions:read

GET
/contacts/{contactId}/payouts

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

contactId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

limit?integer
Default100
Range1 <= value <= 250
page?integer
Range1 <= value <= 9007199254740991
offset?integer
Range0 <= value <= 9007199254740991

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/payouts"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "uniqueRef": "string",
      "shortRef": "string",
      "date": "string",
      "description": "string",
      "amount": -9007199254740991,
      "currency": "string",
      "ownerStatement": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "uniqueRef": "string",
        "month": "2024-01",
        "listing": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        }
      },
      "balance": {
        "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
        "currency": "string",
        "payableAmount": -9007199254740991,
        "netSettledAmount": -9007199254740991,
        "pendingAmount": 9007199254740991,
        "remainingAmount": -9007199254740991,
        "availableAmount": 9007199254740991,
        "overpaidAmount": 9007199254740991,
        "reconciliationRequired": true
      },
      "payments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
          "amount": 2147483647,
          "currency": "string",
          "method": "ach",
          "provider": "ramp",
          "destinationRef": "string",
          "requestedDate": "string",
          "reference": "string",
          "status": "pending",
          "settledAt": "2024-01-15T12:30:00.000+00:00",
          "postingDate": "string",
          "terminalAt": "2024-01-15T12:30:00.000+00:00",
          "issue": "unknownOutcome",
          "providerFailureCode": "string",
          "createdAt": "2024-01-15T12:30:00.000+00:00",
          "allocations": [
            {
              "transactionLineId": "fd65f0e1-e58a-476a-86fa-780d3071bfee",
              "amount": -9007199254740991
            }
          ],
          "reversal": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",
            "kind": "providerReturn",
            "effectiveAt": "2024-01-15T12:30:00.000+00:00",
            "postingDate": "string",
            "reason": "string",
            "createdAt": "2024-01-15T12:30:00.000+00:00"
          }
        }
      ]
    }
  ],
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 0,
    "totalPage": 0,
    "nextPage": 0
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "LOCKED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/contacts/{id} PUT

Previous Page

/contacts/{id}/payment-methods/ach POST

Next Page