> ## Documentation Index > Fetch the complete documentation index at: https://docs.yapily.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Bulk Payment Authorisation > Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a bulk payment. Feature: `INITIATE_BULK_PAYMENT` Learn more: [Bulk Payments](/payments/bulk-payments/overview) ## OpenAPI ````yaml /openapi-converted.json post /bulk-payment-auth-requests openapi: 3.0.1 info: description: >- The Yapily API enables connections between your application and users' banks. For more information check out our [documentation](/introduction). In particular, make sure to view our [Getting Started](/getting-started/get-started) steps if this is your first time here. While testing the API, our list of [sandbox credentials](/resources/sandbox/sandbox-credentials) maybe useful. title: Yapily API version: 12.3.4 contact: name: Yapily Support url: https://docs.yapily.com/resources/support email: support@yapily.com servers: - url: https://api.yapily.com security: - basicAuth: [] tags: - description: >- The `Application` is the base entity that is used to interact with the API and contains a collection of `Institution` objects. You can have multiple Applications associated with your account e.g. a production application with live access to each `Institution` and a development application with access to sandboxes. name: Application - description: >- The Users endpoints are used to manage each user (otherwise known as the PSU) in Yapily. Each user belongs to an Application and as a consequence, so do each `Consent` created for a particular `User`. name: Users - description: >- An `Institution` object represents any Account Serving Payment Servicing Provider (ASPSP) that has been integrated and is accessible through the Yapily APIs (ASPSPs are entities that publish Read/Write APIs to permit, with customer consent, payments initiated by third party providers and/or make their customers financial data available to third party providers via their API endpoints). Any one of the following would be represented as Institution: - Traditional banks e.g. Santander - Neo-banks e.g. Monzo - Building societies e.g. Cumberland Building Society name: Institutions - description: >- The Consents endpoints are used to manage each `Consent` created by Yapily in response to an authorisation created for a user. The `Consent` object contains data that identifies a user's consent for a specific `Institution` within a Yapily application. Other than the id of the consent, the `institution-id` for the corresponding `Institution` and the user identifiers (`user-uuid` and `application-user-id`), it contains various details that indicates how the `Consent` can be used. name: Consents - description: >- Before calling [Financial Data](#yapily-api-financial-data) or [Payments](#yapily-api-payments) endpoints, a consent from an end-user must be obtained. Consents are valid for up to 90 days for Financial Data endpoints and have a single-use for Payment endpoints i.e. a new consent must be obtained for each payment. NOTE: A user consent is also referred to as an 'Authorisation'. name: Authorisations - description: >- In order to access a user's Financial Data, you are required to request an [Authorisation](#tag/Authorisations) from the user to share the account information the bank has. Once a `consent-token` is obtained, you can call the necessary Financial Data endpoint(s) to retrieve the user's data. name: Financial Data - description: >- In order to make a Payment on behalf of a user, you are required to request an [Authorisation](#tag/Authorisations) from the user to authorise the user's account to make the payment from. Once a `consent-token` is obtained, you can call the necessary Payments endpoint(s) to execute a payment. name: Payments - description: >+ The Notifications endpoints provide an interactive way for user to receive notifications according to different event-types. This feature is currently in private beta. Please reach out if you require access. name: Notifications - description: >- Variable Recurring Payments enables transfer of money between accounts held by the same person or transfer of money for business payments. In order to make Sweeping Variable Recurring Payments on behalf of a user, you are required to request an [Consent](#tag/Authorisations) from the user by calling the Sweeping Consent endpoint to authorise the user's account to make the payment. Once a `consent-token` is obtained, you can call the Payments endpoint to execute the Sweeping Variable Recurring Payments transaction. Before executing the payment, you have the option to confirm availability of funds in the user's account by calling the Funds Confirmation endpoint. See [VRP Payments](/payments/vrps/additional-information) for more information. name: Variable Recurring Payments - description: Hosted Payment Pages endpoints for payments products name: Hosted Payment Pages - description: Hosted Consent Pages endpoints for data products name: Hosted Consent Pages - description: >- The constraints endpoints can be used to retrieve institution specific data requirements and rules that will apply when performing other operations. name: Constraints - description: >- Application Management endpoints help with creating and managing client sub-applications. name: Application Management - description: 'Data Plus endpoints enable our customers to enrich transaction data. ' name: Data Plus - description: Webhook endpoints name: Webhooks - description: Application Beneficiaries Endpoints name: Application Beneficiaries - description: User Beneficiaries Endpoints name: User Beneficiaries paths: /bulk-payment-auth-requests: post: tags: - Authorisations summary: Create Bulk Payment Authorisation description: >- Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a bulk payment. Feature: `INITIATE_BULK_PAYMENT` operationId: createBulkPaymentAuthorisation parameters: - description: >- __Conditional__. Represents the user's login ID for the `Institution` to a personal account. See [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required. in: header name: psu-id required: false schema: type: string - description: >- __Conditional__. Represents the user's login ID for the `Institution` to a business account. See [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required. in: header name: psu-corporate-id required: false schema: type: string - description: >- __Conditional__. The IP address of the PSU. See [PSU identifiers](/open-banking-flow/user-authorisation/psu-identifiers) to see if this header is required. in: header name: psu-ip-address required: false schema: type: string requestBody: content: application/json;charset=UTF-8: examples: UK Bulk Payment Example Request: $ref: '#/components/examples/uk-bulk-payment-auth-example-request' schema: $ref: '#/components/schemas/BulkPaymentAuthorisationRequest' required: true responses: '201': content: application/json;charset=UTF-8: examples: UK Bulk Payment Example Response: $ref: '#/components/examples/uk-bulk-payment-auth-example-response' schema: $ref: >- #/components/schemas/ApiResponseOfPaymentAuthorisationRequestResponse description: Created default: content: application/json;charset=UTF-8: examples: Error Response: $ref: '#/components/examples/error-response-code-401' schema: $ref: '#/components/schemas/ApiResponseError' description: Error Response components: examples: uk-bulk-payment-auth-example-request: description: UK Bulk Payment Example Request value: applicationUserId: string institutionId: modelo-sandbox callback: https://display-parameters.com/ paymentRequest: payments: - type: DOMESTIC_PAYMENT paymentIdempotencyId: d78fy48uh8f9odhde68dfi38di9 reference: payment1 contextType: BILL_IN_ARREARS purposeCode: COMT amount: amount: 2 currency: GBP payee: name: Jane Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '123456' accountType: BUSINESS_SAVING - type: DOMESTIC_PAYMENT paymentIdempotencyId: 4279gdy8t63dg73gd8gx87738dg reference: payment2 contextType: BILL_IN_ARREARS purposeCode: COMT amount: amount: 5 currency: GBP payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '654321' accountType: BUSINESS_SAVING uk-bulk-payment-auth-example-response: description: UK Bulk Payment Example Response value: meta: tracingId: 96169af01d394ad39658f17d53b49a5d data: id: a2a9ec77-a479-4996-9896-4568e1968e7a userUuid: 5350782b-60f3-489e-aae5-a24d8d679a07 applicationUserId: string institutionId: modelo-sandbox status: AWAITING_AUTHORIZATION createdAt: '2021-06-09T13:48:25.138Z' featureScope: - EXISTING_PAYMENTS_DETAILS - EXISTING_PAYMENT_INITIATION_DETAILS - CREATE_BULK_PAYMENT state: 80052c03007f41d589f64377eef4d620 institutionConsentId: sdp-6-25ff5bd8-d01c-422d-aa9e-8e68808bc899 authorisationUrl: >- https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=80052c03007f41d589f64377eef4d620&nonce=80052c03007f41d589f64377eef4d620&scope=openid+payments&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiODAwNTJjMDMwMDdmNDFkNTg5ZjY0Mzc3ZWVmNGQ2MjAiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoic2RwLTYtMjVmZjViZDgtZDAxYy00MjJkLWFhOWUtOGU2ODgwOGJjODk5IiwiZXNzZW50aWFsIjp0cnVlfX0sInVzZXJpbmZvIjp7Im9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6InNkcC02LTI1ZmY1YmQ4LWQwMWMtNDIyZC1hYTllLThlNjg4MDhiYzg5OSIsImVzc2VudGlhbCI6dHJ1ZX19fSwibm9uY2UiOiI4MDA1MmMwMzAwN2Y0MWQ1ODlmNjQzNzdlZWY0ZDYyMCIsImp0aSI6ImUxYjZmMWM4LTQ1ZTktNGM0NS05NGE0LWExMTY1Nzk2NjZiNiIsImlhdCI6MTYyMzI0NjUwNSwiZXhwIjoxNjIzMjQ4MzA1fQ.C5YkClHiDOWl1CKnmEY0gM_JizUuELp2-k7sDjsWV5T-mgTWviO-jM7iVfCf4MsU6batLSBmeUFLco1b3S8PTQkAzwM3laHIgbfDAb_6bYkSBTbPriyzKcC8xAwhX3VdvWtb9qqdrn9zXSmIIITBhJdMzk1cgIjyETD7WNPln839eGP1-w8iB8yDOJOkYGRHJ850mQY-lk61GegmKs5kaxtYPIhrG2gygIi3JsN-uQJ6YOl2-5pylTEcJbuwhFiyeePdqHZdabqW2BSA6lDKQbMV_Zow_zhSWoFFv6RZdXCQpt4TBRj1W7tzZQKin-MC-TpzaF1q07RpSy0NtlN85w qrCodeUrl: >- https://images.yapily.com/image/2bbb79b8-2c4a-4c8e-9132-0636879437da/1623246505?size=0 error-response-code-401: description: Error Response value: error: code: 401 status: UNAUTHORIZED message: Full authentication is required to access this resource schemas: BulkPaymentAuthorisationRequest: required: - institutionId type: object properties: userUuid: type: string format: uuid description: >- __Conditional__. The reference to the `User` that will authorise the authorisation request using the Yapily generated UUID. Either the `userUuid` or `applicationUserId` must be provided. example: e006a012-c306-4355-a6a1-99bf69ae5171 applicationUserId: type: string description: >- __Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided. example: user-234562290 forwardParameters: description: >- Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. type: array items: type: string institutionId: type: string description: >- __Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to. example: yapily-mock callback: type: string description: >- __Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`. See [Using a callback (Optional)](/open-banking-flow/handling-redirects/callback-url) for more information. example: https://display-parameters.com redirect: $ref: '#/components/schemas/RedirectRequest' oneTimeToken: type: boolean description: >- __Conditional__. Used to receive a `oneTimeToken` rather than a `consentToken` at the `callback` for additional security. This can only be used when the `callback` is set. See [Using a callback with an OTT (Optional)](/open-banking-flow/handling-redirects/callback-url) for more information. example: false paymentRequest: $ref: '#/components/schemas/BulkPaymentRequest' ApiResponseOfPaymentAuthorisationRequestResponse: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' data: $ref: '#/components/schemas/PaymentAuthorisationRequestResponse' links: type: object additionalProperties: type: string forwardedData: type: array items: $ref: '#/components/schemas/ResponseForwardedData' raw: deprecated: true type: array items: $ref: '#/components/schemas/RawResponse' tracingId: type: string writeOnly: true ApiResponseError: type: object properties: error: $ref: '#/components/schemas/ApiError' raw: deprecated: true type: array items: $ref: '#/components/schemas/RawResponse' description: >- Used to return errors from the bank from each request - `400` - Returned by any `POST` endpoint when the body does not conform to the contract - `401` - Returned by any endpoint when an invalid `authToken` is used for authentication - `403` - Returned by any [Financial Data](/api-reference#financial-data) and any [Payments](/api-reference#payments) endpoint when the `Consent` is no longer authorised to access financial data or to make a payment - `404` - Returned by any endpoint where there are path parameters and the path parameters supplied are unable to find the desired resource - `409` - Returned by any `POST` endpoint when creating a resource that conflicts with any other existing resource e.g. [Create User](/api-reference/addUser) - `424` - Returned by any [Financial Data](/api-reference#financial-data) and any [Payments](/api-reference#payments) endpoint when the feature to be accessed is not supported by the `Institution`. - `500` - Returned by any endpoint when Yapily is down. If you encounter any false positives, please [notify us](mailto:support@yapily.com) example: error: tracingId: 74b13ce8ed51419f92c5d609e04532de code: 424 institutionError: errorMessage: >- {"Code":"500 Internal Server Error","Id":"5ff8d331-4282-41e0-b5ef-1ac9ac39f009","Message":"Technical Error. Please try again later","Errors":[{"ErrorCode":"UK.OBIE.UnexpectedError","Message":"There was a problem processing your request. Please try again later"}]} httpStatusCode: 500 source: INSTITUTION status: FAILED_DEPENDENCY RedirectRequest: required: - url type: object properties: url: type: string description: >- __Mandatory__.Successful redirect after the user complete the authorisation at the `Institution`. description: >- __Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`. BulkPaymentRequest: required: - payments type: object properties: payments: type: array description: >- __Mandatory__. The array of `PaymentRequest` objects to initiate in the bulk payment. items: $ref: '#/components/schemas/PaymentRequest' originatorIdentificationNumber: type: string description: >- __Conditional__. The identification number of the originator. - Mandatory for AIB bulk payments - Mandatory for HSBC Corporate bulk payments. This will be the Connect Profile ID executionDateTime: type: string description: >- __Optional__. Used to schedule the bulk payment to be executed at a future date if supported by the `Institution`. This value establishes the requirement for the subsequent payment submission. The final payment request must occur on the same calendar day as this timestamp to pass validation. format: date-time description: The payment request object defining the details of the bulk payment ResponseMeta: type: object properties: tracingId: type: string PaymentAuthorisationRequestResponse: type: object properties: id: type: string description: >- Unique identifier for the payment authorisation request. The `consentID` used to [retrieve a consent](/api/reference/#operation/getConsentById). format: uuid userUuid: type: string description: The `User` that the authorisation request was created for. format: uuid applicationUserId: type: string description: >- The user-friendly reference to the `User` that the authorisation request was created for. referenceId: type: string institutionId: type: string description: The `Institution` the authorisation request was sent to. status: $ref: '#/components/schemas/AuthorisationStatus' createdAt: type: string description: Date and time the consent was created. format: date-time transactionFrom: type: string description: >- When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved. format: date-time transactionTo: type: string description: >- When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved. format: date-time expiresAt: type: string description: >- Date and time the authorisation expires. Re-authorisation is needed to retain access. format: date-time timeToExpireInMillis: type: integer format: int64 deprecated: true timeToExpire: type: string format: iso8601 featureScope: uniqueItems: true description: The set of features the consent provides access to. type: array items: $ref: '#/components/schemas/FeatureEnum' consentToken: type: string description: >- Represents the authorisation to gain access to the requested features. Required to make a payment request. state: type: string description: >- Correlation ID used with the `Institution` during the authorisation process. authorizedAt: type: string description: Date and time the request was authorised by the `Institution`. format: date-time institutionConsentId: type: string description: Unique identifier of the consent assigned by the `Institution`. charges: type: array items: $ref: '#/components/schemas/PaymentChargeDetails' exchangeRateInformation: $ref: '#/components/schemas/ExchangeRateInformationResponse' authorisationUrl: type: string qrCodeUrl: type: string description: >- The URL for a QR code that may be scanned via a mobile device to make a authorisation redirect to the bank (authURL encoded). explanation: type: string description: >- Message from the `Institution` received by Yapily, detailing the next action the user is required to take. This is used only for Decoupled flows. ResponseForwardedData: type: object properties: headers: type: object additionalProperties: type: string url: type: string RawResponse: deprecated: true type: object description: >- [DEPRECATED] Interaction (raw request and response) that occurred with the `Institution` in order to fulfil a request. properties: request: $ref: '#/components/schemas/RawRequest' duration: type: string format: iso8601 headers: type: object additionalProperties: type: string resultCode: type: integer format: int32 result: type: object ApiError: type: object description: Provides details of the error that has occurred. properties: code: type: integer description: __Mandatory__. Numeric `HTTP` status code associated with the error. format: int32 institutionError: $ref: '#/components/schemas/InstitutionError' message: type: string description: >- __Mandatory__. Description of the exact error that has been experienced. source: type: string status: type: string description: __Mandatory__. Textual description of the `HTTP` error status type. tracingId: type: string description: >- __Optional__. A unique identifier assigned by Yapily for the request that can be used for support purposes. PaymentRequest: required: - amount - payee - paymentIdempotencyId - type type: object properties: paymentIdempotencyId: title: Idempotency Id type: string description: >- __Mandatory__. A unique identifier that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters. example: 04ab4536gaerfc0e1f93c4f4 payer: $ref: '#/components/schemas/Payer' reference: title: Payment Reference type: string description: >- __Optional__. The payment reference or description. Limited to a maximum of 18 characters long. example: Bill payment contextType: $ref: '#/components/schemas/PaymentContextType' purposeCode: $ref: '#/components/schemas/PaymentPurposeCode' type: $ref: '#/components/schemas/PaymentType' payee: $ref: '#/components/schemas/Payee' periodicPayment: $ref: '#/components/schemas/PeriodicPaymentRequest' internationalPayment: $ref: '#/components/schemas/InternationalPaymentRequest' amount: $ref: '#/components/schemas/Amount' paymentDateTime: title: Payment Date type: string description: >- __Conditional__. Used to specify the date of the payment when the payment type is one of the following: - `DOMESTIC_SCHEDULED_PAYMENT` - `DOMESTIC_PERIODIC_PAYMENT` - `INTERNATIONAL_SCHEDULED_PAYMENT` - `INTERNATIONAL_PERIODIC_PAYMENT` format: date-time example: '2021-07-21T17:32:28Z' readRefundAccount: title: Read Refund Account type: boolean description: >- __Optional__. Used to request the payer details in the payment response when the `Institution` provides the feature `READ_DOMESTIC_SINGLE_REFUND`. See [Reverse Payments](/payments/payment-resources/reverse-payments) for more information. example: false description: >- __Mandatory__. The payment request object defining the details of the payment. AuthorisationStatus: description: Current status of the embedded authorisation request in code form. type: string enum: - AWAITING_AUTHORIZATION - AWAITING_FURTHER_AUTHORIZATION - AWAITING_RE_AUTHORIZATION - AUTHORIZED - CONSUMED - REJECTED - REVOKED - FAILED - EXPIRED - UNKNOWN - INVALID - AWAITING_DECOUPLED_PRE_AUTHORIZATION - AWAITING_PRE_AUTHORIZATION - PRE_AUTHORIZED - AWAITING_DECOUPLED_AUTHORIZATION - AWAITING_SCA_METHOD - AWAITING_SCA_CODE FeatureEnum: type: string description: >- Used to describe what functions are supported by the associated `Institution`. For more information on each feature, see the following links: - [Financial Data Features](/data/financial-data-resources/financial-data-features) - [Payments Features](/payments/payment-resources/payment-features) enum: - INITIATE_PRE_AUTHORISATION - INITIATE_PRE_AUTHORISATION_ACCOUNTS - INITIATE_PRE_AUTHORISATION_PAYMENTS - INITIATE_ACCOUNT_REQUEST - INITIATE_EMBEDDED_ACCOUNT_REQUEST - ACCOUNT_REQUEST_DETAILS - ACCOUNTS - ACCOUNT - ACCOUNT_TRANSACTIONS - ACCOUNT_STATEMENTS - ACCOUNT_STATEMENT - ACCOUNT_STATEMENT_FILE - ACCOUNT_SCHEDULED_PAYMENTS - ACCOUNT_DIRECT_DEBITS - ACCOUNT_PERIODIC_PAYMENTS - ACCOUNT_TRANSACTIONS_WITH_MERCHANT - IDENTITY - ACCOUNTS_WITHOUT_BALANCE - ACCOUNT_WITHOUT_BALANCE - ACCOUNT_BALANCES - INITIATE_SINGLE_PAYMENT_SORTCODE - EXISTING_PAYMENT_INITIATION_DETAILS - CREATE_SINGLE_PAYMENT_SORTCODE - EXISTING_PAYMENTS_DETAILS - INITIATE_DOMESTIC_SINGLE_PAYMENT - INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT - CREATE_DOMESTIC_SINGLE_PAYMENT - INITIATE_EMBEDDED_BULK_PAYMENT - INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT - CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT - INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT - CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT - INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING - CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING - INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL - CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL - INITIATE_DOMESTIC_SCHEDULED_PAYMENT - CREATE_DOMESTIC_SCHEDULED_PAYMENT - INITIATE_DOMESTIC_PERIODIC_PAYMENT - CREATE_DOMESTIC_PERIODIC_PAYMENT - PERIODIC_PAYMENT_FREQUENCY_EXTENDED - INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT - CREATE_INTERNATIONAL_SCHEDULED_PAYMENT - INITIATE_INTERNATIONAL_PERIODIC_PAYMENT - CREATE_INTERNATIONAL_PERIODIC_PAYMENT - INITIATE_INTERNATIONAL_SINGLE_PAYMENT - CREATE_INTERNATIONAL_SINGLE_PAYMENT - INITIATE_BULK_PAYMENT - CREATE_BULK_PAYMENT - EXISTING_BULK_PAYMENT_DETAILS - TRANSFER - OPEN_DATA_PERSONAL_CURRENT_ACCOUNTS - OPEN_DATA_ATMS - READ_DOMESTIC_SINGLE_REFUND - READ_DOMESTIC_SCHEDULED_REFUND - READ_DOMESTIC_PERIODIC_PAYMENT_REFUND - READ_INTERNATIONAL_SINGLE_REFUND - READ_INTERNATIONAL_SCHEDULED_REFUND - ACCOUNT_BENEFICIARIES - INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS - INITIATE_ONETIME_PRE_AUTHORISATION_ACCOUNTS - INITIATE_ONETIME_PRE_AUTHORISATION - VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION PaymentChargeDetails: type: object description: Details the charges that will apply to the payment. properties: chargeAmount: $ref: '#/components/schemas/Amount' chargeType: description: >- __Mandatory__. Specifies the nature of the transaction charge e.g. (Bank transfer fees). type: string chargeTo: description: __Mandatory__. States which party of the payment bears the charges. type: string ExchangeRateInformationResponse: required: - rateType - unitCurrency type: object properties: unitCurrency: type: string description: >- __Mandatory__. The currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is `GBP`. rate: type: number description: >- __Optional__. The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. rateType: $ref: '#/components/schemas/RateTypeEnum' foreignExchangeContractReference: type: string description: >- __Optional__. The unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. exchangeRateExpiryDate: type: string format: date-time RawRequest: type: object properties: method: type: string url: type: string requestInstant: type: string format: date-time headers: type: object additionalProperties: type: string body: type: object bodyParameters: type: object additionalProperties: type: string startTime: type: string format: date-time startedAt: type: string format: date-time deprecated: true InstitutionError: type: object description: >- Raw error details provided by the `Institution`, when it was the error source. properties: errorMessage: type: string description: Textual description of the `Institution` error. httpStatusCode: type: integer description: Numeric HTTP status code associated with the `Institution` error. format: int32 Payer: title: Payer Details required: - accountIdentifications type: object properties: name: title: Payer Name type: string description: The account holder name of the Payer. example: John Doe accountIdentifications: uniqueItems: true type: array description: >- __Mandatory__. The account identifications that identify the `Payer` bank account. items: $ref: '#/components/schemas/AccountIdentification' address: $ref: '#/components/schemas/Address' description: __Conditional__. Details of the benefactor [person or business]. PaymentContextType: title: Payment Code type: string default: OTHER description: >- __Optional__. The payment context code. This defaults to `OTHER` if not specified. enum: - BILL - GOODS - SERVICES - OTHER - PERSON_TO_PERSON - BILL_IN_ADVANCE - BILL_IN_ARREARS - ECOMMERCE_MERCHANT - FACE_TO_FACE_POS - TRANSFER_TO_SELF - TRANSFER_TO_THIRD_PARTY - PISP_PAYEE PaymentPurposeCode: title: Payment Purpose Code type: string description: >- __Optional__. The payment purpose code. Allowed values: INTP, DEPT, BEXP, LICF, SERV, SUPP, TRAD, SUBS, GDSV, ROYA, COMT, CHAR, ECPR, CLPR, INTE, LOAN, LOAR, INPC, INPR, INSC, INSU, LIFI, PPTI, HLRP, HLST, PDEP, IVPT, REBT, REFU, CDBL, CPKC, EDUC, FEES, GAMB, LOTT, GIFT, INSM, REOD, GOVT, TCSC, BLDM, RENT, DIVD, INVS, SAVG, HLTI, DNTS, LTCF, MDCS, VIEW, BECH, BENE, SSBE, PEFC, PENS, ADCS, BONU, COMM, SALA, ESTX, HSTX, INTX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, CBTV, ELEC, GASB, PHON, UBIL, WTER . See [Payment Purpose code](/getting-started/application-management#payment-purpose-code-and-user-groups) to see the definition of each code PaymentType: title: Payment Type type: string description: >- __Mandatory__. Used to specify which of the [payment types](/payments/payment-resources/intro-to-payment-execution#payment-types) to execute. See [European Payments](/payments/payment-resources/european-payments) to verify whether the `type` should be `DOMESTIC` or `INTERNATIONAL`. enum: - DOMESTIC_PAYMENT - DOMESTIC_INSTANT_PAYMENT - DOMESTIC_VARIABLE_RECURRING_PAYMENT - DOMESTIC_SCHEDULED_PAYMENT - DOMESTIC_PERIODIC_PAYMENT - INTERNATIONAL_PAYMENT - INTERNATIONAL_SCHEDULED_PAYMENT - INTERNATIONAL_PERIODIC_PAYMENT - BULK_PAYMENT Payee: title: Payee Details type: object description: __Mandatory__. Details of the beneficiary [person or business]. required: - accountIdentifications - name properties: name: title: Payee Name type: string description: __Mandatory__. The account holder name of the beneficiary. example: Jane Doe accountIdentifications: uniqueItems: true type: array description: >- __Mandatory__. The account identifications that identify the `Payee` bank account. example: - identification: '401016' type: SORT_CODE - identification: '71518920' type: ACCOUNT_NUMBER items: $ref: '#/components/schemas/AccountIdentification' accountType: $ref: '#/components/schemas/PayeeAccountType' address: $ref: '#/components/schemas/Address' merchantId: title: Merchant Id type: string description: >- __Optional__. The merchant ID is a unique code provided by the payment processor to the merchant. example: '24589303' merchantCategoryCode: title: Merchant Category type: string format: ^\d{4}$ description: >- __Optional__. The category code of the merchant in case the `Payee` is a business. Specified as a 4-letter ISO 18245 code. Allowed values: - `0742` (Veterinary Services) - `0763` (Agricultural Cooperatives) - `0780` (Landscaping and Horticultural Services) - `1520` (General Contractor/Residential Building) - `1711` (Heating, Plumbing, Air Conditioning Contractors) - `1731` (Electrical Contractors) - `1740` (Masonry, Stonework, Tile Setting, Plastering, Insulation Contractors) - `1750` (Carpentry) - `1761` (Roof, Siding, and Sheet Metal Work Contractors) - `1771` (Contractors, Concrete) - `1799` (Special Trade Contractor - Not Elsewhere Classified) - `2741` (Miscellaneous Publishing and Printing Services) - `2791` (Typesetting, Plate Making and Related Services (Business to Business MCC)) - `2842` (Specialty Cleaning, Polishing and Sanitation Preparations (Business to Business MCC)) - `3000` (United Airlines) - `3001` (American Airlines) - `3002` (Pan American) - `3003` (Eurofly Airlines) - `3004` (Dragon Airlines) - `3005` (British Airways) - `3006` (Japan Air Lines) - `3007` (Air France) - `3008` (Lufthansa) - `3009` (Air Canada) - `3010` (KLM) - `3011` (AeroFlot) - `3012` (Qantas) - `3013` (Alitalia) - `3014` (Saudi Arabian Airlines) - `3015` (SWISS) - `3016` (SAS) - `3017` (South African Airway) - `3018` (Varig (Brazil)) - `3020` (Air India) - `3021` (Air Algerie) - `3022` (PAL AIR) - `3023` (Mexicana) - `3024` (Pakistan International) - `3025` (Air New Zealand Ltd.) - `3026` (Emirates Airlines) - `3027` (UTA/InterAir) - `3028` (Air Malta) - `3029` (SN Brussels Airlines - SN BRUSSELS) - `3030` (Aerolineas Argentinas) - `3031` (Olympic Airways) - `3032` (El Al) - `3033` (Ansett Airlines) - `3034` (ETIHADAIR) - `3035` (TAP (Portugal)) - `3036` (VASP (Brazil)) - `3037` (EgyptAir) - `3038` (Kuwait Airways) - `3039` (Avianca) - `3040` (GulfAir (Bahrain)) - `3041` (Balkan-Bulgarian) - `3042` (FinnAir) - `3043` (Aer Lingus) - `3044` (Air Lanka) - `3045` (Nigeria Airways) - `3046` (Cruzeiro do Sul (Bra)) - `3047` (THY (Turkey)) - `3048` (Royal Air Maroc) - `3049` (Tunis Air) - `3050` (Icelandair) - `3051` (Austrian Airlines) - `3052` (LANAIR) - `3053` (AVIACO (Spain)) - `3054` (Ladeco (Chile)) - `3055` (LAB (Bolivia)) - `3056` (JetAir) - `3057` (Virgin America – VIR AMER) - `3058` (Delta) - `3059` (DBA Airlines-DBA AIR) - `3060` (NWA Air) - `3061` (Continental) - `3062` (Hapag-Lloyd Express - HLX) - `3063` (US Airways) - `3064` (Adria Airways) - `3065` (Airinter (AirInternational)) - `3066` (Southwest) - `3068` (AIR STANA) - `3069` (Sun Country Air) - `3070` (Pacific Southwest Airlines (PSA)) - `3071` (Air British Columbia) - `3072` (CEBU PAC) - `3073` (Air Cal) - `3075` (Singapore Airlines) - `3076` (Aeromexico) - `3077` (Thai Airways) - `3078` (China Airlines) - `3079` (Jetstar Airways - Jetstar) - `3081` (NordAir) - `3082` (Korean Airlines) - `3083` (Air Afrique) - `3084` (Eva Airlines) - `3085` (Midwest Express Airlines, Inc) - `3087` (Metro Airlines) - `3088` (Croatia Airlines) - `3089` (Tans Saero) - `3090` (Uni Airways) - `3094` (Zambia Airways) - `3096` (Air Zimbabwe) - `3097` (Spanair (abbreviation: SPANAIR)) - `3098` (Asiana Airlines) - `3099` (Cathay Pacific) - `3100` (Malaysian Airline Sys) - `3102` (Iberia) - `3103` (Garuda (Indonesia)) - `3105` (Piedmont) - `3106` (Braathens S.A.F.E. (Norway)) - `3110` (Wings Airways) - `3111` (British Midland) - `3112` (Windward Island) - `3117` (Venezolana Int de Aviacion) - `3118` (Valley Airlines) - `3125` (Tan Airlines) - `3126` (Talair PTY Ltd.) - `3127` (Taca International) - `3129` (Surinam Airways) - `3130` (Sunworld International Airways) - `3131` (VLM Air) - `3132` (Frontier Airlines) - `3133` (Sunbelt Airlines) - `3135` (Sudan Airlines) - `3136` (Qatar Air) - `3137` (Singleton) - `3138` (Simmons Airlines) - `3141` (Seair Alaska) - `3143` (Scenic Airlines) - `3144` (Virgin Atlantic) - `3145` (San Juan) - `3146` (Luxair) - `3148` (Air Littoral SA) - `3151` (Air Laire) - `3154` (Princeville) - `3156` (Go Fly) - `3159` (PBA-Provincetwn-Bstn Air) - `3161` (All Nippon Airways) - `3164` (Norontair) - `3165` (New York Helicopter) - `3167` (Aero Continente - AEROCONTINENTE) - `3170` (Mount Cook) - `3171` (Canadian Airlines) - `3172` (Nation Air) - `3174` (JetBlue Airways) - `3175` (Middle East Air) - `3176` (Metroflight Airlines) - `3177` (AirTran Airways) - `3178` (Mesa Air) - `3180` (Westjet Airlines-WESTJET) - `3181` (Malev Hungarian Airlines) - `3182` (LOT (Poland)) - `3183` (Oman Aviation - OMAN AIR) - `3184` (LIAT) - `3185` (LAV (Venezuela)) - `3186` (LAP (Paraguay)) - `3187` (LACSA (Costa Rica)) - `3188` (Virgin Express - VIR EXP) - `3190` (Jugoslav Air) - `3191` (Island Airlines) - `3192` (Iran Air) - `3193` (Indian Airlines) - `3195` (Holiday Airlines) - `3196` (Hawaiian Air) - `3197` (Havasu Airlines) - `3198` (Harbor Airlines) - `3199` (Servicios Aereos Militares) - `3200` (Guyana Airways) - `3203` (Golden Pacific Air) - `3204` (Freedom Airlines) - `3206` (China Eastern Airlines (Abbr: China East Air)) - `3207` (Empresa Ecuatoriana) - `3211` (Norwegian Air Shuttle - NORWEGIANAIR) - `3212` (Dominicana de Aviacion) - `3213` (Malmo Aviation - MALMO AV) - `3215` (Dan Air Services) - `3216` (Cumberland Airlines) - `3217` (CSA-Ceskoslovenske Aeroln) - `3218` (Crown Air) - `3219` (Copa) - `3220` (Compania Faucett) - `3221` (Transportes Aeros Mil) - `3222` (Command Airways) - `3223` (Comair) - `3226` (Skyways Air- SKYWAYS) - `3228` (Cayman Airways) - `3229` (SAETA) - `3231` (SAHSA) - `3233` (Capitol Air) - `3234` (CARIBAIR) - `3235` (Brockway Air) - `3236` (Air Arabia Airlines - Air Arab) - `3238` (Bemidji Aviation) - `3239` (Bar Harbor Airlines) - `3240` (Bahamasair) - `3241` (Aviateca (Guatemala)) - `3242` (Avensa) - `3243` (Austrian Air Service) - `3245` (Easy Jet - EASYJET) - `3246` (Ryan Air - RYANAIR) - `3247` (Gol Airlines - GOL) - `3248` (Tam Airlines - TAM) - `3251` (Aloha Airlines) - `3252` (ALM-Antilean Airlines) - `3253` (America West) - `3254` (U.S. Air Shuttle) - `3256` (Alaska Airlines Inc.) - `3259` (American Trans Air) - `3260` (Spirit Airlines - SPIRIT) - `3261` (Air China) - `3262` (Reno Air) - `3263` (Aero Servicio Carabobo) - `3266` (Air Seychelles) - `3267` (Air Panama International) - `3268` (Air Pacific) - `3275` (Air Nevada) - `3276` (Air Midwest) - `3277` (Air Madagascar) - `3279` (Air LA) - `3280` (Air Jamaica) - `3282` (Air Djibouti) - `3284` (Aero Virgin Islands) - `3285` (AeroPeru) - `3286` (Aero Nicaraguensis) - `3287` (Aero Coach Aviation) - `3291` (Ariana Afghan) - `3292` (Cyprus Airways) - `3293` (Ecuatoriana) - `3294` (Ethiopian Airlines) - `3295` (Kenya Airways) - `3296` (Air Berlin-AIRBERLIN) - `3297` (Tarom Romanian Air Transport) - `3298` (Air Mauritius) - `3299` (Wideroe's Flyveselskap) - `3351` (Affiliated Auto Rental) - `3352` (American International) - `3353` (Brooks Rent a Car) - `3354` (Action Auto Rental) - `3355` (SIXT Car Rental) - `3357` (Hertz) - `3359` (Payless Car Rental) - `3360` (Snappy Car Rental) - `3361` (Airways Rent a Car) - `3362` (Altra Auto Rental) - `3364` (Agency Rent a Car) - `3366` (Budget Rent a Car) - `3368` (Holiday R-A-C) - `3370` (Rent-a-Wreck) - `3374` (Accent Rent-A-Car) - `3376` (Ajax R-A-C) - `3380` (Triangle Rent a Car) - `3381` (Europ Car) - `3385` (Tropical R-A-C) - `3386` (Showcase Rental Cars) - `3387` (Alamo Rent a Car) - `3388` (Merchants Rent-A-Car, Inc) - `3389` (Avis R-A-C) - `3390` (Dollar R-A-C) - `3391` (Europe by Car) - `3393` (National Car Rental) - `3394` (Kemwell Group R-A-C) - `3395` (Thrify Car Rental) - `3396` (Tilden R-A-C) - `3398` (Econo Car R-A-C) - `3400` (Auto Host Car Rentals) - `3405` (Enterprise R-A-C) - `3409` (General Rent-a-Car) - `3412` (A-1 R-A-C) - `3414` (Godfrey National) - `3420` (ANSA International) - `3421` (Allstate Rent-a-Car) - `3423` (Avcar Rent-a-Car) - `3425` (Automate Rent-a-Car) - `3427` (Avon Rent-a-Car) - `3428` (Carey Rent-a-Car) - `3429` (Insurance Rent-a-Car) - `3430` (Major Rent-a-Car) - `3431` (Replacement Rent-a-Car) - `3432` (Reserve Rent-a-Car) - `3433` (Ugly Duckling R-A-C) - `3434` (USA Rent-a-Car) - `3435` (Value Rent-a-Car) - `3436` (Autohansa Rent-a-Car) - `3437` (Cite) - `3438` (Interenet Rent-a-Car) - `3439` (Millville Rent-a-Car) - `3441` (Advantage Rent A Car) - `3501` (Holiday Inns) - `3502` (Best Western Hotels) - `3503` (Sheraton) - `3504` (Hilton) - `3505` (Forte Hotels) - `3506` (Golden Tulip Hotels) - `3507` (Friendship Inns) - `3508` (Quality Inns) - `3509` (Marriott) - `3510` (Days Inn Colonial Resort) - `3511` (Arabella Hotels) - `3512` (Intercontinental Hotels) - `3513` (Westin) - `3514` (Amerisuites) - `3515` (Rodeway Inn) - `3516` (LaQuinta Motor Inns) - `3517` (Americana Hotels) - `3518` (Sol Hotels) - `3519` (Pullman International Hotels) - `3520` (Meridien Hotels) - `3521` (Royal Lahaina Resort) - `3522` (Tokyo Group) - `3523` (Peninsula Hotels) - `3524` (WelcomGroup Hotels) - `3525` (Dunfey Hotels) - `3526` (Prince Hotels) - `3527` (Downtowner Passport) - `3528` (Red Lion Inns) - `3529` (CP (Canadian Pacific)) - `3530` (Renaissance Hotels) - `3531` (Kauai Coconut Beach Resort) - `3532` (Royal Kona Resort) - `3533` (Hotel Ibis) - `3534` (Southern Pacific) - `3535` (Hilton International) - `3536` (AMFAC Hotels) - `3537` (ANA Hotels) - `3538` (Concorde Hotels) - `3539` (Summerfield Suites Hotel) - `3540` (Iberotel Hotels) - `3541` (Hotel Okura) - `3542` (Royal Hotels) - `3543` (Four Seasons) - `3544` (Cigna Hotels) - `3545` (Shangri-La International) - `3546` (Hotel Sierra) - `3548` (Hotels Melia) - `3549` (Auberge des Governeurs) - `3550` (Regal 8 Inns) - `3551` (Mirage Hotel and Casino) - `3552` (Coast Hotel) - `3553` (Park Inn by Radisson) - `3554` (Pinehurst Resort) - `3555` (Treasure Island Hotel and Casino) - `3556` (Barton Creek Resort) - `3557` (Manhattan East Suite Hotels) - `3558` (Jolly Hotels) - `3559` (Candlewood Suites) - `3560` (Aladdin Resort and Casino) - `3561` (Golden Nugget) - `3562` (Comfort Inns) - `3563` (Journey's End Motels) - `3564` (Sam's Town Hotel and Casino) - `3565` (Relax Inns) - `3566` (Garden Place Hotel) - `3567` (Soho Grand Hotel) - `3568` (Ladbroke Hotels) - `3569` (Tribeca Grand Hotel) - `3570` (Forum Hotels) - `3571` (Grand Wailea Resort) - `3572` (Miyako Hotel) - `3573` (Sandman Hotels) - `3574` (Venture Inn) - `3575` (Vagabond Hotels) - `3576` (La Quinta Resort) - `3577` (Mandarin Oriental Hotel) - `3578` (Frankenmuth Bavarian) - `3579` (Hotel Mercure) - `3580` (Hotel Del Coronado) - `3581` (Delta Hotels) - `3582` (California Hotel and Casino) - `3583` (Radisson BLU) - `3584` (Princess Hotels International) - `3585` (Hungar Hotels) - `3586` (Sokos Hotels) - `3587` (Doral Hotels) - `3588` (Helmsley Hotels) - `3589` (Doral Golf Resort) - `3590` (Fairmont Hotel) - `3591` (Sonesta Hotels) - `3592` (Omni Hotels) - `3593` (Cunard Hotels) - `3594` (Arizona Biltmore) - `3595` (Hospitality Inns) - `3596` (Wynn Las Vegas) - `3597` (Riverside Resort and Casino) - `3598` (Regent International Hotels) - `3599` (Pannonia Hotels) - `3600` (Saddlebrook Resort - Tampa) - `3601` (Trade Winds Resorts) - `3602` (Hudson Hotel) - `3603` (Noah's Hotel) - `3604` (Hilton Garden Inn) - `3605` (Jurys Doyle Hotel Group) - `3606` (Jefferson Hotel) - `3607` (Fountainebleau Resort) - `3608` (Gaylord Opryland) - `3609` (Gaylord Palms) - `3610` (Gaylord Texan) - `3611` (C MON INN) - `3612` (Movenpick Hotels) - `3613` (Microtel Inns & Suites) - `3614` (Americinn) - `3615` (Travelodge Motels) - `3617` (America's Best Value Inn) - `3618` (Great Wolf) - `3619` (Aloft) - `3620` (Binion's Horseshoe Club) - `3621` (Extended Stay) - `3622` (Merlin Hotel) - `3623` (Dorint Hotels) - `3624` (Lady Luck Hotel and Casino) - `3625` (Hotel Universale) - `3626` (Studio Plus) - `3627` (Extended Stay America) - `3628` (Excalibur Hotel and Casino) - `3629` (Dan Hotels) - `3630` (Extended Stay Deluxe) - `3631` (Sleep Inn) - `3632` (The Phoenician) - `3633` (Rank Hotels) - `3634` (Swissotel) - `3635` (Reso Hotel) - `3636` (Sarova Hotels) - `3637` (Ramada Inns) - `3638` (Howard Johnson) - `3639` (Mount Charlotte Thistle) - `3640` (Hyatt Motels) - `3641` (Sofitel Hotels) - `3642` (Novotel) - `3643` (Steigenberger Hotels) - `3644` (EconoLodges) - `3645` (Queens Moat Houses) - `3646` (Swallow Hotels) - `3647` (Husa Hotels) - `3648` (De Vere Hotels) - `3649` (Radisson) - `3650` (Red Roof Inns) - `3651` (Imperial London Hotel) - `3652` (Embassy Hotels) - `3653` (Penta Hotels) - `3654` (Loews Hotels) - `3655` (Scandic Hotels) - `3656` (Sara Hotels) - `3657` (Oberoi Hotels) - `3658` (New Otani Hotels) - `3659` (Taj Hotels International) - `3660` (Knights Inn) - `3661` (Metropole Hotels) - `3662` (Circus Circus Hotel and Casino) - `3663` (Hoteles El Presidente) - `3664` (Flag Inns) - `3665` (Hampton Inn Hotels) - `3666` (Stakis Hotels) - `3667` (Luxor Hotel and Casino) - `3668` (Maritim Hotels) - `3669` (Eldorado Hotel and Casino) - `3670` (Arcade Hotels) - `3671` (Arctia Hotels) - `3672` (Campanile Hotels) - `3673` (IBUSZ Hotels) - `3674` (Rantasipi Hotels) - `3675` (Interhotel CEDOK) - `3676` (Monte Carlo Hotel and Casino) - `3677` (Climat de France Hotels) - `3678` (Cumulus Hotels) - `3679` (Silver Legacy Hotel and Casino) - `3680` (Hoteis Othan) - `3681` (Adams Mark Hotels) - `3682` (Sahara Hotel and Casino) - `3683` (Bradbury Suites) - `3684` (Budget Hosts Inns) - `3685` (Budgetel Hotels) - `3686` (Suisse Chalet) - `3687` (Clarion Hotels) - `3688` (Compri Hotels) - `3689` (Consort Hotels) - `3690` (Courtyard Inns) - `3691` (Dillon Inn) - `3692` (Doubletree) - `3693` (Drury Inn) - `3694` (Economy Inns of America) - `3695` (Embassy Suites) - `3696` (Excel Inn) - `3697` (Fairfield Hotels) - `3698` (Harley Hotels) - `3699` (Midway Motor Lodge) - `3700` (Motel 6) - `3701` (La Mansion Del Rio) - `3702` (The Registry Hotels) - `3703` (Residence Inn) - `3704` (Royce Hotels) - `3705` (Sandman Inn) - `3706` (Shilo Inn) - `3707` (Shoney's Inn) - `3708` (Virgin River Hotel and Casino) - `3709` (Super 8 Motels) - `3710` (The Ritz Carlton Hotels) - `3711` (Flag Inns (Australia)) - `3712` (Buffalo Bill's Hotel and Casino) - `3713` (Quality Pacific Hotel) - `3714` (Four Seasons Hotels-Austr) - `3715` (Fairfield Inn) - `3716` (Carlton Hotels) - `3717` (City Lodge Hotels) - `3718` (Karos Hotels) - `3719` (Protea Hotels) - `3720` (Southern Sun Hotels) - `3721` (Hilton Conrad Hotels) - `3722` (Wyndham Hotels) - `3723` (Rica Hotels) - `3724` (Inter Nor Hotels) - `3725` (SeaPines Plantation) - `3726` (Rio Suites) - `3727` (Broadmoor Hotel) - `3728` (Bally's Hotel and Casino) - `3729` (John Ascuaga's Nugget) - `3730` (MGM Grand Hotel) - `3731` (Harrah's Hotels and Casinos) - `3732` (Opryland Hotel) - `3733` (Boca Raton Resort) - `3734` (Harvey/Bristol Hotels) - `3735` (Master Economy Inns) - `3736` (Colorado Belle/Edgewater Resort) - `3737` (Riviera Hotel and Casino) - `3738` (Tropicana Resort & Casino) - `3739` (Woodside Hotels & Resorts) - `3740` (Towneplace Suites) - `3741` (Millennium Hotel) - `3742` (Club Med) - `3743` (Biltmore Hotel and Suites) - `3744` (Carefree Resorts) - `3745` (St. Regis Hotel) - `3746` (The Eliot Hotel) - `3747` (ClubCorp/ClubResorts) - `3748` (Wellesley Inns) - `3749` (The Beverly Hills Hotel) - `3750` (Crown Plaza Hotels) - `3751` (Homewood Suites) - `3752` (Peabody Hotels) - `3753` (Greenbriar Resorts) - `3754` (Amelia Island Plantation) - `3755` (The Homestead) - `3757` (Canyon Ranch) - `3758` (Kahala Mandarion Oriental Hotel) - `3759` (The Orchid at Mauna Lani) - `3760` (Halekulani Hotel/Waikiki Parc) - `3761` (Primadonna Hotel and Casino) - `3762` (Whisky Pete's Hotel and Casino) - `3763` (Chateau Elan Winery and Resort) - `3764` (Beau Rivage Hotel and Casino) - `3765` (Bellagio) - `3766` (Fremont Hotel and Casino) - `3767` (Main Street Hotel and Casino) - `3768` (Silver Star Hotel and Casino) - `3769` (Stratosphere Hotel and Casino) - `3770` (SpringHill Suites) - `3771` (Caesar's Resort) - `3772` (Nemacolin Woodlands) - `3773` (The Venetian Resort Hotel and Casino) - `3774` (New York-New York Hotel and Casino) - `3775` (Sands Resort) - `3776` (Nevele Grande Resort and Country Club) - `3777` (Mandalay Bay Resort) - `3778` (Four Points Hotels) - `3779` (W Hotels) - `3780` (Disney Resorts) - `3781` (Patricia Grand Resort Hotels) - `3782` (Rosen Hotels & Resort) - `3783` (Town and Country Resort and Convention Center) - `3784` (First Hospitality Hotel) - `3785` (Outrigger Hotels and Resorts) - `3786` (Ohana Hotel of Hawaii) - `3787` (Caribe Royale Resort Suites & Villas) - `3788` (Ala Moana Hotel / Ala Moana Hotels) - `3789` (Smugglers' Notch Resort) - `3790` (Raffles Hotels) - `3791` (Staybridge Suites) - `3792` (Claridge Casino Hotel) - `3793` (The Flamingo Hotels) - `3794` (Grand Casino Hotels) - `3795` (Paris Las Vegas Hotel) - `3796` (Peppermill Hotel Casino) - `3797` (Atlantic City Hilton) - `3798` (Embassy Vacation Resort) - `3799` (Hale Koa Hotel) - `3800` (Homestead) - `3801` (Wilderness Hotel and Golf Resort) - `3802` (The Palace Hotel) - `3807` (Element) - `3808` (LXR) - `3810` (La Costa Resort) - `3811` (Premier Travel Inn) - `3812` (Hyatt Place) - `3813` (Hotel Indigo) - `3814` (The Roosevelt Hotel NY) - `3815` (Holiday Inn Nickelodeon) - `3816` (Home2 Suites) - `3817` (Affinia) - `3818` (Mainstay Suites) - `3819` (Oxford Suites) - `3820` (Jumeirah Essex House) - `3821` (Caribe Royale) - `3822` (Crossland) - `3823` (Grand Sierra Resort) - `3824` (Aria) - `3825` (Vdara) - `3826` (Autograph) - `3827` (Galt House) - `3828` (Cosmopolitan of Las Vegas) - `3829` (Country Inn by Carlson) - `3830` (Park Plaza Hotel) - `3831` (Waldorf) - `4011` (Railroads) - `4111` (Local and Suburban Commuter Passenger Transportation, including Ferries) - `4112` (Passenger Rail (train)) - `4119` (Ambulance Services) - `4121` (Taxicabs and Limousines) - `4131` (Bus Lines, includes Charters/Tour Buses) - `4214` (Motor Freight Carriers and Trucking-Local and Long Distance, Moving & Storage Companies, and Local Delivery) - `4215` (Courier Services-Air and Ground, and Freight Forwarders) - `4225` (Public Warehousing-Farm products, Refrigerated Goods, Household Goods, and Storage) - `4411` (Steamship and Cruise Lines) - `4457` (Boat Rentals and Leasing) - `4468` (Marinas, Marine Service, and Supplies) - `4511` (Airlines and Air Carriers) - `4582` (Airports, Flying Fields, and Airport Terminals) - `4722` (Travel Agencies) - `4723` (Package Tour Operators (Germany Only)) - `4761` (Telemarketing of Travel Related Services and Vitamins) - `4784` (Bridge and Road Fees, Tolls) - `4789` (Transportation Services-not elsewhere classified) - `4812` (Telecommunication Equipment and Telephone Sales) - `4813` (Special Telecom Merchant) - `4814` (Telecommunication Services, Including Local and Long Distance Calls, Credit Card Calls, Call Through Use of Magnetic-Strip-Reading Telephones, and Fax Services) - `4815` (Monthly Summary Telephone Charges) - `4816` (Computer Network/Information Services and other Online Services such as electronic bulletin board, e-mail, web site hosting services, or Internet access) - `4821` (Telegraph Services) - `4829` (Quasi Cash - Money Transfer) - `4899` (Cable, Satellite, and Other Pay Television and Radio Services) - `4900` (Utilities-Electric, Gas, Water, and Sanitary) - `5013` (Motor Vehicle Supplies and New Parts (Business to Business MCC)) - `5021` (Office Furniture (Business to Business MCC)) - `5039` (Construction Materials Not Elsewhere Classified (Business to Business MCC)) - `5044` (Photographic, Photocopy, Microfilm Equipment and Supplies (Business to Business MCC)) - `5045` (Computers, Computer Peripheral Equipment, and Software) - `5046` (Commercial Equipment Not Elsewhere Classified (Business to Business MCC)) - `5047` (Dental/Laboratory/Medical/Ophthalmic Hospital Equipment and Supplies) - `5051` (Metal Service Centers and Offices (Business to Business MCC)) - `5065` (Electrical Parts and Equipment (Business to Business MCC)) - `5072` (Hardware, Plumbing, Heat Equipment and Supplies (Business to Business MCC)) - `5074` (Plumbing and Heating Equipment and Supplies (Business to Business MCC)) - `5085` (Industrial Supplies Not Elsewhere Classified (Business to Business MCC)) - `5094` (Precious Stones, Metals, Watches and Jewelry (Business to Business MCC)) - `5099` (Durable Goods Not Elsewhere Classified (Business to Business MCC)) - `5111` (Stationery, Office Supplies, and Printing and Writing Paper) - `5122` (Drugs, Drug Proprietary's, and Druggists' Sundries) - `5131` (Piece Goods, Notions and Other Dry Goods (Business to Business MCC)) - `5137` (Men's, Women's and Children's Uniforms (Business to Business MCC)) - `5139` (Commercial Footwear (Business to Business MCC)) - `5169` (Chemicals and Allied Products Not Elsewhere Classified (Business to Business MCC)) - `5172` (Petroleum and Products (Business to Business MCC)) - `5192` (Books, Periodicals and Newspapers (Business to Business MCC)) - `5193` (Florist Suppliers, Nursery Stock & Flowers (Business to Business MCC)) - `5198` (Paints, Varnishes and Supplies (Business to Business MCC)) - `5199` (Non-durable Goods Not Elsewhere Classified (Business to Business MCC)) - `5200` (Home Supply Warehouse) - `5211` (Lumber & Building Materials Stores) - `5231` (Glass, Paint, and Wallpaper Stores) - `5251` (Hardware Stores, Equipment Utilities Regulated) - `5261` (Nurseries and Lawn and Garden Supply Stores) - `5271` (Mobile Home Dealer) - `5300` (Wholesale Club with or without membership fee) - `5309` (Duty Free Stores) - `5310` (Discount Store) - `5311` (Department Stores) - `5331` (Variety Stores) - `5399` (Miscellaneous General Merchandise) - `5411` (Grocery Stores and Supermarkets) - `5422` (Freezer & Locker Meat Provisions) - `5441` (Candy, Nut, and Confectionary Stores) - `5451` (Dairy Product Stores) - `5462` (Bakeries) - `5499` (Miscellaneous Food Stores-Convenience Stores and Specialty Markets) - `5511` (Car and Truck Dealers (New and Used)- Sales, Service, Repairs, Parts, and Leasing) - `5521` (Car and Truck Dealers (Used)- Sales, Service, Repairs, Parts, and Leasing) - `5532` (Automotive Tire Stores) - `5531` (Auto and Home Supply Stores) - `5533` (Automotive Parts and Accessories Stores) - `5541` (Service Stations (with or without Ancillary Services)) - `5542` (Automated Fuel Dispensers) - `5551` (Boat Dealers) - `5561` (Camper, Recreational and Utility Trailer Dealers) - `5571` (Motorcycle Dealers) - `5592` (Motor Home Dealers) - `5598` (Snowmobile Dealers) - `5599` (Miscellaneous Automotive, Aircraft, and Farm Equipment Dealers --Not Elsewhere Classified) - `5611` (Men's & Boys' Clothing and Accessory Stores) - `5621` (Women's Ready-to-Wear Stores) - `5631` (Women's Accessory and Specialty Stores) - `5641` (Children's and Infants' Wear Stores) - `5651` (Family Clothing Stores) - `5655` (Sports and Riding Apparel Stores) - `5661` (Shoe Stores) - `5681` (Furriers & Fur Shops) - `5691` (Men's and Women's Clothing Stores) - `5697` (Tailors, Seamstresses, Mending, Alterations) - `5698` (Wig & Toupee Shops) - `5699` (Miscellaneous Apparel and Accessory Stores) - `5712` (Furniture, Home Furnishings, and Equipment Stores, except Appliances) - `5713` (Floor coverings, Rugs) - `5714` (Drapery, Window Covering, and Upholstery Stores) - `5718` (Fireplaces, Fireplace Screens and Accessories Stores) - `5719` (Miscellaneous Home Furnishing Specialty Stores) - `5722` (Household Appliance Stores) - `5732` (Electronics Stores) - `5733` (Music Stores-Musical Instruments, Pianos, and Sheet Music) - `5734` (Computer Software Stores) - `5735` (Record Stores) - `5811` (Caterers - Prepare & Delivery) - `5812` (Eating Places and Restaurants) - `5813` (Drinking Places (Alcoholic Beverages) - Bars, Taverns, Nightclubs, Cocktail Lounges, and Discotheques) - `5814` (Quick Payment Service-Fast Food Restaurants) - `5815` (Digital Goods – Media, Books, Movies, Music) - `5816` (Digital Goods – Games) - `5817` (Digital Goods – Applications (Excludes Games)) - `5818` (Large Digital Goods Merchant) - `5912` (Drug Stores and Pharmacies) - `5921` (Package Stores--Beer, Wine, and Liquor) - `5931` (Used Merchandise and Secondhand Stores) - `5932` (Antique Shop) - `5933` (Pawn Shop) - `5935` (Wrecking and Salvage Yards) - `5937` (Antique Reproduction Stores) - `5940` (Bicycle Shop-Sales and Services) - `5941` (Sporting Goods Stores) - `5942` (Book Stores) - `5943` (Stationery, Office and School Supply Stores) - `5944` (Jewelry, Watch, Clock, and Silverware Stores) - `5945` (Hobby, Toy and Game Stores) - `5946` (Camera and Photographic Supply Stores) - `5947` (Gift, Card, Novelty, and Souvenir Stores) - `5948` (Luggage and Leather Goods Stores) - `5949` (Sewing, Needlework, Fabric, and Piece Good Stores) - `5950` (Glassware and Crystal Stores) - `5960` (Direct Marketing Insurance Services) - `5961` (Mail Order) - `5962` (Direct Marketing -- Travel Related Arrangement Services) - `5963` (Direct Selling Establishments/Door to Door Sales) - `5964` (Catalog Merchant) - `5965` (Combined Catalog and Retail Merchant) - `5966` (Outbound Telemarketing Merchant) - `5967` (Direct Marketing -- Inbound Telemarketing Merchants) - `5968` (Continuity/Subscription Merchants) - `5969` (Direct Marketing/Direct Marketers--Not Elsewhere Classified) - `5970` (Artist Supply and Craft Stores) - `5971` (Art Dealers and Galleries) - `5972` (Stamp and Coin Stores) - `5973` (Religious Goods Stores) - `5975` (Hearing Aids--Sales, Service, and Supplies) - `5976` (Orthopedic Goods and Prosthetic Devices) - `5977` (Cosmetic Stores) - `5978` (Typewriter Stores--Sales, Service, and Rentals) - `5983` (Fuel Dealers--Fuel Oil, Wood, Coal, and Liquefied Petroleum) - `5992` (Florists) - `5993` (Cigar Stores & Stands) - `5994` (News Dealers & Newsstands) - `5995` (Pet Shops, Pet Food, and Supplies) - `5996` (Swimming Pools--Sales, Supplies, and Services) - `5997` (Electric Razor Stores Sales & Services) - `5998` (Tent and Awning Stores) - `5999` (Miscellaneous & Specialty Retail Stores) - `6010` (Financial Institutions--Manual Cash Disbursements) - `6011` (Financial Institutions--Automated Cash Disbursements) - `6012` (Quasi Cash - Financial Institution - Merchandise and Services) - `6050` (Quasi Cash - Member Financial Institution) - `6051` (MasterCard - Quasi Cash-Merchant) - `6211` (Securities - Brokers and Dealers) - `6300` (Insurance Sales and Underwriting) - `6381` (Insurance - Premiums) - `6399` (Insurance - Not Elsewhere Classified) - `6513` (Real Estate Agents and Managers - Rentals; Property Management) - `6529` (Remote Stored Value Load - Member Financial Institution) - `6530` (Remote Stored Value Load - Merchant) - `6531` (Payment Service Provider) - `6532` (Payment Transaction - Member) - `6533` (Payment Transaction - Merchant) - `6534` (Money Transfer - Member Financial Institution) - `6535` (Value Purchase - Member Financial Institution) - `6536` (MoneySend Intracountry) - `6537` (MoneySend Intercountry) - `6538` (MoneySend Funding) - `6540` (POI Funding Transactions (Excluding MoneySend)) - `7011` (Lodging - Hotels, Motels, and Resorts) - `7012` (Timeshares) - `7032` (Sporting and Recreational Camps) - `7033` (Trailer Parks and Campgrounds) - `7210` (Laundry, Cleaning, and Garment Services) - `7211` (Laundry Services - Family and Commercial) - `7216` (Dry Cleaners) - `7217` (Carpet and Upholstery Cleaning) - `7221` (Photographic Studios) - `7230` (Beauty and Barber Shops) - `7251` (Shoe Repair Shops, Shoe Shine Parlors, and Hat Cleaning Shops) - `7261` (Funeral Services and Crematories) - `7273` (Dating Services) - `7276` (Tax Preparation Services) - `7277` (Counseling Services - Debt, Marriage, and Personal) - `7278` (Buying and Shopping Services and Clubs) - `7296` (Clothing Rental - Costumes, Uniforms and Formal Wear) - `7297` (Massage Parlors) - `7298` (Health and Beauty Spas) - `7299` (Miscellaneous Personal Services - Not Elsewhere Classified) - `7311` (Advertising Services) - `7321` (Consumer Credit Reporting Agencies) - `7332` (Blueprinting and Photocopying Services) - `7333` (Commercial Photography, Art, and Graphics) - `7338` (Quick Copy, Reproduction Service) - `7339` (Stenographic Service) - `7342` (Exterminating and Disinfecting Services) - `7349` (Cleaning, Maintenance & Janitorial Services) - `7361` (Employment Agencies and Temporary Help Services) - `7372` (Computer Programming, Data Processing, and Integrated Systems Design Services) - `7375` (Information Retrieval Services (Business to Business MCC)) - `7379` (Computer Maintenance, Repair and Services (Business to Business MCC)) - `7392` (Management, Consulting, and Public Relations Services) - `7393` (Detective Agencies, Protective Agencies, and Security Services, including Armored Cars and Guard Dogs) - `7394` (Equipment, Tool, Furniture, and Appliance Rental and Leasing) - `7395` (Photofinishing Laboratories and Photo Developing) - `7399` (Business Services) - `7511` (Truck Stops) - `7512` (Automobile Rental Agency) - `7513` (Truck and Utility Trailer Rentals) - `7519` (Motor Home and Recreational Vehicle Rentals) - `7523` (Parking Lots and Garages) - `7524` (Express Payment Service Mechants - Parking Lots and Garages) - `7531` (Automotive Top & Body Shops) - `7534` (Tire Retreading & Repair) - `7535` (Automotive Paint Shops) - `7538` (Automotive Service Shops (Non-Dealer)) - `7542` (Car Washes) - `7549` (Towing Services) - `7622` (Electronic Repair Shops) - `7623` (Air Conditioning and Refrigeration Repair Shops) - `7629` (Electrical and Small Appliance Repair Shops) - `7631` (Watch, Clock, and Jewelry Repair Shops) - `7641` (Furniture - Reupholster, Repair, and Refinishing) - `7692` (Welding Services) - `7699` (Miscellaneous Repair Shops and Related Services) - `7778` (Citishare Cash Advance) - `7800` (Government-Owned Lotteries) - `7801` (Government-Licensed Casinos (Online Gambling)) - `7802` (Government-Licensed Horse/Dog Racing) - `7829` (Motion Picture & Video Tape Production and Distribution (Business to Business MCC)) - `7832` (Motion Picture Theater) - `7841` (DVD/Video Tape Rental Stores) - `7911` (Dance Halls, Studios & Schools) - `7922` (Theatrical Producers (except Motion Pictures) and Ticket Agencies) - `7929` (Bands, Orchestras & Misc Entertainment) - `7932` (Billiards & Pool Establishments) - `7933` (Bowling Alleys) - `7941` (Commercial Sports, Professional Sports Clubs, Athletic Fields, and Sports Promoters) - `7991` (Tourist Attractions and Exhibits) - `7992` (Public Golf Courses) - `7993` (Video Amusement Game Supply) - `7994` (Video Game Arcades and Establishments) - `7995` (Betting, including Lottery Tickets, Casino Gaming Chips, Off- Track Betting, and Wagers at Race Track) - `7996` (Amusement Parks, Circuses, Carnivals, and Fortune Tellers) - `7997` (Membership Clubs (Sports, Recreation, Athletic), Country Clubs, and Private Golf Courses) - `7998` (Aquarium, Seaquarium, Dolphinariums) - `7999` (Recreation Services - Not Elsewhere Classified) - `8011` (Doctors and Physicians - Not Elsewhere Classified) - `8021` (Dentists and Orthodontists) - `8031` (Osteopathic Physicians) - `8041` (Chiropractors) - `8042` (Optometrists and Ophthalmologists) - `8043` (Opticians, Optical Goods and Eyeglasses) - `8049` (Podiatrists and Chiropodists) - `8050` (Nursing and Personal Care Facilities) - `8062` (Hospitals) - `8071` (Medical and Dental Laboratories) - `8099` (Medical Services Health Practitioners - No Elsewhere Classified) - `8111` (Legal Services and Attorneys) - `8211` (Elementary and Secondary Schools) - `8220` (Colleges, Universities, Professional Schools, and Junior Colleges) - `8241` (Correspondence Schools) - `8244` (Business and Secretarial Schools) - `8249` (Trade and Vocational Schools) - `8299` (Schools and Educational Services - Not Elsewhere Classified) - `8351` (Child Care Services) - `8398` (Charitable and Social Service Organizations) - `8641` (Civic, Social, and Fraternal Associations) - `8651` (Political Organizations) - `8661` (Religious Organizations) - `8675` (Automobile Associations) - `8699` (Membership Organizations - Not Elsewhere Classified) - `8734` (Testing Laboratories (Not Medical) - (Business to Business MCC)) - `8911` (Architectural, Engineering, and Surveying Services) - `8931` (Accounting, Auditing, and Bookkeeping Services) - `8999` (Professional Services - Not Elsewhere Classified) - `9211` (Court Costs, including Alimony and Child Support) - `9222` (Fines) - `9223` (Bail & Bond Payments) - `9311` (Tax Payments) - `9399` (Government Services - Not Elsewhere Classified) - `9401` (i-Purchasing) - `9402` (Postal Services) - `9405` (U.S. Fed Government Agencies) - `9700` (Automated Referral Service) - `9701` (Visa Credential Server) - `9702` (GCAS Emergency Services) - `9751` (U.K. Supermarkets, Electronic Hot File) - `9752` (U.K. Petrol Stations, Electronic Hot File) - `9753` (Consumer Electronics/Furniture Store) - `9754` (Quasi Cash - Gambling-Horse Racing, Dog Racing, State Lotteries) - `9950` (Intra-Company Purchases) example: '0742' PeriodicPaymentRequest: required: - frequency type: object properties: frequency: $ref: '#/components/schemas/FrequencyRequest' numberOfPayments: type: integer description: >- __Conditional__. Defines the total number of payments to be made. This is required if `finalPaymentDateTime` is not specified and it is intended for the periodic payment have a fixed amount of payments. format: int32 example: 5 nextPaymentDateTime: type: string description: >- __Conditional__. Defines when to start the recurring payment date and time. Specify this if you want the first payment to start on a different day than what the frequency object defines. format: date-time example: '2018-01-10T00:00:00Z' nextPaymentAmount: $ref: '#/components/schemas/Amount' finalPaymentDateTime: type: string description: >- __Conditional__. Defines the final payment date and time. To create an open-ended periodic payment, do not specify this property. format: date-time example: '2030-01-10T00:00:00Z' finalPaymentAmount: $ref: '#/components/schemas/Amount' description: >- __Conditional__. Used to specify properties to define a periodic payment. Must be specified when the payment `type` is one of the following: - `DOMESTIC_PERIODIC_PAYMENT` - `INTERNATIONAL_PERIODIC_PAYMENT` InternationalPaymentRequest: required: - currencyOfTransfer type: object properties: currencyOfTransfer: type: string description: >- __Mandatory__. The currency to be transferred to the payee. This may differ from the currency the payment is denoted in and the currency of the payer's account. Specified as a 3-letter code (ISO 4217). exchangeRateInformation: $ref: '#/components/schemas/ExchangeRateInformation' purpose: type: string description: >- __Optional__. Used to indicate the external purpose as a [ISO20022 purpose code](https://www.rba.hr/documents/20182/183267/External+purpose+codes+list/8a28f888-1f83-5e29-d6ed-fce05f428689?version=1.1) value. priority: $ref: '#/components/schemas/PriorityCodeEnum' chargeBearer: $ref: '#/components/schemas/ChargeBearerType' description: >- __Conditional__. Used to specify properties to define an international payment. Must be specified when the payment `type` is one of the following: - `INTERNATIONAL_SINGLE_PAYMENT` - `INTERNATIONAL_SCHEDULED_PAYMENT` - `INTERNATIONAL_PERIODIC_PAYMENT` Amount: title: Amount Details required: - amount - currency type: object properties: amount: title: Amount type: number description: __Mandatory__. The monetary value example: 10 currency: title: Currency type: string description: >- __Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code example: GBP description: __Mandatory__. Monetary Amount. RateTypeEnum: type: string description: __Mandatory__. The type used to complete the currency exchange. enum: - ACTUAL - AGREED - INDICATIVE AccountIdentification: title: Account Identifications required: - type - identification type: object properties: type: $ref: '#/components/schemas/AccountIdentificationType' identification: title: Account Identification type: string description: >- __Mandatory__. The value associated with the account identification type. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values. example: '401016' Address: title: Address Details type: object properties: addressLines: title: Address Lines type: array description: __Optional__. The address line of the address example: - Ardenham Court items: type: string streetName: title: Street type: string description: __Optional__. The street name of the address example: Oxford Road buildingNumber: title: Building Number type: string description: __Optional__. The building number of the address example: '45' postCode: title: Post Code type: string description: __Optional__. The post code of the address example: HP19 3EQ townName: title: Town type: string description: __Optional__. The town name of the address example: Aylesbury county: title: County type: array description: __Optional__. The list of counties for the address example: - Buckinghamshire items: type: string country: title: Country type: string description: >- __Conditional__. The 2-letter country code for the address. An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment example: GB department: title: Department type: string description: __Optional__. The department for the address example: Unit 2 subDepartment: title: Sub-Department type: string description: __Optional__. The sub-department for the address example: Floor 3 addressType: $ref: '#/components/schemas/AddressTypeEnum' description: >- __Conditional__. The address of the `Payee` or `Payer`. - `payee.address` is mandatory when the `paymentType` is an `INTERNATIONAL` payment - An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment. example: country: GB PayeeAccountType: title: Payee Account Type type: string description: >- __Optional__. The payee account type. Allowed values: BUSINESS, BUSINESS_SAVING, CHARITY, COLLECTION, CORPORATE, E_WALLET, GOVERNMENT, INVESTMENT, INVESTMENT_ISA, JOINT_PERSONAL, PENSION, PERSONAL, PERSONAL_SAVING, PREMIER, WEALTH . FrequencyRequest: required: - type type: object properties: type: $ref: '#/components/schemas/FrequencyEnumExtended' intervalWeek: type: integer description: >- __Conditional__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information format: int32 example: 1 intervalMonth: type: integer description: >- __Conditional__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information format: int32 example: 1 executionDay: type: integer description: >- __Conditional__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information format: int32 example: 1 description: __Mandatory__. Defines the intervals at which payment should be made. ExchangeRateInformation: required: - rateType - unitCurrency type: object properties: unitCurrency: type: string description: >- __Mandatory__. The currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is `GBP`. rate: type: number description: >- __Optional__. The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. rateType: $ref: '#/components/schemas/RateTypeEnum' foreignExchangeContractReference: type: string description: >- __Optional__. The unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. description: >- __Optional__. Used to provide details on the currency exchange rate and contract. PriorityCodeEnum: type: string enum: - NORMAL - URGENT ChargeBearerType: type: string description: >- __Conditional__. Depending on the bank and payment type for international Euro payments. The field ChargeBearer specifies which party/parties will bear the charges associated with the processing of the payment transaction. Valid values are: - `DEBT` - All transaction charges are to be borne by the debtor. - `CRED` - All transaction charges are to be borne by the creditor. - `SHAR` - In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor - `SLEV` - Charges are to be applied following the rules agreed in the service level and/or scheme. enum: - DEBT - CRED - SHAR - SLEV AccountIdentificationType: title: Account Identification Type type: string description: |- __Mandatory__. Used to describe the format of the account. See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type. example: SORT_CODE enum: - SORT_CODE - ACCOUNT_NUMBER - IBAN - BBAN - BIC - PAN - MASKED_PAN - MSISDN - BSB - NCC - ABA - ABA_WIRE - ABA_ACH - EMAIL - ROLL_NUMBER - BLZ - IFS - CLABE - CTN - BRANCH_CODE - VIRTUAL_ACCOUNT_ID AddressTypeEnum: title: Address Type type: string description: __Optional__. The type of address enum: - BUSINESS - CORRESPONDENCE - DELIVERY_TO - MAIL_TO - PO_BOX - POSTAL - RESIDENTIAL - STATEMENT - UNKNOWN FrequencyEnumExtended: type: string description: >- __Mandatory__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information enum: - DAILY - EVERY_WORKING_DAY - CALENDAR_DAY - WEEKLY - EVERY_TWO_WEEKS - MONTHLY - EVERY_TWO_MONTHS - QUARTERLY - SEMIANNUAL - ANNUAL securitySchemes: basicAuth: description: >- Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the [Yapily Console](https://console.yapily.com/). See [Authentication](/api-reference/authentication) for details. scheme: basic type: http ````