PaymentPlans

Sign Bulk Payment Plan Operation File URL

Returns a short-lived signed URL for `GET /payment-plans/bulk/{operationId}/download` with the same `type`. `type=file` is the CSV uploaded for a `source=csv` import, `type=backup` the gzipped "before" snapshot of a `source=selection` bulk operation. Responds `404` when the operation has no artefact of that type.

GET
/payment-plans/bulk/{operationId}/sign

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

Path Parameters

operationId*string

Bulk payment plan operation identifier

Formatuuid

Query Parameters

type*string

Artefact to download — file (uploaded CSV of a source=csv import) or backup ("before" snapshot of a source=selection bulk operation)

Value in

  • "file"
  • "backup"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payment-plans/bulk/497f6eca-6276-4993-bfeb-53cbbbba6f08/sign?type=file"
{  "location": "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"    }  ]}
{  "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"    }  ]}