@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Payment Initiation API
@base /open-banking/v4.0/pisp
@version 4.0.0
@auth OAuth2 | OAuth2
@common_fields {Authorization: str, x-fapi-auth-date: str, x-fapi-customer-ip-address: str, x-fapi-interaction-id: str, x-customer-user-agent: str}
@endpoints 41
@hint download_for_search
@toc domestic-payment-consents(3), domestic-payments(3), domestic-scheduled-payment-consents(2), domestic-scheduled-payments(3), domestic-standing-order-consents(2), domestic-standing-orders(3), file-payment-consents(4), file-payments(4), international-payment-consents(3), international-payments(3), international-scheduled-payment-consents(3), international-scheduled-payments(3), international-standing-order-consents(2), international-standing-orders(3)

@group domestic-payment-consents
@endpoint POST /domestic-payment-consents
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ReadRefundAccount: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification!: str, LocalInstrument: str, InstructedAmount!: map, DebtorAccount: map, CreditorAgent: map, CreditorAccount!: map, CreditorPostalAddress: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], RemittanceInformation: map, SupplementaryData: map}, Authorisation: map{AuthorisationType!: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 405, 406, 415, 429, 500}

@endpoint GET /domestic-payment-consents/{ConsentId}
@required {ConsentId: str}
@returns(200) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 405, 406, 429, 500}

@endpoint GET /domestic-payment-consents/{ConsentId}/funds-confirmation
@required {ConsentId: str}
@returns(200) {Data: map{FundsAvailableResult: map{FundsAvailableDateTime: str(date-time), FundsAvailable: bool}, SupplementaryData: map}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 405, 406, 429, 500}

@endgroup

@group domestic-payments
@endpoint POST /domestic-payments
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ConsentId!: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification!: str, LocalInstrument: str, InstructedAmount!: map, DebtorAccount: map, CreditorAgent: map, CreditorAccount!: map, CreditorPostalAddress: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], RemittanceInformation: map, SupplementaryData: map}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{DomesticPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 405, 406, 409, 415, 429, 500}

