openapi: 3.0.1 info: title: Yapily Variable Recurring Payments API description: Variable Recurring Payments (VRP) endpoints for sweeping and commercial VRP flows including consent, funds confirmation, and execution. version: 12.4.0 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: "Variable Recurring Payments enables transfer of money between accounts held by the same person or transfer\ \ of money for business payments. \n\nIn 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. \n\nSee [VRP Payments](/payments/vrps/additional-information)\ \ for more information." name: Variable Recurring Payments paths: /variable-recurring-payments/sweeping/consents: post: description: 'Initiate authorisation for a Sweeping [VRP](/payments/vrps/introduction) consent. The response will contain an Authorisation URL and the associated Consent ID. The user will have to complete authorisation of the consent at their institution via [Redirect Flows](/getting-started/glossary#redirect-flow), after which you will be able to use the authorised consent to create payments. Feature: - `INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING`' operationId: createSweepingAuthorisation x-mint: content: 'Learn more: [Variable Recurring Payments](/payments/vrps/introduction)' requestBody: content: application/json;charset=UTF-8: examples: UK Sweeping VRP Authorisation Request: description: UK Sweeping VRP Authorisation Request value: userUuid: 5350782b-60f3-489e-aae5-a24d8d679a07 institutionId: modelo-sandbox callback: https://display-parameters.com/ controlParameters: psuAuthenticationMethods: - SCA_NOT_REQUIRED maxAmountPerPayment: amount: 10 currency: GBP periodicLimits: - totalMaxAmount: amount: 50 currency: GBP frequency: MONTHLY alignment: CONSENT initiationDetails: reference: My Sweeping VRP payer: name: Jane Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '332211' payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '112233' schema: $ref: '#/components/schemas/VrpSweepingAuthorisationRequest' required: true responses: '201': description: Created content: application/json;charset=UTF-8: examples: UK Domestic Sweeping VRP Authorisation Response: description: UK Domestic Sweeping VRP Authorisation Response value: meta: tracingId: 96169af01d394ad39658f17d53b49a5d data: id: a2a9ec77-a479-4996-9896-4568e1968e7a userUuid: 5350782b-60f3-489e-aae5-a24d8d679a07 applicationUserId: user000 institutionId: modelo-sandbox status: AWAITING_AUTHORIZATION createdAt: '2026-01-01T10:25:13Z' featureScope: - EXISTING_PAYMENTS_DETAILS - EXISTING_PAYMENT_INITIATION_DETAILS - CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING - VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION - INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING 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 controlParameters: psuAuthenticationMethods: - SCA_NOT_REQUIRED maxAmountPerPayment: amount: 10 currency: GBP periodicLimits: - totalMaxAmount: amount: 50 currency: GBP frequency: MONTHLY alignment: CONSENT initiationDetails: reference: My Sweeping VRP payer: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '332211' payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '112233' schema: $ref: '#/components/schemas/ApiResponseOfVrpSweepingAuthorisationResponse' '401': content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 401 status: UNAUTHORIZED supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: CREDENTIALS code: CREDENTIALS_MISSING message: Authentication header not present schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response default: content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 400 status: BAD_REQUEST supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: BAD_REQUEST code: BAD_REQUEST message: The server could not understand the request due to invalid syntax schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response summary: Create Sweeping Vrp Authorisation tags: - Variable Recurring Payments /variable-recurring-payments/sweeping/consents/{consentId}: get: description: 'Get Sweeping [VRP](/payments/vrps/introduction) consent details from the Consent ID. Feature: `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING`' operationId: getSweepingVrpConsentById parameters: - description: The Consent ID to retrieve. in: path name: consentId required: true schema: type: string format: uuid responses: '200': description: OK content: application/json;charset=UTF-8: examples: UK Sweeping VRP Consent Details Response: description: Get Sweeping Variable Recurring Payments Consent Example Response value: meta: tracingId: 679e7bb6cd45416a9a9a8d004c5315da data: id: 56a42244-414a-4b52-8c4f-4ad2a50e82fe userUuid: ca412fdf-5a30-43a2-88b7-5964a24a8e55 applicationUserId: string institutionId: modelo-sandbox status: AUTHORIZED createdAt: '2021-06-08T10:59:35.138Z' featureScope: - EXISTING_PAYMENTS_DETAILS - EXISTING_PAYMENT_INITIATION_DETAILS - CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING - VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION - INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING consentToken: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg state: a09f8ff9c1284444aa635267e05f76e1 authorizedAt: '2021-06-08T10:59:53.288Z' institutionConsentId: aac-605d48f2-2a0e-4594-81a9-996524fa3b2a controlParameters: psuAuthenticationMethods: - SCA_NOT_REQUIRED periodicLimits: - totalMaxAmount: amount: 100 currency: GBP frequency: DAILY alignment: CONSENT maxAmountPerPayment: amount: 10 currency: GBP payer: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '654321' initiationDetails: reference: Own Account Sweeping payer: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '654321' payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '123456' schema: $ref: '#/components/schemas/ApiResponseOfVrpSweepingAuthorisationResponse' '401': content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 401 status: UNAUTHORIZED supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: CREDENTIALS code: CREDENTIALS_MISSING message: Authentication header not present schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response default: content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 400 status: BAD_REQUEST supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: BAD_REQUEST code: BAD_REQUEST message: The server could not understand the request due to invalid syntax schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response summary: Get Sweeping Vrp Consent Details tags: - Variable Recurring Payments x-mint: content: 'Learn more: [VRP Consent Details](/payments/vrps/get-started#get-consent-details)' /variable-recurring-payments/funds-confirmation: post: description: 'Check whether the requested funds amount is available on the [VRP](/payments/vrps/introduction) consent. Note that you should not call this before each VRP payment submission because we do it for you. Required feature: `VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION`' operationId: createVrpFundsConfirmation parameters: - description: The user's VRP [Consent Token](/getting-started/glossary#consent-token) example: '{consentToken}' in: header name: consent required: true schema: type: string requestBody: content: application/json;charset=UTF-8: examples: UK VRP Funds Confirmation Request: description: UK VRP Funds Confirmation Request value: reference: Own Account Sweeping paymentAmount: amount: 10 currency: GBP schema: $ref: '#/components/schemas/VrpFundsConfirmationRequest' required: true responses: '201': description: Created content: application/json;charset=UTF-8: examples: UK VRP Funds Confirmation Response: description: UK VRP Funds Confirmation Response value: meta: tracingId: 0f14e900011b445fa6b6c2c4272d7321 data: id: a9582f8e-08be-4cca-9f01-1ad3be96532d fundsAvailable: fundsAvailable: true fundsAvailableAt: '2021-06-08T10:59:35.138Z' reference: Own Account Sweeping paymentAmount: amount: 10 currency: GBP schema: $ref: '#/components/schemas/ApiResponseOfVrpFundsConfirmationResponse' '401': content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 401 status: UNAUTHORIZED supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: CREDENTIALS code: CREDENTIALS_MISSING message: Authentication header not present schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response default: content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 400 status: BAD_REQUEST supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: BAD_REQUEST code: BAD_REQUEST message: The server could not understand the request due to invalid syntax schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response summary: Confirm Funds for Vrp Payment tags: - Variable Recurring Payments x-mint: content: 'Learn more: [Confirm Availability of Funds](/payments/vrps/get-started#confirm-availability-of-funds)' /variable-recurring-payments/payments: post: description: 'Submit payment on the [VRP](/payments/vrps/introduction) consent. Required feature: `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING` or `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL`' operationId: createVrpPayment parameters: - description: The user's VRP [Consent Token](/getting-started/glossary#consent-token) example: '{consentToken}' in: header name: consent required: true schema: type: string requestBody: content: application/json;charset=UTF-8: examples: UK VRP Payment Request: description: UK VRP Payment Request value: paymentIdempotencyId: 234g87t58tgeuo848wudjew489 psuAuthenticationMethod: SCA_NOT_REQUIRED paymentAmount: amount: 10 currency: GBP schema: $ref: '#/components/schemas/VrpSubmissionRequest' required: true responses: '201': description: Created content: application/json;charset=UTF-8: examples: UK VRP Payment Response: description: UK VRP Payment Response value: meta: tracingId: 0f14e900011b445fa6b6c2c4272d7321 data: id: a9582f8e-08be-4cca-9f01-1ad3be96532d paymentIdempotencyId: 234g87t58tgeuo848wudjew489 institutionConsentId: PF23232222DD status: COMPLETED statusDetails: status: COMPLETED isoStatus: code: ACCP name: AcceptedCustomerProfile initiationDetails: reference: Own Account Sweeping payer: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '654321' payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '123456' submissionDetails: reference: Own Account Sweeping payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '123456' paymentAmount: amount: 10 currency: GBP payer: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '654321' refundAccount: accountIdentifications: - identification: '400400' type: SORT_CODE - identification: '99999999' type: ACCOUNT_NUMBER name: Refund Account expectedSettlementTime: '2022-03-02T12:00:00.000Z' expectedExecutionTime: '2022-03-02T12:00:00.000Z' schema: $ref: '#/components/schemas/ApiResponseOfVrpSubmissionResponse' '401': content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 401 status: UNAUTHORIZED supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: CREDENTIALS code: CREDENTIALS_MISSING message: Authentication header not present schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response default: content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 400 status: BAD_REQUEST supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: BAD_REQUEST code: BAD_REQUEST message: The server could not understand the request due to invalid syntax schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response summary: Create Vrp Payment tags: - Variable Recurring Payments x-mint: content: 'Learn more: [Execute VRP Payments](/payments/vrps/get-started#execute-a-payment)' /variable-recurring-payments/payments/{paymentId}/details: get: description: 'Get [VRP](/payments/vrps/introduction) payment details from the Payment ID. Features: `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING` or `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL`' operationId: getVrpPaymentDetails parameters: - description: __Mandatory__. The Payment Id of the `Variable Recurring Payments` to retrieve. in: path name: paymentId required: true schema: type: string - description: __Mandatory__. The [Consent Token](/getting-started/glossary#consent-token) containing the user's authorisation to make the `Variable Recurring Payments` request. in: header name: consent required: true schema: type: string responses: '200': description: OK content: application/json;charset=UTF-8: examples: UK VRP Payment Details Response: description: UK VRP Payment Details Response value: meta: tracingId: 679e7bb6cd45416a9a9a8d004c5315da data: id: a9582f8e-08be-4cca-9f01-1ad3be96532d paymentIdempotencyId: 234g87t58tgeuo848wudjew489 institutionConsentId: PF23232222DD status: COMPLETED statusDetails: status: COMPLETED isoStatus: code: ACCP name: AcceptedCustomerProfile initiationDetails: reference: Own Account Sweeping payer: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '654321' payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '123456' submissionDetails: reference: Own Account Sweeping payee: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '12345678' - type: SORT_CODE identification: '123456' paymentAmount: amount: 10 currency: GBP payer: name: John Doe accountIdentifications: - type: ACCOUNT_NUMBER identification: '87654321' - type: SORT_CODE identification: '654321' refundAccount: accountIdentifications: - identification: '400400' type: SORT_CODE - identification: '99999999' type: ACCOUNT_NUMBER name: Refund Account expectedSettlementTime: '2022-03-02T12:00:00.000Z' expectedExecutionTime: '2022-03-02T12:00:00.000Z' schema: $ref: '#/components/schemas/ApiResponseOfVrpSubmissionResponse' '401': content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 401 status: UNAUTHORIZED supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: CREDENTIALS code: CREDENTIALS_MISSING message: Authentication header not present schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response default: content: application/json;charset=UTF-8: examples: Error Response: description: Error Response value: error: tracingId: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 400 status: BAD_REQUEST supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: BAD_REQUEST code: BAD_REQUEST message: The server could not understand the request due to invalid syntax schema: $ref: '#/components/schemas/ApiErrorResponse' description: Error Response summary: Get Vrp Payment Details tags: - Variable Recurring Payments x-mint: content: 'Learn more: [VRP Paymenent Details](/payments/vrps/get-started#get-vrp-payment-details)' components: schemas: 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.\n\n 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' AccountIdentificationType: title: Account Identification Type type: string description: "__Mandatory__. Used to describe the format of the account.\n\n 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 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. \n\nAn `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 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 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. ApiErrorResponse: type: object properties: error: $ref: '#/components/schemas/ErrorDetails' 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/...) and any [Payments](/api-reference/...) 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/...) - `424` - Returned by any [Financial Data](/api-reference/...) and any [Payments](/api-reference/...) 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: 0c2d0973bdd24224a65e5d0f7d1b6154 code: 400 status: BAD_REQUEST supportUrl: https://support.yapily.com/ source: YAPILY issues: - type: INVALID_REQUEST code: INVALID_PROPERTY_UNEXPECTED_VALUE parameter: $.payer.accountidentifications.type message: Type Should be one of [PAN, SORT_CODE, ACCOUNT_NUMBER] institutionError: errorMessage: '{"Code":"400 BadRequest","Id":"3517bfc2-c3ee-4f2f-b4f8-12f62478e0d1","Message":"No Resource found","Errors":[{"ErrorCode":"UK.OBIE.Resource.NotFound","Message":"No resource found corresponding to the consent id"}]}' httpStatusCode: 400 ApiResponseOfVrpFundsConfirmationResponse: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' data: $ref: '#/components/schemas/VrpFundsConfirmationResponse' links: type: object additionalProperties: type: string forwardedData: type: array items: $ref: '#/components/schemas/ResponseForwardedData' tracingId: type: string writeOnly: true raw: deprecated: true type: array items: $ref: '#/components/schemas/RawResponse' ApiResponseOfVrpSubmissionResponse: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' data: $ref: '#/components/schemas/VrpSubmissionResponse' links: type: object additionalProperties: type: string forwardedData: type: array items: $ref: '#/components/schemas/ResponseForwardedData' tracingId: type: string writeOnly: true raw: deprecated: true type: array items: $ref: '#/components/schemas/RawResponse' ApiResponseOfVrpSweepingAuthorisationResponse: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' data: $ref: '#/components/schemas/VrpSweepingAuthorisationResponse' links: type: object additionalProperties: type: string forwardedData: type: array items: $ref: '#/components/schemas/ResponseForwardedData' tracingId: type: string writeOnly: true raw: deprecated: true type: array items: $ref: '#/components/schemas/RawResponse' 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 ErrorDetails: required: - tracingId - code - status type: object properties: tracingId: type: string description: Unique identifier of the request, used by Yapily for support purposes code: type: integer format: int32 description: Numeric HTTP status code associated with the error status: type: string description: Textual description of the HTTP status supportUrl: type: string description: Link to where further information regarding the error can be found source: type: string description: Source of the error. This may be YAPILY, the INSTITUTION, or the USER issues: type: array description: List of issues relating to the error items: $ref: '#/components/schemas/ErrorIssue' ErrorIssue: required: - type - code type: object description: Detailed information regarding the issue that was experienced during processing of the request properties: type: type: string description: Category of the issue code: type: string description: Code that uniquely identifies the type of issue parameter: type: string description: Identifies the parameter / property within the request (headers, query parameters or body) that the issue relates to. For headers and query parameters, it refers to the parameter name. For the body, it refers to the JSONPath of the property message: type: string description: Human readable description of the issue that was experienced institutionError: $ref: '#/components/schemas/InstitutionError' FeatureEnum: type: string description: "Used to describe what functions are supported by the associated `Institution`. \n\nFor more information\ \ on each feature, see the following links: \n\n- [Financial Data Features](/data/financial-data-resources/financial-data-features)\n\ - [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 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 MultiAuthorisation: type: object description: Details the additional levels of authorisation which are required from, and being managed by, the `Institution`. properties: status: type: string description: __Mandatory__. Specifies the current status of the multi-authorisation flow. numberOfAuthorisationRequired: type: integer description: __Mandatory__. Total number of authorisations required. format: int32 numberOfAuthorisationReceived: type: integer description: __Mandatory__. The total number of authorisations that have been received. format: int32 lastUpdatedDateTime: type: string description: __Mandatory__. Date and time of when the authorisation was last updated. format: date-time expirationDateTime: type: string description: __Mandatory__. Date and time by when the authorisation flow must be completed before it expires and the authorisation request is terminated. format: date-time 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' PayeeAccountType: title: Payee Account Type type: string description: "__Optional__. The payee account type. \n\nAllowed values: BUSINESS, BUSINESS_SAVING, CHARITY, COLLECTION,\ \ CORPORATE, E_WALLET, GOVERNMENT, INVESTMENT, INVESTMENT_ISA, JOINT_PERSONAL, PENSION, PERSONAL, PERSONAL_SAVING,\ \ PREMIER, WEALTH ." 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]. PaymentIsoStatus: type: object description: The payment status code, as denoted by a 3-letter ISO 20022 code. properties: code: $ref: '#/components/schemas/PaymentIsoStatusCodeEnum' name: type: string description: The full name of the ISO 20022 `PaymentStatusCode`. example: AcceptedCreditSettlementCompleted PaymentIsoStatusCodeEnum: type: string description: The ISO 20022 `PaymentStatusCode`. example: ACCC enum: - ACCC - ACCP - ACSC - ACSP - ACTC - ACWC - ACWP - RCVD - PDNG - RJCT - CANC - ACFC - PATC - PART - ACCO PaymentStatus: type: string description: "The status of the Payment. \n\nFor more information, see [Payment Status](/guides/payments/payment-status/)" enum: - PENDING - FAILED - DECLINED - COMPLETED - COMPLETED_SETTLEMENT_IN_PROCESS - EXPIRED - UNKNOWN - ACTIVE - INACTIVE PaymentStatusDetails: type: object properties: status: $ref: '#/components/schemas/PaymentStatus' statusReason: type: string statusReasonDescription: type: string statusUpdateDate: type: string format: date-time multiAuthorisationStatus: $ref: '#/components/schemas/MultiAuthorisation' isoStatus: $ref: '#/components/schemas/PaymentIsoStatus' 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 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 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`. RefundAccount: type: object description: The account to which funds should be returned if the payment is to be later refunded. properties: name: type: string accountIdentifications: uniqueItems: true type: array items: $ref: '#/components/schemas/AccountIdentification' ResponseForwardedData: type: object properties: headers: type: object additionalProperties: type: string url: type: string ResponseMeta: type: object properties: tracingId: type: string VrpComplianceData: type: object properties: payer: $ref: '#/components/schemas/VrpComplianceDataPayer' description: __Conditional__. Information needed to complete compliance checks. Mandatory for Yapily Connect customers. VrpComplianceDataAddress: type: object required: - addressLine1 - townName - postCode - country properties: addressLine1: type: string example: 123 Queens Street description: __Mandatory__. AddressLine1 of the business. addressLine2: type: string example: Unit 13 description: __Optional__. AddressLine2 of the business. townName: type: string example: York description: __Mandatory__. Town name of the business. postCode: type: string example: '12345' description: __Mandatory__. Post code of the business. country: type: string example: GB description: __Mandatory__. Country of the business. description: This is the registered company or trading address of your end user. VrpComplianceDataBusiness: type: object required: - name - registrationNumber - registeredAddress properties: name: type: string example: Company LTD description: This is the registered company name of your end user. registrationNumber: type: string example: COM123NO description: This is the registered company number of the business. registeredAddress: $ref: '#/components/schemas/VrpComplianceDataAddress' tradingAddress: $ref: '#/components/schemas/VrpComplianceDataAddress' description: __Conditional__. Mandatory if the type is BUSINESS. VrpComplianceDataIndividual: type: object required: - name - birthDate properties: name: type: string example: John Doe description: This is the first and last name of your end user. birthDate: type: string format: date example: '2000-08-12' description: This is the date of birth of your end user. description: __Conditional__. Mandatory if the type is INDIVIDUAL. VrpComplianceDataPayer: type: object required: - type properties: type: type: string example: INDIVIDUAL description: 'The payer type. Allowed values: INDIVIDUAL, BUSINESS. The corresponding object must be included.' individual: $ref: '#/components/schemas/VrpComplianceDataIndividual' business: $ref: '#/components/schemas/VrpComplianceDataBusiness' description: __Conditional__. Payer details required for compliance checks. VrpControlParameters: type: object description: The definition of VRP parameters. required: - psuAuthenticationMethods - maxAmountPerPayment - periodicLimits properties: psuAuthenticationMethods: type: array items: type: string description: '__Mandatory__. Defines the authentication method(s) allowed in payment submission step. Allowed values are [`SCA_REQUIRED`, `SCA_NOT_REQUIRED`].' maxAmountPerPayment: allOf: - $ref: '#/components/schemas/Amount' description: __Mandatory__. The maximum amount that will be allowed per VRP payment. periodicLimits: type: array description: 'The maximum amount over all VRP payments within the specified periods. For instance, a `MONTHLY` limit of `20 GBP`. See [VRP Mandate Details](/payments/vrps/mandate-details).' items: $ref: '#/components/schemas/VrpPeriodicLimits' validFrom: type: string format: date-time description: __Optional__. The start date when the consent becomes valid. validTo: type: string format: date-time description: __Optional__. The end date when the consent expires and becomes invalid. VrpFundsAvailable: required: - fundsAvailable - fundsAvailableAt type: object properties: fundsAvailable: type: boolean description: __Mandatory__. The flag indicating whether the funds are available. fundsAvailableAt: type: string format: date-time description: __Mandatory__. The datetime when the funds were checked. VrpFundsConfirmationRequest: type: object required: - paymentAmount properties: paymentAmount: $ref: '#/components/schemas/Amount' reference: type: string description: __Optional__. The reference/description associated with the VRP consent. Limited to a maximum of 18 characters long. VrpFundsConfirmationResponse: required: - paymentAmount - fundsAvailable type: object properties: id: type: string reference: type: string description: The payment reference or description. Limited to a maximum of 18 characters long. example: Own Account Sweeping paymentAmount: $ref: '#/components/schemas/Amount' fundsAvailable: $ref: '#/components/schemas/VrpFundsAvailable' VrpInitiationDetails: type: object description: The definition of the payer and payee. properties: reference: type: string description: The reference/description of the payments that will be carried out on this VRP consent. payer: $ref: '#/components/schemas/Payer' ultimatePayer: $ref: '#/components/schemas/VrpUltimatePayer' payee: $ref: '#/components/schemas/Payee' ultimatePayee: $ref: '#/components/schemas/VrpUltimatePayee' VrpPeriodicLimits: required: - frequency - totalMaxAmount - alignment type: object properties: frequency: type: string description: '__Mandatory__. The frequency/period over which the limit is enforced. Allowed values are [`DAILY`, `WEEKLY`, `EVERY_TWO_WEEKS`, `MONTHLY`, `YEARLY`].' totalMaxAmount: allOf: - $ref: '#/components/schemas/Amount' description: '__Mandatory__. The maximum amount that will be allowed over the specified frequency/period. If the `alignment` is set to `CALENDAR`, then the limit will be [pro-rated](/payments/vrps/mandate-details#pro-rata-calculation) in the first period to the remaining number of days.' alignment: type: string description: '__Mandatory__. The alignment of the frequency/period for which the limit is enforced. Allowed values are [`CONSENT`, `CALENDAR`]. See [VRP Mandate Details](/payments/vrps/mandate-details).' VrpSubmissionDetails: type: object description: __Mandatory__. The payment submission object defining the details of the payment instruction to be executed under the Variable Recurring Payment. required: - payee - paymentAmount properties: reference: type: string description: __Optional__. The reference/description associated with the VRP consent. Limited to a maximum of 18 characters long. example: Own Account Sweeping payee: $ref: '#/components/schemas/Payee' paymentAmount: $ref: '#/components/schemas/Amount' VrpSubmissionRequest: type: object required: - paymentIdempotencyId - psuAuthenticationMethod - paymentAmount properties: paymentIdempotencyId: type: string description: '__Mandatory__. A unique identifier for the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.' psuAuthenticationMethod: type: string description: '__Mandatory__. Defines the authentication method(s) allowed in payment submission step. Allowed values are [`SCA_REQUIRED`, `SCA_NOT_REQUIRED`]. See [SCA](/getting-started/glossary#strong-customer-authentication-sca).' paymentAmount: $ref: '#/components/schemas/Amount' description: __Mandatory__. The payment request object defining the details of the payment for execution under the Variable Recurring Payment consent. VrpSubmissionResponse: type: object required: - initiationDetails - submissionDetails properties: id: type: string description: The Payment ID. paymentIdempotencyId: type: string description: The Payment Idempotency ID (as provided in the request). paymentLifecycleId: type: string institutionConsentId: type: string description: The Institution's Consent ID on which the payment was submitted. Note that this cannot be used to interact with Yapily API. status: $ref: '#/components/schemas/PaymentStatus' statusDetails: $ref: '#/components/schemas/PaymentStatusDetails' initiationDetails: $ref: '#/components/schemas/VrpInitiationDetails' submissionDetails: $ref: '#/components/schemas/VrpSubmissionDetails' payer: $ref: '#/components/schemas/Payer' refundAccount: $ref: '#/components/schemas/RefundAccount' expectedExecutionTime: type: string format: date-time expectedSettlementTime: type: string format: date-time riskDetails: $comment: 'NOTE: This model is shared between Sweeping and Commercial, but we use VrpSweepingRiskDetails because it is minimal and sufficient!' $ref: '#/components/schemas/VrpSweepingRiskDetails' VrpSweepingAuthorisationRequest: required: - institutionId - controlParameters - initiationDetails type: object properties: userUuid: type: string format: uuid description: __Conditional.__ The Yapily User UUID. One of `userUuid` or `applicationUserId` must be present in the request. applicationUserId: type: string description: __Conditional.__ The Application User ID. One of `userUuid` or `applicationUserId` must be present in the request. institutionId: type: string description: The Institution ID which will carry out authorisation. 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#callback-url) for more information.' redirect: $ref: '#/components/schemas/RedirectRequest' forwardParameters: type: array description: Any parameters that you may want to get forwarded in the callback request after the PSU is redirected. items: type: string oneTimeToken: type: boolean description: '__Conditional__. Set to `true` to receive a `oneTimeToken` instead of `consentToken` at the `callback`. This is used for additional security and can only be used when the `callback` is set. See [Using a One-Time Token](/open-banking-flow/handling-redirects/callback-url#using-a-ott) for more information.' controlParameters: $ref: '#/components/schemas/VrpControlParameters' initiationDetails: $ref: '#/components/schemas/VrpInitiationDetails' complianceData: $ref: '#/components/schemas/VrpComplianceData' VrpSweepingAuthorisationResponse: type: object properties: id: type: string format: uuid description: The Consent ID. userUuid: type: string format: uuid description: The Yapily User UUID (when provided in the request). applicationUserId: type: string description: The Application User ID (when provided in the request). institutionId: type: string description: The Institution ID which carried out authorisation. status: $ref: '#/components/schemas/AuthorisationStatus' createdAt: type: string format: date-time description: The datetime when this consent was created. featureScope: uniqueItems: true type: array description: The set of features associated with this consent. items: $ref: '#/components/schemas/FeatureEnum' consentToken: type: string description: The [Consent Token](/getting-started/glossary#consent-token) containing the user's authorisation to make the payment request. state: type: string authorizedAt: type: string format: date-time institutionConsentId: type: string description: The Institution's Consent ID. Note that this cannot be used to interact with Yapily API. authorisationUrl: type: string description: The Institution's URL to complete authorisation. qrCodeUrl: type: string description: The QR code associated with the `authorisationUrl`. This provides a way for the user to access the URL via their mobile device. controlParameters: $ref: '#/components/schemas/VrpControlParameters' payer: $ref: '#/components/schemas/Payer' initiationDetails: $ref: '#/components/schemas/VrpInitiationDetails' riskDetails: $ref: '#/components/schemas/VrpSweepingRiskDetails' VrpSweepingRiskDetails: type: object description: The details required by the institutions to detect and prevent fraud. properties: paymentContextCode: type: string VrpUltimatePayee: type: object properties: name: type: string accountIdentifications: uniqueItems: true type: array items: $ref: '#/components/schemas/AccountIdentification' legalEntityIdentification: type: string accountType: $ref: '#/components/schemas/PayeeAccountType' address: $ref: '#/components/schemas/Address' merchantId: type: string merchantCategoryCode: type: string VrpUltimatePayer: type: object properties: name: type: string accountIdentifications: uniqueItems: true type: array items: $ref: '#/components/schemas/AccountIdentification' legalEntityIdentification: type: string address: $ref: '#/components/schemas/Address' 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