pnz-payments-sdk
Version:
PNZ Payments Account and Transaction API
78 lines (77 loc) • 4.13 kB
TypeScript
/**
* Account and Transaction API SpecificationLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema';
import { CreditorAccount } from './creditorAccount';
import { CreditorAgent } from './creditorAgent';
import { FinalPaymentAmount } from './finalPaymentAmount';
import { FirstPaymentAmount } from './firstPaymentAmount';
import { NextPaymentAmount } from './nextPaymentAmount';
import { Reference } from './reference';
import { StandingOrderStatusCodeEnum } from './standingOrderStatusCodeEnum';
export interface StandingOrderModel {
/** A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. */
accountId: string;
/** A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner. */
standingOrderId?: string;
/**
* EvryDay - Every day
* EvryWorkgDay - Every working day
* IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)
* WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)
* IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)
* Patterns:
* EvryDay (ScheduleCode)
* EvryWorkgDay (ScheduleCode)
* IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)
* WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)
* IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)
* The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:
* EvryDay
* EvryWorkgDay
* IntrvlWkDay:0[1-9]:0[1-7]
* WkInMnthDay:0[1-5]:0[1-7]
* IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])
*/
frequency: string;
reference?: Reference;
/**
* The date on which the first payment for a Standing Order schedule will be made.
* All dates in the JSON payloads are represented in ISO 8601 date-time format.
* All date-time fields in responses must include the timezone. An example is below:
* 2017-04-05T10:43:07+00:00
*/
firstPaymentDateTime?: string;
/** The amount of the first Standing Order */
firstPaymentAmount?: FirstPaymentAmount;
/**
* The date on which the next payment for a Standing Order schedule will be made.
* All dates in the JSON payloads are represented in ISO 8601 date-time format.
* All date-time fields in responses must include the timezone. An example is below:
* 2017-04-05T10:43:07+00:00
*/
nextPaymentDateTime: string;
/** The amount of the next Standing Order */
nextPaymentAmount: NextPaymentAmount;
/**
* The date on which the final payment for a Standing Order schedule will be made.
* All dates in the JSON payloads are represented in ISO 8601 date-time format.
* All date-time fields in responses must include the timezone. An example is below:
* 2017-04-05T10:43:07+00:00
*/
finalPaymentDateTime?: string;
/** The amount of the final Standing Order */
finalPaymentAmount?: FinalPaymentAmount;
/** Specifies the status of the standing order in code form. */
standingOrderStatusCode?: StandingOrderStatusCodeEnum;
/**
* Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.
* This is the servicer of the beneficiary account.
*/
creditorAgent?: CreditorAgent;
/** Unambiguous identification of the account of the creditor, in the case of a debit transaction. */
creditorAccount?: CreditorAccount;
}
export declare const standingOrderModelSchema: Schema<StandingOrderModel>;