swagger: '2.0' info: x-ibm-name: ndis-payment title: NDIS Payments version: 4.0.0 description: Digital Partners are able to submit and maintain payment requests via APIs. They can make requests for:
•Single or multiple payments and
•Retrieve information on submitted requests. contact: name: NDIA Support Team email: api.support@ndis.gov.au schemes: - https host: api.ndis.gov.au basePath: /sharedservices/ndis-api/ndis/4.0/payments consumes: - application/json produces: - application/json security: - clientIdHeader: [] securityDefinitions: clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id description: 'apiKey provided during registration. Max Length(64). example: aa111aa-11a1-1a11-111a-1a1a11aa111a' x-ibm-configuration: testable: true enforced: true cors: enabled: true phase: realized type: rest servers: - url: https://api.ndis.gov.au/sharedservices/ndis-api/ndis/4.0/payments description: '' type: - production - development - url: https://api.ndis.gov.au/sharedservices/ndis-api/ndis/4.0/payments description: '' type: - production - development paths: /: post: summary: This allows Digital Partners to create a new single payment request. description: |- Participant with Existing Plan
This operation will allow the DigitalPartners to submit a single payment request. Existing participant migrated to PACE should use current NDIS number In order to successfully submit a payment request, ensure that: 1. There exists a valid Service Booking that aligns with the payment request. 2. The price and quantity entered in the payment request do not exceed that of the Service Booking. 3. The Support Start and End Dates wholly fit within the Service Booking Start and End Dates. 4. For a Claim Type of Cancellation ("CANC"), Cancellation reason must be mandatorily provided. Use the NDIS Reference Data 3.0.0 API - GET/{attribute_name} operation, replacing the attribute_name with "claim_reason" to retrieve the required cancellation reason codes. Participant with PACE Plan
This operation will allow the DigitalPartners to submit a single payment request. New participant created in PACE should use NDIS number from PACE. Start Date and End Date should be within Plan Dates and Support Item Dates Note: Service Booking is not required for PACE claims. operationId: create_payment_request responses: '200': description: 'Success: The request was successful' schema: $ref: '#/definitions/create_payment_response' '400': description: 'Bad Request: A validation resulted in the request being rejected.' schema: $ref: '#/definitions/http_error' '401': description: 'Unauthorised: No authentication credentials provided or authentication has failed.' schema: $ref: '#/definitions/http_error' '404': description: The URI path or the requested record was not found. schema: $ref: '#/definitions/http_error' '500': description: 'Internal Server Error: An internal error has occurred and the server is unable to respond.' schema: $ref: '#/definitions/http_error' tags: - POST parameters: - name: payment_request_data required: true in: body schema: $ref: '#/definitions/payment_request_data' - $ref: '#/parameters/authorization' - $ref: '#/parameters/participant' get: summary: This allows the Digital Partner to request the list of payment claims for a specific participant. description: |- Participant with Existing Plan
This operation allows the Digital Partner to retrieve a list of all payment requests made by the provider for a specific participant. Existing participant migrated to PACE should use current NDIS number Participant with PACE Plan
This operation allows the Digital Partner to retrieve a list of all payment requests made by the provider for a specific participant. New participant created in PACE should use NDIS number from PACE operationId: payment_request_list responses: '200': description: 'Success: The request was successful' schema: $ref: '#/definitions/payment_list_response' '400': description: 'Bad Request: A validation resulted in the request being rejected.' schema: $ref: '#/definitions/http_error' '401': description: 'Unauthorised: No authentication credentials provided or authentication has failed.' schema: $ref: '#/definitions/http_error' '404': description: The URI path or the requested record was not found. schema: $ref: '#/definitions/http_error' '500': description: 'Internal Server Error: An internal error has occurred and the server is unable to respond.' schema: $ref: '#/definitions/http_error' tags: - GET parameters: - name: claim_status type: string required: false in: query description: Filter by field x-example: '41' - name: claim_number type: integer required: false in: query description: Filter by field format: int64 x-example: 1011111 - name: product_category_item type: string required: false in: query description: Filter by field x-example: '14031012783' - name: submit_date type: string required: false in: query description: Filter by field format: date - name: start_date type: string required: false in: query description: Filter by field format: date - name: end_date type: string required: false in: query description: Filter by field format: date - name: invoice_number type: string required: false in: query description: Filter by field x-example: '123445' - name: ref_doc_no type: string required: false in: query description: The client reference id for this invoice x-example: test_1234 - name: participant type: string required: true in: header description: The NDIS participant ID x-example: '430111111' - $ref: '#/parameters/skip' - $ref: '#/parameters/top' - $ref: '#/parameters/orderby' - $ref: '#/parameters/sortorder' - $ref: '#/parameters/authorization' /{claim_number}: patch: summary: This allows the Digital Partner to cancel the specified payment_request for the given claim_number. description: |- Participant with Existing Plan
This operation will allow the Digital Partners to cancel a payment request that is in the status of Payment Pending or Paid. The claim status will then change to Cancelled. Existing participant migrated to PACE should use current NDIS number If you cancel a payment request with a status of Paid, the Agency may: 1. Send you an invoice requesting repayment of the cancelled amount, or 2. Offset your future payment requests against the cancelled amount. Participant with PACE Plan
This operation will allow the Digital Partners to cancel a payment request that is in the status of Payment Pending or Paid. The claim status will then change to Cancelled. If you cancel a payment request with a status of Paid, the Agency may: 1. Send you an invoice requesting repayment of the cancelled amount, or 2. Offset your future payment requests against the cancelled amount. New participant created in PACE should use NDIS number from PACE. operationId: patch_payment_request responses: '202': description: 'Success: The request was successful' schema: $ref: '#/definitions/patch_payment_request_response' '400': description: 'Bad Request: A validation resulted in the request being rejected.' schema: $ref: '#/definitions/http_error' '401': description: 'Unauthorised: No authentication credentials provided or authentication has failed.' schema: $ref: '#/definitions/http_error' '404': description: The URI path or the requested record was not found. schema: $ref: '#/definitions/http_error' '500': description: 'Internal Server Error: An internal error has occurred and the server is unable to respond.' schema: $ref: '#/definitions/http_error' tags: - PATCH parameters: - name: participant type: string required: true in: header description: The NDIS participant ID x-example: '430111111' - $ref: '#/parameters/authorization' - $ref: '#/parameters/claim_number' get: summary: This allows the Digital Partners to request a specific payment claim for a specific provider. description: |- Participant with Existing Plan
Retrieve a summary of a single payment request made by the provider. Existing participant migrated to PACE should use current NDIS number Participant with PACE Plan
Retrieve a summary of a single payment request made by the provider. New participant created in PACE should use NDIS number from PACE. operationId: payment_request_details responses: '200': description: 'Success: The request was successful' schema: $ref: '#/definitions/payment_details_response' '400': description: 'Bad Request: A validation resulted in the request being rejected.' schema: $ref: '#/definitions/http_error' '401': description: 'Unauthorised: No authentication credentials provided or authentication has failed.' schema: $ref: '#/definitions/http_error' '404': description: The URI path or the requested record was not found. schema: $ref: '#/definitions/http_error' '500': description: 'Internal Server Error: An internal error has occurred and the server is unable to respond.' schema: $ref: '#/definitions/http_error' tags: - GET parameters: - name: participant type: string required: true in: header description: The NDIS participant ID x-example: '430111111' - $ref: '#/parameters/authorization' - $ref: '#/parameters/claim_number' /batch: post: summary: This allows the Digital Partners to perform a Bulk upload of payment requests. description: |- This operation will allow the Digital Partners to submit multiple payment requests via a single API call. API validations applied to the POST / operation for a single payment request also apply to this operation. Please note that these payment requests will be processed asynchronously. Existing participant migrated to PACE should use current NDIS number Participant with Existing Plan
Service Booking needs to be in place for successfull payment request. Participant with PACE Plan
New participant created in PACE should use NDIS number from PACE Example: PaymentWeek5.csv Note: Service Booking is not required for PACE claims. operationId: bulk_payment_request responses: '200': description: 'Success: The request was successful' schema: $ref: '#/definitions/bulk_payments_response' '400': description: 'Bad Request: A validation resulted in the request being rejected.' schema: $ref: '#/definitions/http_error' '401': description: 'Unauthorised: No authentication credentials provided or authentication has failed.' schema: $ref: '#/definitions/http_error' '404': description: The URI path or the requested record was not found. schema: $ref: '#/definitions/http_error' '500': description: 'Internal Server Error: An internal error has occurred and the server is unable to respond.' schema: $ref: '#/definitions/http_error' tags: - POST parameters: - name: input_data required: true in: body schema: $ref: '#/definitions/bulk_payments_request_data' - $ref: '#/parameters/authorization' - $ref: '#/parameters/batch_reference_name' get: responses: '200': description: 200 OK schema: $ref: '#/definitions/bulk_payment_list_response' '400': description: 'Bad Request: A validation resulted in the request being rejected.' schema: $ref: '#/definitions/http_error' '401': description: 'Unauthorised: No authentication credentials provided or authentication has failed.' schema: $ref: '#/definitions/http_error' '404': description: The URI path or the requested record was not found. schema: $ref: '#/definitions/http_error' '500': description: 'Internal Server Error: An internal error has occurred and the server is unable to respond.' schema: $ref: '#/definitions/http_error' operationId: bulk_payment_request_list description: |- This API operation will allow the Digital Partners to retrieve 25 payment requests without pagination, submitted as part of a single POST/{batch} operation, by supplying the "batch_reference_name" in the header. Use skip and top for pagination purposes. Maximum number of records returned in a call is 100 with pagination. Note - Batch reference name is not case sensitive. As long as the correct batch_reference_name is provided, the API will return all claims associated to it. tags: - GET parameters: - $ref: '#/parameters/batch_reference_name' - $ref: '#/parameters/authorization' - $ref: '#/parameters/skip' - $ref: '#/parameters/top' - $ref: '#/parameters/orderby' - $ref: '#/parameters/sortorder' summary: This operation will allow the Digital Partners to retreive multiple payment requests via a single API call. parameters: authorization: name: authorization type: string required: true in: header description: Bearer token x-example: valid Authorizaton Token participant: name: participant type: string required: false in: header description: The NDIS participant ID x-example: '430111111' claim_number: name: claim_number type: integer required: true in: path description: The claim number corresponding to the payment request. maxLength: 12 x-example: 1011111 skip: name: skip type: integer required: false in: header description: pagination field - No of rows to be skipped format: int32 x-example: 1 top: name: top type: integer required: false in: header description: pagination field - No of rows to be returned format: int32 x-example: 1 orderby: name: orderby type: string required: false in: header description: Pagination - sort by field x-example: field sortorder: name: sortorder type: string required: false in: header description: 'Pagination - sort order: valid values - asc/desc' x-example: asc inlinecount: name: inlinecount type: string required: false in: header description: allpages x-example: allpages start_date_from: name: start_date_from type: string required: false in: query description: Start Date From format: date start_date_to: name: start_date_to type: string required: false in: query description: Start Date To format: date end_date_from: name: end_date_from type: string required: false in: query description: End Date From format: date end_date_to: name: end_date_to type: string required: false in: query description: End Date To format: date batch_reference_name: name: batch_reference_name type: string required: true in: header description: 'Batch Reference Name, ''batch_reference_name'' must end with .csv , and must not exceed 20 characters (inclusive of .csv as extension) e.g.: testingref.csv' x-example: testingref.csv definitions: create_payment_response: description: Create a payment request properties: success: type: boolean example: true result: $ref: '#/definitions/payment_details' errors: $ref: '#/definitions/errors' additionalProperties: false required: - success payment_details_response: description: Response for Geting a payment details properties: success: type: boolean example: true result: $ref: '#/definitions/payment_details' errors: $ref: '#/definitions/errors' additionalProperties: false required: - success payment_details: properties: claim_number: type: integer description: The claim ID maxLength: 12 example: 10125329 format: int32 claimed_amount: type: number description: Claimed Amount example: 2.3 format: double participant: type: integer description: Participant NDIS Id maxLength: 10 example: 430212474 format: int32 participant_name: type: string description: Participant Name maxLength: 50 example: Joy Sunshine invoice_number: type: string description: Invoice number maxLength: 12 example: '123445' claim_status: type: string description: The status of the claim maxLength: 2 example: '41' start_date: type: string description: date, Start date of service provided example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ end_date: type: string description: date, End date of service provided example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ product_category: type: string description: Participant Support Category maxLength: 40 example: HOME_MODIFICATIONS product_category_item: type: string description: Support Category Item Number maxLength: 40 example: '14031012783' product_description: type: string description: Product Description maxLength: 132 example: Incontinence claim_type: type: string description: claim type maxLength: 4 example: '' claim_reason: type: string description: claim reason maxLength: 4 example: '' amount: type: number description: Maxlength P16, S3, The amount claimed as part of this payment request example: 25.25 format: double quantity: type: number description: Maxlength P13, S3, Item quantity claimed example: 1.5 format: double tax_code: type: string description: GST tax on amount maxLength: 2 example: P5 plan_id: type: integer description: The corresponding participant plan id maxLength: 10 example: 1027034 format: int32 service_agreement: type: integer description: Service booking number maxLength: 10 example: 50023903 format: int32 inkind_flag: type: boolean description: Indicates an in-kind item example: true submit_date: type: string description: Submit date YYYY-MM-DD example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ submit_by: type: string description: BP number of the person who submitted request maxLength: 12 example: TEST reject_reason_code: type: string description: Rejection reason code maxLength: 4 example: '' paid_date: type: string description: Paid date YYYY-MM-DD example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ abn_provider: type: integer description: ABN number for provider (Please provide a valid ABN number or use 0 as the value when you don't want to pass any ABN) example: 60006000014 format: int32 exemption_reason: type: string description: ABN exemption reason (Please provide a valid exemption reason code or leave blank if not applicable) example: EXCLS maxLength: 5 ref_doc_no: type: string description: reference doc number example: test_1234 clearing_number: type: integer format: int32 description: Clearing number example: '12234' additionalProperties: false payment_list_response: description: Response for Geting a payment list properties: success: type: boolean example: true result: $ref: '#/definitions/payment_list' errors: $ref: '#/definitions/errors' additionalProperties: false required: - success payment_list: description: Payment list type: array items: $ref: '#/definitions/payment_list_item' payment_list_item: description: Fields of a payment list properties: claim_number: type: integer description: The claim ID example: 10125329 format: int32 participant: type: integer description: participant NDIS Id example: 430212474 format: int32 invoice_number: type: string description: invoice number participant_name: type: string description: participant Name example: Joy Sunshine product_category: type: string description: Participant Support Category example: CB_CHOICE_CONTROL submit_date: type: string description: date, Submitted date example: '2001-12-31' pattern: ^\d{4}-\d{2}-\d{2}$ start_date: type: string description: date, Start date of service provided example: '2001-12-31' pattern: ^\d{4}-\d{2}-\d{2}$ end_date: type: string description: date, End date of service provided example: '2001-12-31' pattern: ^\d{4}-\d{2}-\d{2}$ claim_status: type: string description: The status of the claim example: '41' service_agreement: type: integer description: Service Agreement Number for this payment request example: 50002415 format: int32 ref_doc_no: type: string description: Client reference number for this payment request example: ABCD1234 abn_provider: type: integer description: ABN number for provider (Please provide a valid ABN number or use 0 as the value when you don't want to pass any ABN) example: 60006000014 format: int32 exemption_reason: type: string description: ABN exemption reason (Please provide a valid exemption reason code or leave blank if not applicable) example: EXCLS maxLength: 5 additionalProperties: false payment_request_data: properties: ref_doc_no: type: string description: Client reference number for this payment request example: ABCD1234 maxLength: 50 service_agreement: type: integer description: The service booking number for which payment request made maxLength: 10 example: 12345 format: int32 product_category_item: type: string description: Support Category Item Number maxLength: 40 example: '05_220627230_0122_1_2' participant: type: integer description: The participant NDIS ID for whom the service was provided maxLength: 10 format: int32 claimed_amount: type: number description: Claimed Amount example: 2.3 format: double quantity: type: number description: Quantity corresponding to the serviced item, Maxlength P13, S3 format: double example: 1.5 tax_code: type: string description: The tax code for GST maxLength: 2 example: P5 claim_type: type: string description: Claim Type example: '' maxLength: 4 claim_reason: type: string description: Reason for cancellation example: '' maxLength: 4 start_date: type: string description: The start date of the service provided example: '2021-01-01' pattern: ^\d{4}-\d{2}-\d{2}$ end_date: type: string description: The end date of the service provided example: '2021-01-01' pattern: ^\d{4}-\d{2}-\d{2}$ unit_of_measure: type: string description: Unit of measure maxLength: 3 example: EA abn_provider: type: integer description: ABN number for provider (Please provide a valid ABN number or use 0 as the value when you don't want to pass any ABN) example: 60006000014 format: int32 abn_not_available: type: boolean description: Flag to indicate if a ABN has been supplied example: true exemption_reason: type: string description: ABN exemption reason (Please provide a valid exemption reason code or leave blank if not applicable) example: EXCLS maxLength: 5 additionalProperties: true required: - quantity - tax_code - product_category_item - end_date - start_date - ref_doc_no - participant - claimed_amount bulk_payments_request_data: properties: bulk_payment_request: type: array items: $ref: '#/definitions/bulk_payment_item_request_data' additionalProperties: false bulk_payment_item_request_data: properties: participant: type: integer description: participant Number maxLength: 10 example: 430000000 format: int32 start_date: type: string description: Service Booking Start Date example: '2021-01-01' pattern: ^\d{4}-\d{2}-\d{2}$ end_date: type: string description: Service Booking End Date example: '2021-01-01' pattern: ^\d{4}-\d{2}-\d{2}$ product_category_item: type: string description: Support Category Item Number maxLength: 40 example: '05_220627230_0122_1_2' ref_doc_no: type: string description: Client reference number for this payment request maxLength: 50 example: ABCD1234 quantity: type: number description: Quantity (Either Quantity or Hours – only one is allowed), Maxlength P13, S3 example: 1.5 format: double hours: type: string description: Hours (Either Quantity or Hours – only one is allowed) example: '2.5' unit_price: type: number description: Unit Price example: 2.3 format: double tax_code: type: string description: The tax code for GST maxLength: 2 example: P2 authorised_by: type: string description: BP number of the person who Authorised maxLength: 12 example: ABC123 participant_approved: type: integer description: BP number of the participant who approved maxLength: 12 example: 430000000 format: int32 inkind_flag: type: boolean description: Indicates an inkind item example: true claim_type: type: string description: Claim Type maxLength: 4 example: TRAN claim_reason: type: string description: Reason for cancellation maxLength: 4 example: NSDO abn_provider: type: integer description: ABN number for provider (Please provide a valid ABN number or use 0 as the value when you don't want to pass any ABN) example: 60006000014 format: int32 abn_not_available: type: boolean description: Flag to indicate if a ABN has been supplied example: true exemption_reason: type: string description: ABN exemption reason (Please provide a valid exemption reason code or leave blank if not applicable) example: EXCLS maxLength: 5 additionalProperties: true required: - participant - start_date - end_date - product_category_item - ref_doc_no - unit_price - tax_code bulk_payments_response: description: Bulk payment response properties: success: type: boolean example: true errors: $ref: '#/definitions/errors' additionalProperties: false required: - success bulk_payment_list_response: description: Response for bulk payment request list properties: success: type: boolean example: true result: $ref: '#/definitions/bulk_payment_list' errors: $ref: '#/definitions/errors' additionalProperties: false required: - success bulk_payment_list: properties: claim_number: type: integer description: The Claim ID format: int32 example: 10125329 participant: type: integer description: participant NDIS ID format: int32 example: 430212474 invoice_number: type: string description: invoice number participant_name: type: string description: participant name example: James Band product_category: type: string description: Participant Support Category example: CB_CHOICE_CONTROL product_category_item: type: string description: Participant Support Category Item example: 6183018401011122 submit_date: type: string description: date, Submitted date pattern: ^\d{4}-\d{2}-\d{2}$ example: '2001-12-31' start_date: type: string description: date, Start date of service provided pattern: ^\d{4}-\d{2}-\d{2}$ example: '2001-12-31' end_date: type: string description: date, End date of service provided pattern: ^\d{4}-\d{2}-\d{2}$ example: '2001-12-31' claim_status: type: string description: The status of the claim example: '41' service_agreement: type: integer description: Service Agreement Number for this payment request format: int32 example: 50002415 ref_doc_no: type: string description: Client reference number for this payment request example: ABCD1234 abn_provider: type: integer description: ABN number for provider (Please provide a valid ABN number or use 0 as the value when you don't want to pass any ABN) format: int32 example: 60006000014 exemption_reason: type: string description: ABN exemption reason (Please provide a valid exemption reason code or leave blank if not applicable) example: EXCLS reject_reason_code: type: string description: Reject Reason Code example: C16 additionalProperties: false description: Fields related to bulk Payment response patch_payment_request_response: description: Response for Patching a payment request properties: success: type: boolean example: true result: $ref: '#/definitions/patch_payment_response_details' errors: $ref: '#/definitions/errors' additionalProperties: false required: - success patch_payment_response_details: properties: claim_number: type: integer description: The claim ID maxLength: 12 example: 10125329 format: int32 claimed_amount: type: number description: Claimed Amount example: 2.3 format: double participant: type: integer description: Participant NDIS Id maxLength: 10 example: 430212474 format: int32 participant_name: type: string description: Participant Name maxLength: 50 example: Joy Sunshine invoice_number: type: string description: Invoice number maxLength: 12 claim_status: type: string description: The status of the claim maxLength: 2 example: '41' start_date: type: string description: date, Start date of service provided example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ end_date: type: string description: date, End date of service provided example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ product_category: type: string description: Participant Support Category maxLength: 40 example: HOME_MODIFICATIONS product_category_item: type: string description: Support Category Item Number maxLength: 40 example: '14031012783' product_description: type: string description: Product Description maxLength: 132 example: Incontinence claim_type: type: string description: claim type maxLength: 4 example: '' claim_reason: type: string description: claim reason maxLength: 4 example: '' amount: type: number description: Maxlength P16, S3, The amount claimed as part of this payment request example: 25.25 format: double quantity: type: number description: Maxlength P13, S3, Item quantity claimed example: 1.5 format: double tax_code: type: string description: GST tax on amount maxLength: 2 example: P5 plan_id: type: integer description: The corresponding participant plan id maxLength: 10 example: 1027034 format: int32 service_agreement: type: integer description: Service booking number maxLength: 10 example: 50023903 format: int32 inkind_flag: type: boolean description: Indicates an in-kind item example: true submit_date: type: string description: Submit date YYYY-MM-DD example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ submit_by: type: string description: BP number of the person who submitted request maxLength: 12 example: TEST reject_reason_code: type: string description: Rejection reason code maxLength: 4 example: '' paid_date: type: string description: Paid date YYYY-MM-DD example: '2019-06-03' pattern: ^\d{4}-\d{2}-\d{2}$ abn_provider: type: integer description: ABN number for provider (Please provide a valid ABN number or use 0 as the value when you don't want to pass any ABN) example: 60006000014 format: int32 exemption_reason: type: string description: ABN exemption reason (Please provide a valid exemption reason code or leave blank if not applicable) example: EXCLS maxLength: 5 ref_doc_no: type: string description: reference doc number example: test_1234 clearing_number: type: integer format: int32 description: Clearing number example: '12234' additionalProperties: false errors: description: A set of errors type: array items: type: string example: error http_error: description: A single HTTP response properties: http_code: type: string example: 400 description: HTTP status code http_message: type: string example: Bad Request description: HTTP Message more_information: type: string example: One or more required API parameters are missing. description: Additional information additionalProperties: false tags: []