Invoice, Query Invoices and Query Payments

Set Admin Credentials...
payments/details

GET

payments/details

Description

The Query Invoice and Payment Status APIs provide the ability for the Provider to see whether invoices for the claim, or secondary interactions, have been accepted and paid.This specific API returns the details of payments related to specified Invoices for the Vendor.

Resource Summary

Security

Type

application/json

URL

https://apiservicesnpe.acc.co.nz/api/v2/claims/vendors/payments/details/{paymentReference}

Supporting Documentation

Query Parameters

Name Values Description
vendorId
(required)

vendorId
page

page
pageSize

pageSize

Request Body

paymentReference paymentReference null true

Operations

When using the API Key custom token in the Operations portion for any selected API below, set NAME to 'apikey', VALUE to My Apps, Consumer Key value, and select the HEADER option before clicking SET.

Basic HTTP authentication

Set

OAuth 2 authentication

Set

API Key custom token

Set
Request Response cURL

Working...

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

    Bad Request: invalid data

  • 401

    Unauthorized: authentication error

  • 403

    Forbidden: authorization error

  • 404

    Not Found

  • 500

    Internal Server Error