pnz-apicentre-sandbox-sdk
Version:
The sandbox, powered by Middleware New Zealand, is a dedicated environment that mimics an API Provider, as defined in the [Payments NZ API Centre standards](https://paymentsnz.atlassian.net/wiki/spaces/PaymentsNZAPIStandards/overview). This SDK is generat
373 lines (372 loc) • 13.6 kB
TypeScript
/**
* Account information PNZ-API-CentreLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import { AC1010Retrievebulktransactions } from '../models/aC1010Retrievebulktransactions';
import { AC101Retrieveconsentedaccountsinformation } from '../models/aC101Retrieveconsentedaccountsinformation';
import { AC102Retrievebulkbalances } from '../models/aC102Retrievebulkbalances';
import { AC103Retrievebulkbeneficiaries } from '../models/aC103Retrievebulkbeneficiaries';
import { AC104Retrievebulkdirectdebits } from '../models/aC104Retrievebulkdirectdebits';
import { AC105Retrievebulkoffers } from '../models/aC105Retrievebulkoffers';
import { AC106Retrieveauthorisingparty } from '../models/aC106Retrieveauthorisingparty';
import { AC107Retrievebulkscheduledpayments } from '../models/aC107Retrievebulkscheduledpayments';
import { AC108Retrievebulkstandingorders } from '../models/aC108Retrievebulkstandingorders';
import { AC109Retrievebulkstatements } from '../models/aC109Retrievebulkstatements';
import { BaseController } from './baseController';
export declare class BulkEndpointsController extends BaseController {
/**
* This request queries the accounts which the customer consented for you to access in Step HF-AC7 -
* Post consented accounts array to complete consent or Step DF-AC4 - Authorise consent.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of account resources.
* * The balance of the accounts is dynamic so the balance returned may vary.
*
*
* Postconditions:
*
* * The AccountId for the first account in the collection is saved in the PNZ-T-AC-AccountId
* environment variable in preparation for subsequent account-related steps, such as Step AC11.1 -
* Retrieve a specific account
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an invalid or expired access token. Try starting from Step
* AC1 - Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveConsentedAccountsInformation(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC101Retrieveconsentedaccountsinformation>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of balance resources for all accounts which the Customer
* consented for you to access.
* * The balance of the accounts is dynamic so the balance returned may vary.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkBalances(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC102Retrievebulkbalances>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of beneficiary resources for all accounts which the Customer
* consented for you to access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkBeneficiaries(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC103Retrievebulkbeneficiaries>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of direct debit resources for all accounts which the
* Customer consented for you to access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkDirectDebits(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC104Retrievebulkdirectdebits>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of offer resources for all accounts which the Customer
* consented for you to access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkOffers(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC105Retrievebulkoffers>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a party resource for the party who authorised your access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveAuthorisingParty(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC106Retrieveauthorisingparty>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of scheduled payment resources for all accounts which the
* Customer consented for you to access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkScheduledPayments(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC107Retrievebulkscheduledpayments>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of standing order resources for all accounts which the
* Customer consented for you to access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkStandingOrders(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC108Retrievebulkstandingorders>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of statement resources for all accounts which the Customer
* consented for you to access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkStatements(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC109Retrievebulkstatements>>;
/**
* This request queries the accounts which the Customer has consented for you to access.
*
* Preconditions:
*
* * This step relies on the presence of a PNZ-T-AC-AuthAccessToken, which is set upon successful
* completion of Step HF-AC8 - Exchange authorization-code for access token or Step DF-AC5 - Exchange
* auth_req_id for access token.
*
*
* Response:
*
* * The response should be a collection of transaction resources for all accounts which the Customer
* consented for you to access.
*
*
* Postconditions:
*
* * None
*
*
* Examples:
*
* * There is one example which shows the request and the expected response.
*
*
* Troubleshooting:
*
* * The most likely cause of errors is an expired access token. Try starting from Step AC1 -
* Initiate client credentials grant again.
*
* @param authorization
* @return Response from the API call
*/
retrieveBulkTransactions(authorization: string, requestOptions?: RequestOptions): Promise<ApiResponse<AC1010Retrievebulktransactions>>;
}