@endpoint GET /domestic-payments/{DomesticPaymentId}
@required {DomesticPaymentId: str}
@returns(200) {Data: map{DomesticPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 405, 406, 429, 500}

@endpoint GET /domestic-payments/{DomesticPaymentId}/payment-details
@required {DomesticPaymentId: str}
@returns(200) {Data: map{PaymentStatus: [map]}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group domestic-scheduled-payment-consents
@endpoint POST /domestic-scheduled-payment-consents
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{Permission!: str, ReadRefundAccount: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification: str, LocalInstrument: str, RequestedExecutionDateTime!: str(date-time), InstructedAmount!: map, DebtorAccount: map, CreditorAccount!: map, CreditorPostalAddress: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], RemittanceInformation: map, SupplementaryData: map}, Authorisation: map{AuthorisationType!: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, RequestedExecutionDateTime: str(date-time), InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /domestic-scheduled-payment-consents/{ConsentId}
@required {ConsentId: str}
@returns(200) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, RequestedExecutionDateTime: str(date-time), InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group domestic-scheduled-payments
@endpoint POST /domestic-scheduled-payments
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ConsentId!: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification: str, LocalInstrument: str, RequestedExecutionDateTime!: str(date-time), InstructedAmount!: map, DebtorAccount: map, CreditorAccount!: map, RegulatoryReporting: [map], CreditorPostalAddress: map, UltimateCreditor: map, UltimateDebtor: map, RemittanceInformation: map, SupplementaryData: map}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{DomesticScheduledPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, RequestedExecutionDateTime: str(date-time), InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}
@required {DomesticScheduledPaymentId: str}
@returns(200) {Data: map{DomesticScheduledPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, RequestedExecutionDateTime: str(date-time), InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorPostalAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
@required {DomesticScheduledPaymentId: str}
@returns(200) {Data: map{PaymentStatus: [map]}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group domestic-standing-order-consents
@endpoint POST /domestic-standing-order-consents
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{Permission!: str, ReadRefundAccount: str, Initiation!: map{RemittanceInformation: map, NumberOfPayments: str, FirstPaymentAmount!: map, RecurringPaymentAmount: map, FinalPaymentAmount: map, DebtorAccount: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], MandateRelatedInformation!: map, SupplementaryData: map}, Authorisation: map{AuthorisationType!: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, FirstPaymentAmount: map{Amount: str, Currency: str}, RecurringPaymentAmount: map{Amount: str, Currency: str}, FinalPaymentAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /domestic-standing-order-consents/{ConsentId}
@required {ConsentId: str}
@returns(200) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, FirstPaymentAmount: map{Amount: str, Currency: str}, RecurringPaymentAmount: map{Amount: str, Currency: str}, FinalPaymentAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group domestic-standing-orders
@endpoint POST /domestic-standing-orders
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ConsentId!: str, Initiation!: map{RemittanceInformation: map, NumberOfPayments: str, FirstPaymentAmount!: map, RecurringPaymentAmount: map, FinalPaymentAmount: map, DebtorAccount: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], MandateRelatedInformation!: map, SupplementaryData: map}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{DomesticStandingOrderId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Refund: map{Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, FirstPaymentAmount: map{Amount: str, Currency: str}, RecurringPaymentAmount: map{Amount: str, Currency: str}, FinalPaymentAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /domestic-standing-orders/{DomesticStandingOrderId}
@required {DomesticStandingOrderId: str}
@returns(200) {Data: map{DomesticStandingOrderId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Refund: map{Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, FirstPaymentAmount: map{Amount: str, Currency: str}, RecurringPaymentAmount: map{Amount: str, Currency: str}, FinalPaymentAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details
@required {DomesticStandingOrderId: str}
@returns(200) {Data: map{PaymentStatus: [map]}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group file-payment-consents
@endpoint POST /file-payment-consents
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{Initiation!: map{FileType!: str, FileHash!: str, FileReference: str, NumberOfTransactions: str, ControlSum: num, RequestedExecutionDateTime: str(date-time), LocalInstrument: str, CreditorAgent: map, DebtorAccount: map, UltimateDebtor: map, RemittanceInformation: map, SupplementaryData: map}, Authorisation: map{AuthorisationType!: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}}}
@returns(201) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), CutOffDateTime: str(date-time), Charges: [map], Initiation: map{FileType: str, FileHash: str, FileReference: str, NumberOfTransactions: str, ControlSum: num, RequestedExecutionDateTime: str(date-time), LocalInstrument: str, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /file-payment-consents/{ConsentId}
@required {ConsentId: str}
@returns(200) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), CutOffDateTime: str(date-time), Charges: [map], Initiation: map{FileType: str, FileHash: str, FileReference: str, NumberOfTransactions: str, ControlSum: num, RequestedExecutionDateTime: str(date-time), LocalInstrument: str, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint POST /file-payment-consents/{ConsentId}/file
@required {ConsentId: str, x-idempotency-key: str, x-jws-signature: str}
@returns(200)
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /file-payment-consents/{ConsentId}/file
@required {ConsentId: str}
@returns(200)
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group file-payments
@endpoint POST /file-payments
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ConsentId!: str, Initiation!: map{FileType!: str, FileHash!: str, FileReference: str, NumberOfTransactions: str, ControlSum: num, RequestedExecutionDateTime: str(date-time), LocalInstrument: str, CreditorAgent: map, DebtorAccount: map, UltimateDebtor: map, RemittanceInformation: map, SupplementaryData: map}}}
@returns(201) {Data: map{FilePaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Charges: [map], Initiation: map{FileType: str, FileHash: str, FileReference: str, NumberOfTransactions: str, ControlSum: num, RequestedExecutionDateTime: str(date-time), LocalInstrument: str, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /file-payments/{FilePaymentId}
@required {FilePaymentId: str}
@returns(200) {Data: map{FilePaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Charges: [map], Initiation: map{FileType: str, FileHash: str, FileReference: str, NumberOfTransactions: str, ControlSum: num, RequestedExecutionDateTime: str(date-time), LocalInstrument: str, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /file-payments/{FilePaymentId}/payment-details
@required {FilePaymentId: str}
@returns(200) {Data: map{PaymentStatus: [map]}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /file-payments/{FilePaymentId}/report-file
@required {FilePaymentId: str}
@returns(200)
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group international-payment-consents
@endpoint POST /international-payment-consents
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ReadRefundAccount: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification!: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer!: str, DestinationCountryCode: str, InstructedAmount!: map, ExchangeRateInformation: map, DebtorAccount: map, Creditor: map, CreditorAgent: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], RemittanceInformation: map, SupplementaryData: map}, Authorisation: map{AuthorisationType!: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /international-payment-consents/{ConsentId}
@required {ConsentId: str}
@returns(200) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /international-payment-consents/{ConsentId}/funds-confirmation
@required {ConsentId: str}
@returns(200) {Data: map{FundsAvailableResult: map{FundsAvailableDateTime: str(date-time), FundsAvailable: bool}, SupplementaryData: map}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group international-payments
@endpoint POST /international-payments
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ConsentId!: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification!: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer!: str, DestinationCountryCode: str, InstructedAmount!: map, ExchangeRateInformation: map, DebtorAccount: map, Creditor: map, CreditorAgent: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], RemittanceInformation: map, SupplementaryData: map}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{InternationalPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Creditor: map{Name: str, LEI: str, PostalAddress: map}, Agent: map{SchemeName: str, Identification: str, Name: str, PostalAddress: map}, Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}}, Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 415, 429, 500}

@endpoint GET /international-payments/{InternationalPaymentId}
@required {InternationalPaymentId: str}
@returns(200) {Data: map{InternationalPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Creditor: map{Name: str, LEI: str, PostalAddress: map}, Agent: map{SchemeName: str, Identification: str, Name: str, PostalAddress: map}, Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}}, Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /international-payments/{InternationalPaymentId}/payment-details
@required {InternationalPaymentId: str}
@returns(200) {Data: map{PaymentStatus: [map]}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group international-scheduled-payment-consents
@endpoint POST /international-scheduled-payment-consents
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{Permission!: str, ReadRefundAccount: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, RequestedExecutionDateTime!: str(date-time), CurrencyOfTransfer!: str, DestinationCountryCode: str, InstructedAmount!: map, ExchangeRateInformation: map, DebtorAccount: map, Creditor: map, CreditorAgent: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], RemittanceInformation: map, SupplementaryData: map}, Authorisation: map{AuthorisationType!: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, RequestedExecutionDateTime: str(date-time), CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, LEI: str, Name: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /international-scheduled-payment-consents/{ConsentId}
@required {ConsentId: str}
@returns(200) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, RequestedExecutionDateTime: str(date-time), CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, LEI: str, Name: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation
@required {ConsentId: str}
@returns(200) {Data: map{FundsAvailableResult: map{FundsAvailableDateTime: str(date-time), FundsAvailable: bool}, SupplementaryData: map}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group international-scheduled-payments
@endpoint POST /international-scheduled-payments
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ConsentId!: str, Initiation!: map{InstructionIdentification!: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, RequestedExecutionDateTime!: str(date-time), CurrencyOfTransfer!: str, DestinationCountryCode: str, InstructedAmount!: map, ExchangeRateInformation: map, DebtorAccount: map, Creditor: map, CreditorAgent: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], RemittanceInformation: map, SupplementaryData: map}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{InternationalScheduledPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Creditor: map{Name: str, LEI: str, PostalAddress: map}, Agent: map{SchemeName: str, Identification: str, Name: str, PostalAddress: map}, Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, RequestedExecutionDateTime: str(date-time), CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, LEI: str, Name: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /international-scheduled-payments/{InternationalScheduledPaymentId}
@required {InternationalScheduledPaymentId: str}
@returns(200) {Data: map{InternationalScheduledPaymentId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], ExpectedExecutionDateTime: str(date-time), ExpectedSettlementDateTime: str(date-time), Refund: map{Creditor: map{Name: str, LEI: str, PostalAddress: map}, Agent: map{SchemeName: str, Identification: str, Name: str, PostalAddress: map}, Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str, ExpirationDateTime: str(date-time)}, Initiation: map{InstructionIdentification: str, EndToEndIdentification: str, LocalInstrument: str, InstructionPriority: str, ExtendedPurpose: str, ChargeBearer: str, RequestedExecutionDateTime: str(date-time), CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, ExchangeRateInformation: map{UnitCurrency: str, ExchangeRate: num, RateType: str, ContractIdentification: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, LEI: str, Name: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], RemittanceInformation: map{Structured: [map], Unstructured: [str]}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
@required {InternationalScheduledPaymentId: str}
@returns(200) {Data: map{PaymentStatus: [map]}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group international-standing-order-consents
@endpoint POST /international-standing-order-consents
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{Permission!: str, ReadRefundAccount: str, Initiation!: map{RemittanceInformation: map, NumberOfPayments: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer!: str, DestinationCountryCode: str, InstructedAmount!: map, DebtorAccount: map, Creditor: map, CreditorAgent: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], MandateRelatedInformation!: map, SupplementaryData: map}, Authorisation: map{AuthorisationType!: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /international-standing-order-consents/{ConsentId}
@required {ConsentId: str}
@returns(200) {Data: map{ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusReason: [map], StatusUpdateDateTime: str(date-time), Permission: str, ReadRefundAccount: str, CutOffDateTime: str(date-time), Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, Authorisation: map{AuthorisationType: str, CompletionDateTime: str(date-time)}, SCASupportData: map{RequestedSCAExemptionType: str, AppliedAuthenticationApproach: str, ReferencePaymentOrderId: str}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@group international-standing-orders
@endpoint POST /international-standing-orders
@required {x-idempotency-key: str, x-jws-signature: str, Data: map{ConsentId!: str, Initiation!: map{RemittanceInformation: map, NumberOfPayments: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer!: str, DestinationCountryCode: str, InstructedAmount!: map, DebtorAccount: map, Creditor: map, CreditorAgent: map, CreditorAccount!: map, UltimateCreditor: map, UltimateDebtor: map, RegulatoryReporting: [map], MandateRelatedInformation!: map, SupplementaryData: map}}, Risk: map{PaymentContextCode: str, MerchantCategoryCode: str, MerchantCustomerIdentification: str, ContractPresentIndicator: bool, BeneficiaryPrepopulatedIndicator: bool, PaymentPurposeCode: str, CategoryPurposeCode: str, BeneficiaryAccountType: str, DeliveryAddress: map{AddressType: str, Department: str, SubDepartment: str, StreetName: str, BuildingNumber: str, BuildingName: str, Floor: str, UnitNumber: str, Room: str, PostBox: str, TownLocationName: str, DistrictName: str, CareOf: str, PostCode: str, TownName: str, CountrySubDivision: str, Country: str, AddressLine: [str]}}}
@returns(201) {Data: map{InternationalStandingOrderId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Refund: map{Creditor: map{Name: str, LEI: str, PostalAddress: map}, Agent: map{SchemeName: str, Identification: str, Name: str, PostalAddress: map}, Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 409, 415, 429, 500}

@endpoint GET /international-standing-orders/{InternationalStandingOrderPaymentId}
@required {InternationalStandingOrderPaymentId: str}
@returns(200) {Data: map{InternationalStandingOrderId: str, ConsentId: str, CreationDateTime: str(date-time), Status: str, StatusUpdateDateTime: str(date-time), StatusReason: [map], Refund: map{Creditor: map{Name: str, LEI: str, PostalAddress: map}, Agent: map{SchemeName: str, Identification: str, Name: str, PostalAddress: map}, Account: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str}}, Charges: [map], Initiation: map{RemittanceInformation: map{Structured: [map], Unstructured: [str]}, NumberOfPayments: str, ExtendedPurpose: str, ChargeBearer: str, CurrencyOfTransfer: str, DestinationCountryCode: str, InstructedAmount: map{Amount: str, Currency: str}, DebtorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, Creditor: map{Name: str, LEI: str, PostalAddress: map}, CreditorAgent: map{SchemeName: str, Identification: str, Name: str, LEI: str, PostalAddress: map}, CreditorAccount: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, Proxy: map}, UltimateCreditor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, UltimateDebtor: map{Name: str, Identification: str, LEI: str, SchemeName: str, PostalAddress: map}, RegulatoryReporting: [map], MandateRelatedInformation: map{MandateIdentification: str, Classification: str, CategoryPurposeCode: str, FirstPaymentDateTime: str(date-time), RecurringPaymentDateTime: str(date-time), FinalPaymentDateTime: str(date-time), Frequency: map, Reason: str}, SupplementaryData: map}, MultiAuthorisation: map{Status: str, NumberRequired: int, NumberReceived: int, LastUpdateDateTime: str(date-time), ExpirationDateTime: str(date-time)}, Debtor: map{SchemeName: str, Identification: str, Name: str, SecondaryIdentification: str, LEI: str}}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endpoint GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
@required {InternationalStandingOrderPaymentId: str}
@returns(200) {Data: map{PaymentStatus: [map]}, Links: map{Self: str(uri), First: str(uri), Prev: str(uri), Next: str(uri), Last: str(uri)}, Meta: map{TotalPages: int(int32), FirstAvailableDateTime: str(date-time), LastAvailableDateTime: str(date-time)}}
@errors {400, 401, 403, 404, 405, 406, 429, 500}

@endgroup

@end