{"files":{"SKILL.md":"---\nname: payment-initiation-api\ndescription: \"Payment Initiation API skill. Use when working with Payment Initiation for domestic-payment-consents, domestic-payments, domestic-scheduled-payment-consents. Covers 41 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Payment Initiation API\nAPI version: 4.0.0\n\n## Auth\nOAuth2 | OAuth2\n\n## Base URL\n/open-banking/v4.0/pisp\n\n## Setup\n1. Configure auth: OAuth2 | OAuth2\n2. GET /domestic-payment-consents/{ConsentId}/funds-confirmation -- verify access\n3. POST /domestic-payment-consents -- create first domestic-payment-consents\n\n## Endpoints\n\n41 endpoints across 14 groups. See references/api-spec.lap for full details.\n\n### domestic-payment-consents\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /domestic-payment-consents | Create Domestic Payment Consents |\n| GET | /domestic-payment-consents/{ConsentId} | Get Domestic Payment Consents |\n| GET | /domestic-payment-consents/{ConsentId}/funds-confirmation | Get Domestic Payment Consents Funds Confirmation |\n\n### domestic-payments\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /domestic-payments | Create Domestic Payments |\n| GET | /domestic-payments/{DomesticPaymentId} | Get Domestic Payments |\n| GET | /domestic-payments/{DomesticPaymentId}/payment-details | Get Payment Details |\n\n### domestic-scheduled-payment-consents\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /domestic-scheduled-payment-consents | Create Domestic Scheduled Payment Consents |\n| GET | /domestic-scheduled-payment-consents/{ConsentId} | Get Domestic Scheduled Payment Consents |\n\n### domestic-scheduled-payments\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /domestic-scheduled-payments | Create Domestic Scheduled Payments |\n| GET | /domestic-scheduled-payments/{DomesticScheduledPaymentId} | Get Domestic Scheduled Payments |\n| GET | /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details | Get Payment Details |\n\n### domestic-standing-order-consents\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /domestic-standing-order-consents | Create Domestic Standing Order Consents |\n| GET | /domestic-standing-order-consents/{ConsentId} | Get Domestic Standing Order Consents |\n\n### domestic-standing-orders\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /domestic-standing-orders | Create Domestic Standing Orders |\n| GET | /domestic-standing-orders/{DomesticStandingOrderId} | Get Domestic Standing Orders |\n| GET | /domestic-standing-orders/{DomesticStandingOrderId}/payment-details | Get Payment Details |\n\n### file-payment-consents\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /file-payment-consents | Create File Payment Consents |\n| GET | /file-payment-consents/{ConsentId} | Get File Payment Consents |\n| POST | /file-payment-consents/{ConsentId}/file | Create File Payment Consents |\n| GET | /file-payment-consents/{ConsentId}/file | Get File Payment Consents |\n\n### file-payments\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /file-payments | Create File Payments |\n| GET | /file-payments/{FilePaymentId} | Get File Payments |\n| GET | /file-payments/{FilePaymentId}/payment-details | Get Payment Details |\n| GET | /file-payments/{FilePaymentId}/report-file | Get File Payments |\n\n### international-payment-consents\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /international-payment-consents | Create International Payment Consents |\n| GET | /international-payment-consents/{ConsentId} | Get International Payment Consents |\n| GET | /international-payment-consents/{ConsentId}/funds-confirmation | Get International Payment Consents Funds Confirmation |\n\n### international-payments\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /international-payments | Create International Payments |\n| GET | /international-payments/{InternationalPaymentId} | Get International Payments |\n| GET | /international-payments/{InternationalPaymentId}/payment-details | Get Payment Details |\n\n### international-scheduled-payment-consents\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /international-scheduled-payment-consents | Create International Scheduled Payment Consents |\n| GET | /international-scheduled-payment-consents/{ConsentId} | Get International Scheduled Payment Consents |\n| GET | /international-scheduled-payment-consents/{ConsentId}/funds-confirmation | Get International Scheduled Payment Consents Funds Confirmation |\n\n### international-scheduled-payments\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /international-scheduled-payments | Create International Scheduled Payments |\n| GET | /international-scheduled-payments/{InternationalScheduledPaymentId} | Get International Scheduled Payments |\n| GET | /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details | Get Payment Details |\n\n### international-standing-order-consents\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /international-standing-order-consents | Create International Standing Order Consents |\n| GET | /international-standing-order-consents/{ConsentId} | Get International Standing Order Consents |\n\n### international-standing-orders\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /international-standing-orders | Create International Standing Orders |\n| GET | /international-standing-orders/{InternationalStandingOrderPaymentId} | Get International Standing Orders |\n| GET | /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details | Get Payment Details |\n\n## Common Questions\n\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Create a domestic-payment-consent?\" -> POST /domestic-payment-consents\n- \"Get domestic-payment-consent details?\" -> GET /domestic-payment-consents/{ConsentId}\n- \"List all funds-confirmation?\" -> GET /domestic-payment-consents/{ConsentId}/funds-confirmation\n- \"Create a domestic-payment?\" -> POST /domestic-payments\n- \"Get domestic-payment details?\" -> GET /domestic-payments/{DomesticPaymentId}\n- \"List all payment-details?\" -> GET /domestic-payments/{DomesticPaymentId}/payment-details\n- \"Create a domestic-scheduled-payment-consent?\" -> POST /domestic-scheduled-payment-consents\n- \"Get domestic-scheduled-payment-consent details?\" -> GET /domestic-scheduled-payment-consents/{ConsentId}\n- \"Create a domestic-scheduled-payment?\" -> POST /domestic-scheduled-payments\n- \"Get domestic-scheduled-payment details?\" -> GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}\n- \"List all payment-details?\" -> GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details\n- \"Create a domestic-standing-order-consent?\" -> POST /domestic-standing-order-consents\n- \"Get domestic-standing-order-consent details?\" -> GET /domestic-standing-order-consents/{ConsentId}\n- \"Create a domestic-standing-order?\" -> POST /domestic-standing-orders\n- \"Get domestic-standing-order details?\" -> GET /domestic-standing-orders/{DomesticStandingOrderId}\n- \"List all payment-details?\" -> GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details\n- \"Create a file-payment-consent?\" -> POST /file-payment-consents\n- \"Get file-payment-consent details?\" -> GET /file-payment-consents/{ConsentId}\n- \"Create a file?\" -> POST /file-payment-consents/{ConsentId}/file\n- \"List all file?\" -> GET /file-payment-consents/{ConsentId}/file\n- \"Create a file-payment?\" -> POST /file-payments\n- \"Get file-payment details?\" -> GET /file-payments/{FilePaymentId}\n- \"List all payment-details?\" -> GET /file-payments/{FilePaymentId}/payment-details\n- \"List all report-file?\" -> GET /file-payments/{FilePaymentId}/report-file\n- \"Create a international-payment-consent?\" -> POST /international-payment-consents\n- \"Get international-payment-consent details?\" -> GET /international-payment-consents/{ConsentId}\n- \"List all funds-confirmation?\" -> GET /international-payment-consents/{ConsentId}/funds-confirmation\n- \"Create a international-payment?\" -> POST /international-payments\n- \"Get international-payment details?\" -> GET /international-payments/{InternationalPaymentId}\n- \"List all payment-details?\" -> GET /international-payments/{InternationalPaymentId}/payment-details\n- \"Create a international-scheduled-payment-consent?\" -> POST /international-scheduled-payment-consents\n- \"Get international-scheduled-payment-consent details?\" -> GET /international-scheduled-payment-consents/{ConsentId}\n- \"List all funds-confirmation?\" -> GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation\n- \"Create a international-scheduled-payment?\" -> POST /international-scheduled-payments\n- \"Get international-scheduled-payment details?\" -> GET /international-scheduled-payments/{InternationalScheduledPaymentId}\n- \"List all payment-details?\" -> GET /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details\n- \"Create a international-standing-order-consent?\" -> POST /international-standing-order-consents\n- \"Get international-standing-order-consent details?\" -> GET /international-standing-order-consents/{ConsentId}\n- \"Create a international-standing-order?\" -> POST /international-standing-orders\n- \"Get international-standing-order details?\" -> GET /international-standing-orders/{InternationalStandingOrderPaymentId}\n- \"List all payment-details?\" -> GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details\n- \"How to authenticate?\" -> See Auth section\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints typically return the created/updated object\n\n## CLI\n\n```bash\n# Update this spec to the latest version\nnpx @lap-platform/lapsh get payment-initiation-api -o references/api-spec.lap\n\n# Search for related APIs\nnpx @lap-platform/lapsh search payment-initiation-api\n```\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Payment Initiation API\n@base /open-banking/v4.0/pisp\n@version 4.0.0\n@auth OAuth2 | OAuth2\n@common_fields {Authorization: str # An Authorisation Token as per https://tools.ietf.org/html/rfc6750, x-fapi-auth-date: str # The time when the PSU last logged in with the TPP.  All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:  Sun, 10 Sep 2017 19:43:31 UTC, x-fapi-customer-ip-address: str # The PSU's IP address if the PSU is currently logged in with the TPP., x-fapi-interaction-id: str # An RFC4122 UID used as a correlation id., x-customer-user-agent: str # Indicates the user-agent that the PSU is using.}\n@endpoints 41\n@hint download_for_search\n@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)\n\n@group domestic-payment-consents\n@endpoint POST /domestic-payment-consents\n@desc Create Domestic Payment Consents\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # Domestic Payment Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 405: Method Not Allowed, 406: Not Acceptable, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-payment-consents/{ConsentId}\n@desc Get Domestic Payment Consents\n@required {ConsentId: str # ConsentId}\n@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)}} # Domestic Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-payment-consents/{ConsentId}/funds-confirmation\n@desc Get Domestic Payment Consents Funds Confirmation\n@required {ConsentId: str # ConsentId}\n@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)}} # Domestic Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group domestic-payments\n@endpoint POST /domestic-payments\n@desc Create Domestic Payments\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # Domestic Payments Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-payments/{DomesticPaymentId}\n@desc Get Domestic Payments\n@required {DomesticPaymentId: str # DomesticPaymentId}\n@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)}} # Domestic Payments Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-payments/{DomesticPaymentId}/payment-details\n@desc Get Payment Details\n@required {DomesticPaymentId: str # DomesticPaymentId}\n@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)}} # Payment Details Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group domestic-scheduled-payment-consents\n@endpoint POST /domestic-scheduled-payment-consents\n@desc Create Domestic Scheduled Payment Consents\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # Domestic Scheduled Payment Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-scheduled-payment-consents/{ConsentId}\n@desc Get Domestic Scheduled Payment Consents\n@required {ConsentId: str # ConsentId}\n@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)}} # Domestic Scheduled Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group domestic-scheduled-payments\n@endpoint POST /domestic-scheduled-payments\n@desc Create Domestic Scheduled Payments\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # Domestic Scheduled Payments Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}\n@desc Get Domestic Scheduled Payments\n@required {DomesticScheduledPaymentId: str # DomesticScheduledPaymentId}\n@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)}} # Domestic Scheduled Payments Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details\n@desc Get Payment Details\n@required {DomesticScheduledPaymentId: str # DomesticScheduledPaymentId}\n@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)}} # Payment Details Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group domestic-standing-order-consents\n@endpoint POST /domestic-standing-order-consents\n@desc Create Domestic Standing Order Consents\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # Domestic Standing Order Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-standing-order-consents/{ConsentId}\n@desc Get Domestic Standing Order Consents\n@required {ConsentId: str # ConsentId}\n@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)}} # Domestic Standing Order Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group domestic-standing-orders\n@endpoint POST /domestic-standing-orders\n@desc Create Domestic Standing Orders\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # Domestic Standing Orders Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-standing-orders/{DomesticStandingOrderId}\n@desc Get Domestic Standing Orders\n@required {DomesticStandingOrderId: str # DomesticStandingOrderId}\n@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)}} # Domestic Standing Orders Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details\n@desc Get Payment Details\n@required {DomesticStandingOrderId: str # DomesticStandingOrderId}\n@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)}} # Payment Details Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group file-payment-consents\n@endpoint POST /file-payment-consents\n@desc Create File Payment Consents\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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}}}\n@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)}} # File Payment Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /file-payment-consents/{ConsentId}\n@desc Get File Payment Consents\n@required {ConsentId: str # ConsentId}\n@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)}} # File Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint POST /file-payment-consents/{ConsentId}/file\n@desc Create File Payment Consents\n@required {ConsentId: str # ConsentId, x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload.}\n@returns(200) File Payment Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /file-payment-consents/{ConsentId}/file\n@desc Get File Payment Consents\n@required {ConsentId: str # ConsentId}\n@returns(200) File Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group file-payments\n@endpoint POST /file-payments\n@desc Create File Payments\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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}}}\n@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)}} # File Payments Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /file-payments/{FilePaymentId}\n@desc Get File Payments\n@required {FilePaymentId: str # FilePaymentId}\n@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)}} # File Payments Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /file-payments/{FilePaymentId}/payment-details\n@desc Get Payment Details\n@required {FilePaymentId: str # FilePaymentId}\n@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)}} # Payment Details Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /file-payments/{FilePaymentId}/report-file\n@desc Get File Payments\n@required {FilePaymentId: str # FilePaymentId}\n@returns(200) File Payments Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group international-payment-consents\n@endpoint POST /international-payment-consents\n@desc Create International Payment Consents\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # International Payment Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-payment-consents/{ConsentId}\n@desc Get International Payment Consents\n@required {ConsentId: str # ConsentId}\n@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)}} # International Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-payment-consents/{ConsentId}/funds-confirmation\n@desc Get International Payment Consents Funds Confirmation\n@required {ConsentId: str # ConsentId}\n@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)}} # International Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group international-payments\n@endpoint POST /international-payments\n@desc Create International Payments\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # International Payments Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-payments/{InternationalPaymentId}\n@desc Get International Payments\n@required {InternationalPaymentId: str # InternationalPaymentId}\n@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)}} # International Payments Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-payments/{InternationalPaymentId}/payment-details\n@desc Get Payment Details\n@required {InternationalPaymentId: str # InternationalPaymentId}\n@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)}} # Payment Details Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group international-scheduled-payment-consents\n@endpoint POST /international-scheduled-payment-consents\n@desc Create International Scheduled Payment Consents\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # International Scheduled Payment Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-scheduled-payment-consents/{ConsentId}\n@desc Get International Scheduled Payment Consents\n@required {ConsentId: str # ConsentId}\n@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)}} # International Scheduled Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation\n@desc Get International Scheduled Payment Consents Funds Confirmation\n@required {ConsentId: str # ConsentId}\n@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)}} # International Scheduled Payment Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group international-scheduled-payments\n@endpoint POST /international-scheduled-payments\n@desc Create International Scheduled Payments\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # International Scheduled Payments Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-scheduled-payments/{InternationalScheduledPaymentId}\n@desc Get International Scheduled Payments\n@required {InternationalScheduledPaymentId: str # InternationalScheduledPaymentId}\n@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)}} # International Scheduled Payments Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details\n@desc Get Payment Details\n@required {InternationalScheduledPaymentId: str # InternationalScheduledPaymentId}\n@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)}} # Payment Details Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group international-standing-order-consents\n@endpoint POST /international-standing-order-consents\n@desc Create International Standing Order Consents\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # International Standing Order Consents Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-standing-order-consents/{ConsentId}\n@desc Get International Standing Order Consents\n@required {ConsentId: str # ConsentId}\n@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)}} # International Standing Order Consents Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@group international-standing-orders\n@endpoint POST /international-standing-orders\n@desc Create International Standing Orders\n@required {x-idempotency-key: str # Every request will be processed only once per x-idempotency-key.  The Idempotency Key will be valid for 24 hours., x-jws-signature: str # A detached JWS signature of the body of the payload., 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]}} # The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.}\n@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)}} # International Standing Orders Created\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 409: Conflict, 415: Unsupported Media Type, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-standing-orders/{InternationalStandingOrderPaymentId}\n@desc Get International Standing Orders\n@required {InternationalStandingOrderPaymentId: str # InternationalStandingOrderPaymentId}\n@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)}} # International Standing Orders Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endpoint GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details\n@desc Get Payment Details\n@required {InternationalStandingOrderPaymentId: str # InternationalStandingOrderPaymentId}\n@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)}} # Payment Details Read\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 405: Method Not Allowed, 406: Not Acceptable, 429: Too Many Requests, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}}