StatementsPayments
/statements/pay/preview
Preview owner statement payout plans without creating transactions. Returns authoritative per-owner allocations after server rounding, default bank accounts, ACH payment-method readiness, exact Ramp funding-source readiness, and typed blockers for the submitted owner selections. An unconfigured Ramp transfer flow is eligible but remains unchanged until payment. POST /statements/pay revalidates the same rules; the preview is advisory.
Required scope: statements:read
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Request Body
application/json
date?string|null
statements*
Items
1 <= items <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://staging.api.vrplatform.app/statements/pay/preview" \ -H "Content-Type: application/json" \ -d '{ "statements": [ { "statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222" } ] }'{
"data": [
{
"statementId": "775b692d-f1fa-4640-9327-0c9bb8d02222",
"ready": true,
"connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
"amount": -9007199254740991,
"owners": [
{
"contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
"amount": -9007199254740991,
"defaultBankAccountId": "ba3bfa00-69d3-4e9f-9e9e-548577eac893",
"paymentMethod": {
"provider": "ramp",
"connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
"last4": "stri",
"status": "notConfigured"
},
"ready": true
}
],
"issues": [
{
"code": "statementNotFound",
"message": "string",
"contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d"
}
]
}
]
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}