{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Payment Runs API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Payment Runs", "type": "folder" }, "items": [ { "info": { "name": "List payment runs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" }, { "name": "createdById", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdById` field.\n" }, { "name": "createdDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `createdDate` field.\n" }, { "name": "status", "value": "", "type": "query", "description": "This parameter filters the response based on the `status` field.\n" }, { "name": "targetDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `targetDate` field.\n" }, { "name": "updatedById", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedById` field.\n" }, { "name": "updatedDate", "value": "", "type": "query", "description": "This parameter filters the response based on the `updatedDate` field.\n" }, { "name": "sort", "value": "", "type": "query", "description": "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by payment run number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - targetDate\n - status\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n\nExamples:\n\n- /v1/payment-runs?sort=+createdDate\n\n- /v1/payment-runs?status=Processing&sort=-createdById,+targetDate\n" } ] }, "docs": "Retrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response.\n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n\nExamples:\n\n- /v1/" }, { "info": { "name": "Create a payment run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-runs", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates a payment run. You can create a payment run to be executed immediately after it is created, or a scheduled payment run to be executed in future.\n\nTo filter the payments to be collected for a payment run, you can use either of the following methods but not both:\n\n - Use the `accountId`, `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields to define the billing documents to be collected.\n - Use the `data` field to specify the records of accounts and billing " }, { "info": { "name": "Retrieve a payment run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Retrives the information about a specific payment run.\n" }, { "info": { "name": "Update a payment run", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Updates the information about an unexecuted payment run. Only pending payment runs can be updated.\n\nIf none of the **accountId**, **batch**, **billCycleDay**, **currency**, **paymentGatewayId**, and **billingRunId** fields is specified in the request body, the corresponding payment run collects payments for all accounts.\n" }, { "info": { "name": "Delete a payment run", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted.\n" }, { "info": { "name": "Retrieve a payment run summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey/summary", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Retrives the summary of a payment run.\n" }, { "info": { "name": "Retrieve payment run data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-runs/:paymentRunKey/data", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "paymentRunKey", "value": "", "type": "path", "description": "The unique ID of a payment run or the payment run number. For example, 402890245f097f39015f0f074a2e0566.\n" } ] }, "docs": "Retrieves payment run data and the processing result with details, if the `data` field was specified in the Create payment run operation.\n \n" } ] } ], "bundled": true }