B2BROKERB2BROKER
MCP
B2COREB2CORE IBB2TRADERB2CONNECTB2TRANSLATEB2BROKER
PaymentPlans

Get Bulk Payment Plan Operations

Returns every payment plan operation row newest first: CSV imports (`source=csv`), bulk operations created through this API (`source=selection`) and support restores (`source=restore`). `paramsSummary` is filled for bulk operations only; the raw `params` object is available on the details endpoint.

GET
/payment-plans/bulk

Authorization

appToken read
AuthorizationBearer <token>

App access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.

In: header

Scope: read

Query Parameters

limit?integer
Default20
offset?integer
Default0
filter[source]?string

Value in

  • "csv"
  • "selection"
  • "restore"
filter[status]?string

Value in

  • "pending"
  • "processing"
  • "completed"
  • "failed"
filter[platformId]?string

Bulk operations whose selection targets this platform

Formatuuid
filter[userGroupId]?string

CSV imports of this IB type and bulk operations whose resolved IB types include it

Formatuuid
filter[createdFrom]?string
Formatdate-time
filter[createdTo]?string

Inclusive upper bound; a date without a time component covers that whole day

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payment-plans/bulk"
{  "total": 0,  "operations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "source": "csv",      "status": "pending",      "processor": "php",      "userGroupId": "080a16e0-8946-456c-aef9-504a239bc5ab",      "fileName": "string",      "totalRows": 0,      "processedRows": 0,      "errorsTotal": 0,      "paramsSummary": {        "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",        "platformName": "string",        "provider": "string",        "userGroupCount": 0,        "userGroupIds": [          "c74731e8-6cfe-4fb8-a03c-56ca2eebc391"        ],        "userGroupIdsResolvedCount": 0,        "groupSelectorCount": 0,        "symbolSelectorCount": 0,        "action": "upsert",        "planSummary": {          "formula": "string",          "ratio": "string",          "unit": "string",          "position": "string"        }      },      "backup": {        "filePath": "string",        "rows": 0,        "takenAt": "2019-08-24T14:15:22Z"      },      "createTime": "2019-08-24T14:15:22Z",      "updateTime": "2019-08-24T14:15:22Z"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}
PreviousCheck for Updates GETNextCreate Bulk Payment Plan Operation POST