action nbg_get_accounts_account_id_scheduled_payments { label: "Get Scheduled Payments" description: "Get Scheduled Payments by Account ID" provider: nbg method: GET path: "/accounts/{accountId}/scheduled-payments" encoding: json input: { type: "object" properties: { accountId: { type: "string" description: "AccountId" } "sandbox-id": { type: "string" } "x-customer-user-agent": { type: "string" } "x-fapi-auth-date": { type: "string" } "x-fapi-customer-ip-address": { type: "string" } "x-fapi-interaction-id": { type: "string" } } required: ["accountId", "sandbox-id"] additionalProperties: false } output: { type: "object" required: ["Data"] properties: { Data: { type: "object" properties: { ScheduledPayment: { type: "array" items: { type: "object" required: ["AccountId", "InstructedAmount", "ScheduledPaymentDateTime", "ScheduledType"] properties: { AccountId: { type: "string" description: "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner." } CreditorAccount: { type: "object" required: ["Identification", "SchemeName"] properties: { Identification: { type: "string" description: "Identification assigned by an institution to identify an account. This identification is known by the account owner." } Name: { type: "string" description: "The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. \nNote, the account name is not the product name or the nickname of the account." } SchemeName: { type: "string" description: "Name of the identification scheme, in a coded form as published in an external list." } SecondaryIdentification: { type: "string" description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number(in addition to a sort code and account number combination)." } } additionalProperties: false } DebtorReference: { type: "string" description: "A reference value provided by the PSU to the PISP while setting up the scheduled payment." } InstructedAmount: { type: "object" required: ["Amount", "Currency"] properties: { Amount: { type: "string" description: "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." } Currency: { type: "string" description: "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"." } } additionalProperties: false } Reference: { type: "string" description: "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. \nUsage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. \nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification." } ScheduledPaymentDateTime: { type: "string" format: "date-time" description: "The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.An example is below: \n2017-04-05T10:43:07+00:00" } ScheduledPaymentId: { type: "string" description: "A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner." } ScheduledType: { type: "string" enum: ["Arrival", "Execution"] } } additionalProperties: false } } } additionalProperties: false } Links: { type: "object" description: "Links relevant to the payload" required: ["Self"] properties: { First: { type: "string" } Last: { type: "string" } Next: { type: "string" } Prev: { type: "string" } Self: { type: "string" } } additionalProperties: false } Meta: { type: "object" description: "Meta Data relevant to the payload" properties: { FirstAvailableDateTime: { type: "string" description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.An example is below: \n2017-04-05T10:43:07+00:00" } LastAvailableDateTime: { type: "string" description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.An example is below: \n2017-04-05T10:43:07+00:00" } TotalPages: { type: "integer" format: "int32" } } additionalProperties: false } } additionalProperties: false } }