openapi: 3.0.1
info:
title: Yapily Platform API
description: Manage Applications, Users, Application Management, Constraints, and Webhooks for the Yapily Open Banking platform.
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: 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: Application Management endpoints help with creating and managing client sub-applications.
name: Application Management
- 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: The constraints endpoints can be used to retrieve institution specific data requirements and rules that will
apply when performing other operations.
name: Constraints
- description: Webhook endpoints
name: Webhooks
- 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. \n\n"
name: Notifications
paths:
/users:
get:
description: Retrieves all users created in your application for a specified applicationUserId using the filter[applicationUserId]
query parameter. If filter[applicationUserId] is not provided, the response will include up to 50,000 users.
operationId: getUsers
parameters:
- description: __Optional__. Filter records based on the list of `applicationUserId` users provided.
in: query
name: filter[applicationUserId]
required: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
'200':
content:
application/json;charset=UTF-8:
examples:
Example Response:
$ref: '#/components/examples/users_example-response'
schema:
type: array
items:
$ref: '#/components/schemas/ApplicationUser'
description: Ok
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
summary: Get Users
tags:
- Users
post:
description: Create a new user in your application
operationId: addUser
requestBody:
content:
application/json;charset=UTF-8:
examples:
Create User Example Request:
$ref: '#/components/examples/create-user-example-request'
schema:
$ref: '#/components/schemas/NewApplicationUser'
required: true
responses:
'201':
content:
application/json;charset=UTF-8:
examples:
Example Response:
$ref: '#/components/examples/create-user_example-response'
schema:
$ref: '#/components/schemas/ApplicationUser'
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
summary: Create User
tags:
- Users
/users/{userUuid}:
patch:
description: Update the users information
operationId: patchUser
parameters:
- description: __Mandatory__. The Yapily generated UUID for the user.
in: path
name: userUuid
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/ApplicationUserPatchRequest'
responses:
'201':
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApplicationUser'
description: Created
default:
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Error Response
summary: Update User
tags:
- Users
delete:
description: Delete a user from your application along with any sub-resources (including consent resources on institution
APIs if they exist)
operationId: deleteUser
parameters:
- description: __Mandatory__. The Yapily generated UUID for the user.
in: path
name: userUuid
required: true
schema:
type: string
format: uuid
responses:
'200':
content:
application/json;charset=UTF-8:
examples:
Example Response:
$ref: '#/components/examples/delete-user_example-response'
schema:
$ref: '#/components/schemas/ApiResponseOfUserDeleteResponse'
description: Ok
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
summary: Delete User
tags:
- Users
get:
description: Get a specific user using the user UUID
operationId: getUser
parameters:
- description: __Mandatory__. The Yapily generated UUID for the user.
in: path
name: userUuid
required: true
schema:
type: string
format: uuid
responses:
'200':
content:
application/json;charset=UTF-8:
examples:
Example Response:
$ref: '#/components/examples/user_example-response'
schema:
$ref: '#/components/schemas/ApplicationUser'
description: Ok
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
summary: Get User
tags:
- Users
/notifications/event-subscriptions:
post:
tags:
- Notifications
summary: Create Event Subscription
description: Used to subscribe to notifications relating to a specified event type.
operationId: createEventSubscription
x-beta: true
parameters:
- $ref: '#/components/parameters/SubAppHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubscriptionRequest'
responses:
'201':
description: Event subscription created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseOfEventSubscriptionResponse'
'400':
description: Bad request for missing required properties
'401':
description: Unauthorized
'409':
description: Event subscription already exist for the application
x-mint:
content: 'Learn more: [Webhooks & Notifications](/tools-and-services/webhooks/introduction)'
get:
tags:
- Notifications
summary: Get Event Subscriptions
description: Get all event subscriptions that your application is subscribed to
operationId: getEventSubscriptions
x-beta: true
parameters:
- description: The sub-application ID for which all event subscriptions will be returned
in: header
name: sub-application
required: false
schema:
type: string
format: uuid
responses:
'200':
description: Event subscriptions for the application
content:
application/json:
schema:
$ref: '#/components/schemas/ApiListResponseOfEventSubscriptionResponse'
'401':
description: Unauthorized
/notifications/event-subscriptions/{eventTypeId}:
get:
tags:
- Notifications
summary: Get Event Subscription
description: Used to get details of your subscription to a specified event type.
operationId: getEventSubscriptionById
x-beta: true
parameters:
- $ref: '#/components/parameters/EventTypeId'
- $ref: '#/components/parameters/SubAppHeader'
responses:
'200':
description: Event subscription data found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseOfEventSubscriptionResponse'
'401':
description: Unauthorized
'404':
description: Event subscription not found
delete:
tags:
- Notifications
summary: Delete Event Subscription
description: Used to unsubscribe to notifications relating to a specified event type.
operationId: deleteEventSubscriptionById
x-beta: true
parameters:
- $ref: '#/components/parameters/EventTypeId'
- description: The sub-application ID for which event type will be deleted
in: header
name: sub-application
required: false
schema:
type: string
format: uuid
responses:
'200':
description: Event subscription deleted successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseOfEventSubscriptionDeleteResponse'
'401':
description: Unauthorized
'404':
description: Event subscription not found
/institutions/constraints/payments:
get:
description: Retrieve institution specific constraints for payment authorisation and submission requests
operationId: getPaymentConstraintsRulesByInstitution
x-beta: true
parameters:
- description: Unique Id(s) of the `Institution`(s) to retrieve the Payment Constraints for. Multiple institutionIds
need to be separated by `,`
name: institutionIds
required: true
in: query
schema:
type: array
items:
type: string
- description: Country code of the `Institution`(s). Ensure that the country code matches the respective institutionIds;
any mismatch will result in an HTTP 404 error response.
in: query
name: institutionCountryCode
required: true
schema:
type: string
- description: Type of payment to retrieve payment constraints for
in: query
name: paymentType
required: true
schema:
type: string
enum:
- DOMESTIC_PAYMENT
- DOMESTIC_INSTANT_PAYMENT
- DOMESTIC_VARIABLE_RECURRING_PAYMENT
- DOMESTIC_SCHEDULED_PAYMENT
- DOMESTIC_PERIODIC_PAYMENT
- INTERNATIONAL_PAYMENT
- INTERNATIONAL_SCHEDULED_PAYMENT
- INTERNATIONAL_PERIODIC_PAYMENT
- description: The path on the API that is associated with the operation for which constraints are to be retrieved
in: query
name: endpointPath
required: false
schema:
type: string
- description: The HTTP method that is associated with the operation for which constraints are to be retrieved
in: query
name: endpointMethod
required: false
schema:
type: string
enum:
- POST
- PATCH
- PUT
- GET
- DELETE
responses:
'200':
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiListResponseOfPaymentConstraints'
description: Ok
'400':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/400-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Bad Request.
'401':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/401-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Either authentication credentials were not supplied, or they were invalid.
'404':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/404-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Not Found.
'500':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/500-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Unexpected Error
summary: Get Payment Constraints Rules
tags:
- Constraints
x-mint:
content: 'Learn more: [Payment Constraints](/payments/payment-resources/payment-constraints) for institution-specific
requirements'
/institutions/constraints/data:
get:
description: Get Data Constraints Rules against an Institution for Account Authorisation requests
operationId: getAccountConstraintsRulesByInstitution
x-beta: true
parameters:
- description: Unique Id(s) of the `Institution`(s) to retrieve the Data Constraints for. Multiple institutionIds need
to be separated by `,`
name: institutionIds
required: true
in: query
schema:
type: array
items:
type: string
- description: Country code of the `Institution`(s). Ensure that the country code matches the respective institutionIds;
any mismatch will result in an HTTP 404 error response.
in: query
name: institutionCountryCode
required: true
schema:
type: string
- description: The path on the API that is associated with the operation for which constraints are to be retrieved
in: query
name: endpointPath
required: false
schema:
type: string
- description: The HTTP method that is associated with the operation for which constraints are to be retrieved
in: query
name: endpointMethod
required: false
schema:
type: string
enum:
- POST
- PATCH
- PUT
- GET
- DELETE
responses:
'200':
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiListResponseOfDataConstraints'
description: Ok
'400':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/400-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Bad Request.
'401':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/401-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Either authentication credentials were not supplied, or they were invalid.
'404':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/404-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Not Found.
'500':
content:
application/json;charset=UTF-8:
examples:
500 Error Response:
$ref: '#/components/examples/500-error-response'
schema:
$ref: '#/components/schemas/ApiResponseError'
description: Unexpected Error
summary: Get Data Constraints Rules
tags:
- Constraints
/applications:
post:
description: Creates a sub-application under the given root application id provided in the authentication token. The
sub-application can use the root's credentials to call the API
summary: Creates a Sub-application for the Root Application Id Provided in the Authentication Token
x-beta: true
operationId: createSubApplication
requestBody:
description: The sub-application to create
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationRequest'
examples:
Create Sub-application Request:
$ref: '#/components/examples/application-request'
responses:
'201':
content:
application/json;charset=UTF-8:
examples:
Create Sub-application Response:
$ref: '#/components/examples/application-response'
schema:
$ref: '#/components/schemas/ApiResponseOfApplicationResponse'
description: Sub-application was successfully created
'400':
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/application-error-response-code-400'
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
description: There are validation errors
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/error-response-code-401'
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Application with given root id not found.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
tags:
- Application Management
x-mint:
content: 'Learn more: [Application Management](/getting-started/application-management)'
get:
description: Retrieves sub-applications for the root application provided in the authentication token. If a sub-application
is provided in the authentication token, it will return an empty list.
summary: Retrieve Sub-applications for the Root Application Provided in the Authentication Token.
x-beta: true
operationId: searchApplications
parameters:
- $ref: '#/components/parameters/SearchApplicationsParameters'
responses:
'200':
description: The sub-applications that are returned as part of the search results.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiListOfApplicationResponse'
examples:
Get Applications Response:
$ref: '#/components/examples/application-responses'
'400':
description: There are validation errors
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/error-response-code-401'
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
tags:
- Application Management
/applications/{applicationId}:
get:
description: Retrieves an application by the id provided in the path
x-beta: true
operationId: getApplicationById
parameters:
- in: path
name: applicationId
required: true
schema:
type: string
format: uuid
description: The id of the application being fetched
responses:
'200':
content:
application/json;charset=UTF-8:
examples:
Get Application By Id Response:
$ref: '#/components/examples/application-response'
schema:
$ref: '#/components/schemas/ApiResponseOfApplicationResponse'
description: Application was successfully fetched
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/error-response-code-401'
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Application with given id not found.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
tags:
- Application Management
summary: Get Application Details
put:
description: Updates the application properties for the application with the given ID in the path
x-beta: true
operationId: updateApplication
parameters:
- in: path
name: applicationId
required: true
schema:
type: string
format: uuid
description: The id of the application being updated
requestBody:
description: The application to update
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationRequest'
examples:
Update Application Request:
$ref: '#/components/examples/application-request'
responses:
'200':
content:
application/json;charset=UTF-8:
examples:
Update Application Response:
$ref: '#/components/examples/application-response'
schema:
$ref: '#/components/schemas/ApiResponseOfApplicationResponse'
description: Application was successfully updated
'400':
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/application-error-response-code-400'
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
description: There are validation errors
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/error-response-code-401'
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
tags:
- Application Management
summary: Update an Application
delete:
description: Deletes the application with the given ID in the path
x-beta: true
operationId: deleteApplication
parameters:
- in: path
name: applicationId
required: true
schema:
type: string
format: uuid
description: The id of the application being deleted
responses:
'204':
description: Application was successfully deleted
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/error-response-code-401'
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'404':
description: Application with given id not found.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
tags:
- Application Management
summary: Delete an Application
/applications/{applicationId}/vrp:
post:
description: Create application vrp configuration
summary: Create Application Vrp Configuration by Application Id
x-beta: true
operationId: createApplicationVRPConfigurationByApplicationId
parameters:
- in: path
name: applicationId
required: true
schema:
type: string
format: uuid
description: The id of the application that vrp configuration being created for
requestBody:
description: The vrp configuration to create
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VrpConfiguration'
responses:
'201':
description: Application vrp configuration was successfully created
'400':
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/application-error-response-code-400'
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
description: There are validation errors
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
401 Error Response:
$ref: '#/components/examples/401-error-response'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
403 Error Response:
$ref: '#/components/examples/403-error-response'
'404':
description: VRP Configuration with given application id not found.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
404 Error Response:
$ref: '#/components/examples/404-error-response'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
500 Error Response:
$ref: '#/components/examples/500-error-response'
tags:
- Application Management
put:
description: Update application vrp configuration
summary: Update Application Vrp Configuration by Application Id
x-beta: true
operationId: updateApplicationVRPConfigurationByApplicationId
parameters:
- in: path
name: applicationId
required: true
schema:
type: string
format: uuid
description: The id of the application that vrp configuration being created for
requestBody:
description: The vrp configuration to create
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VrpConfiguration'
responses:
'201':
description: Application vrp configuration was successfully updated
'400':
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/application-error-response-code-400'
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
description: There are validation errors
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
401 Error Response:
$ref: '#/components/examples/401-error-response'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
403 Error Response:
$ref: '#/components/examples/403-error-response'
'404':
description: VRP Configuration with given application id not found.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
404 Error Response:
$ref: '#/components/examples/404-error-response'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
500 Error Response:
$ref: '#/components/examples/500-error-response'
tags:
- Application Management
get:
description: Get application vrp configuration
summary: Get Application Vrp Configuration by Application Id
x-beta: true
operationId: getApplicationVRPConfigurationByApplicationId
parameters:
- in: path
name: applicationId
required: true
schema:
type: string
format: uuid
description: The id of the application that vrp configuration being created for
responses:
'200':
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/VrpConfiguration'
description: Application vrp configuration was successfully fetched
'400':
content:
application/json;charset=UTF-8:
examples:
Error Response:
$ref: '#/components/examples/application-error-response-code-400'
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
description: There are validation errors
'401':
description: Either authentication credentials were not supplied, or they were invalid.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
401 Error Response:
$ref: '#/components/examples/401-error-response'
'403':
description: Forbidden from accessing the requested Application.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
403 Error Response:
$ref: '#/components/examples/403-error-response'
'404':
description: VRP Configuration with given application id not found.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
404 Error Response:
$ref: '#/components/examples/404-error-response'
'500':
description: An unexpected error occurred.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
examples:
500 Error Response:
$ref: '#/components/examples/500-error-response'
tags:
- Application Management
/webhook/events/categories:
get:
tags:
- Webhooks
description: Retrieve a comprehensive list of event categories that can be registered for webhook notifications in your
application. These event categories can be used to subscribe a webhook to specific events, enabling your application
to receive real-time notifications when these events occur.
summary: Get Webhook Categories
operationId: getWebhookEventsCategories
responses:
'200':
description: Event Categories
content:
application/json;charset=UTF-8:
examples:
SuccessfulResponse:
value:
metadata:
tracingId: f2425b79-974d-43f8-a5a2-ec771b2d9297
data:
categories:
- name: payment.state.success
description: An event sent when payment reaches a terminal successful status
- name: payment.state.failed
description: An event sent when payment reaches a terminal failed status
schema:
type: object
properties:
metadata:
$ref: '#/components/schemas/Metadata'
data:
type: object
properties:
categories:
type: array
items:
$ref: '#/components/schemas/CategoryStructure'
'401':
description: Authentication Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/401-error-response'
'400':
description: Validation Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/400-error-response'
'500':
description: Unexpected Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/500-error-response'
/webhook/events:
post:
tags:
- Webhooks
description: Register a webhook to one or multiple event categories to receive real-time notifications when specific
events occur in your application.
summary: Register Webhook Event
operationId: registerWebhook
requestBody:
content:
application/json;charset=UTF-8:
schema:
type: object
required:
- applicationId
- categories
- callbackUrl
properties:
applicationId:
type: string
format: uuid
categories:
type: array
description: One or more event categories for which the webhook will be triggered
items:
type: string
callbackUrl:
type: object
description: Callback URLs where events will be sent. These must not contain any query parameters.
required:
- main
properties:
main:
type: object
description: Primary URL where events will be sent. It must not contain any query parameters.
required:
- url
properties:
url:
type: string
description: A valid URL without query parameters.
backup:
type: object
description: Secondary URL where events will be sent whenever the primary URL is not responding. It
must not contain any query parameters.
properties:
url:
type: string
description: A valid URL without query parameters.
metadata:
$ref: '#/components/schemas/WebhookMetadata'
responses:
'201':
$ref: '#/components/responses/WebhookDetailsWithSecret'
'401':
description: Authentication Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/401-error-response'
'400':
description: Validation Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/400-error-response'
'406':
description: Maximum number of registered webhooks has been reached
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/406-error-response'
'500':
description: Unexpected Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/500-error-response'
parameters:
- $ref: '#/components/parameters/SubAppHeader'
x-mint:
content: 'Learn more: [Webhook Setup](/tools-and-services/webhooks/get-started)'
get:
tags:
- Webhooks
description: Retrieve the list of registered webhooks for your application
summary: Retrieve All Webhook Events
operationId: getRegisteredWebhooks
responses:
'200':
description: Registered Webhooks
content:
application/json;charset=UTF-8:
schema:
type: object
properties:
metadata:
$ref: '#/components/schemas/Metadata'
data:
type: object
properties:
active:
type: array
items:
$ref: '#/components/schemas/RegisteredWebhookWithStatus'
'401':
description: Authentication Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/401-error-response'
'400':
description: Validation Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/400-error-response'
'500':
description: Unexpected Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/500-error-response'
parameters:
- $ref: '#/components/parameters/SubAppHeader'
/webhook/events/{webhook_id}:
delete:
tags:
- Webhooks
description: Delete a webhook event for a specified webhook ID, unregistering it from receiving any further notifications
for the subscribed event categories in your application.
summary: Delete Webhook Event
operationId: deleteWebhook
parameters:
- $ref: '#/components/parameters/SubAppHeader'
- $ref: '#/components/parameters/WebhookIdParameter'
responses:
'200':
description: Deleted
content:
application/json;charset=UTF-8:
schema:
type: object
properties:
metadata:
$ref: '#/components/schemas/Metadata'
data:
$ref: '#/components/schemas/RegisteredWebhook'
'401':
description: Authentication Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/401-error-response'
'400':
description: Validation Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/400-error-response'
'404':
description: Webhook ID not found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/404-error-response'
'500':
description: Unexpected Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/500-error-response'
/webhook/secrets/{webhook_id}:
post:
tags:
- Webhooks
description: Reset webhook secret for a webhook that is already registered to your application
summary: Reset Webhook Secret
operationId: webhookSecretReset
parameters:
- $ref: '#/components/parameters/SubAppHeader'
- $ref: '#/components/parameters/WebhookIdParameter'
requestBody:
content:
application/json;charset=UTF-8:
schema:
type: object
required:
- delay
properties:
delay:
type: number
description: delay in seconds
minimum: 0
maximum: 86400
responses:
'201':
$ref: '#/components/responses/WebhookDetailsWithSecret'
'401':
description: Authentication Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/401-error-response'
'400':
description: Validation Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/400-error-response'
'404':
description: Webhook ID not found
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/404-error-response'
'500':
description: Unexpected Error
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
examples:
Example-1:
$ref: '#/components/examples/500-error-response'
x-mint:
content: 'Learn more: [Webhook Setup](/tools-and-services/webhooks/get-started)'
components:
schemas:
AccountBalanceType:
type: string
description: Specifies the type of the stated account balance.
enum:
- CLOSING_AVAILABLE
- CLOSING_BOOKED
- CLOSING_CLEARED
- EXPECTED
- FORWARD_AVAILABLE
- INFORMATION
- INTERIM_AVAILABLE
- INTERIM_BOOKED
- INTERIM_CLEARED
- OPENING_AVAILABLE
- OPENING_BOOKED
- OPENING_CLEARED
- PREVIOUSLY_CLOSED_BOOKED
- AUTHORISED
- OTHER
- UNKNOWN
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
AddressDetails:
type: object
properties:
addressLine:
type: string
description: Information, in free format text, that identifies a specific address.
AlignmentEnum:
type: string
description: __Mandatory__. Period alignment for which the payment limits are enforced. Allowed values are [CONSENT,
CALENDAR]. If CONSENT, then period starts on consent creation date. If CALENDAR, then period lines up with the frequency
e.g. WEEKLY period will begin at start of the week in question.
enum:
- CONSENT
- CALENDAR
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.
ApiCall:
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.
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
ApiErrorResponseV2:
type: object
description: API Error Response
properties:
error:
required:
- tracingId
- code
- status
- issues
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:
required:
- message
- 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: 5 digit Error Code that uniquely identifies the type of issue, for full list of error codes
pelase check our documentation
message:
type: string
description: Human readable description of the issue that was experienced
ApiListOfApplicationResponse:
type: object
properties:
meta:
$ref: '#/components/schemas/ApplicationResponseListMeta'
data:
type: array
items:
$ref: '#/components/schemas/ApplicationResponse'
ApiListResponseOfDataConstraints:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseMeta'
data:
type: array
items:
$ref: '#/components/schemas/DataConstraintsResponse'
example:
meta:
tracingId: a43049c1dbc04d6f8c8e2dfdc523217a
data:
- institutionId: mock-sandbox
institutionCountryCode: GB
endpointPath: /account-auth-requests
endpointMethod: POST
request:
headers:
title: Header
type: object
properties:
psuID:
title: PSU Id
type: string
description: __Mandatory__. The psu id
body:
required:
- institutionId
type: object
properties:
userUuid:
title: User UUID
type: string
format: uuid
institutionId:
title: Institution Identifier
type: string
description: __Mandatory__. The reference to the `Institution` which identifies which institution the authorisation
request is sent to.
example: yapily-mock
oneTimeToken:
title: One Time Token
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. \n\nSee [Using a callback\
\ with an OTT (Optional)](/open-banking-flow/handling-redirects/callback-url) for more information."
example: false
callback:
title: Callback
type: string
description: "__Optional__. The server to redirect the user to after the user complete the authorisation\
\ at the `Institution`. \n\nSee [Using a callback (Optional)](/open-banking-flow/handling-redirects/callback-url)\
\ for more information."
example: https://display-parameters.com
accountRequest:
title: Account Request
type: object
properties:
transactionFrom:
title: Transaction From Date
type: string
description: __Optional__. Used to specify the lower bound on when to pull transaction. This should
be declared when accessing transaction older than 90 days for banks in the [CBI Globe](/data/financial-data-resources/data-restrictions#cbi-globe-gateway).
format: date-time
transactionTo:
title: Transaction To Date
type: string
description: __Optional__. When performing a request using the consent, this is the latest date of transaction
records that can be retrieved.
format: date-time
expiresAt:
title: Expires At
type: string
description: '__Optional__. Used to set a hard date for when the user''s associated `Consent` will expire.
**Note**: If this supported by the bank, specifying this is property is opting out of having a long-lived
consent that can be perpetually re-authorised by the user. This will add an `expiresAt` field on the
`Consent` object which will render it unusable after this date.
**Note**: This is not supported by every `Institution`. In such case, the request will not fail but
the property will be ignored and the created `Consent` will not have an expiry date.'
format: date-time
accountIdentifiers:
title: Account Info
required:
- accountIdentification
type: object
properties:
accountId:
type: string
description: __Conditional__. Unique identifier of the account.
example: '500000000000000000000001'
accountIdentification:
title: Account Identifications
required:
- identification
- type
type: object
properties:
type:
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
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
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'
description: "__Conditional__. Used to create a request for the balance of the account specified. Once\
\ the user authorises the request, only the balance can be obtained by executing [GET Account Balances](./#get-account-balances).\n\
\n This can be specified in conjunction with `accountIdentifiersForTransaction` to generate a `Consent`\
\ that can both access the accounts balance and transactions."
accountIdentifiersForTransaction:
type: array
items:
required:
- accountIdentification
type: object
properties:
accountId:
type: string
description: __Conditional__. Unique identifier of the account.
example: '500000000000000000000001'
accountIdentification:
title: Account Identifications
required:
- identification
- type
type: object
properties:
type:
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
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
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'
description: "__Conditional__. Used to create a request for the transactions of the account specified.\
\ Once the user authorises the request, only the transactions can be obtained by executing [GET Account\
\ Transactions](./#get-account-transactions). \n\nThis can be specified in conjunction with `accountIdentifiersForBalance`\
\ to generate a `Consent` that can both access the accounts balance and transactions."
accountIdentifiersForBalance:
type: array
items:
required:
- accountIdentification
type: object
properties:
accountId:
type: string
description: __Conditional__. Unique identifier of the account.
example: '500000000000000000000001'
accountIdentification:
title: Account Identifications
required:
- identification
- type
type: object
properties:
type:
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
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
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'
description: "__Conditional__. Used to create a request for the transactions of the account specified.\
\ Once the user authorises the request, only the transactions can be obtained by executing [GET Account\
\ Transactions](./#get-account-transactions). \n\nThis can be specified in conjunction with `accountIdentifiersForBalance`\
\ to generate a `Consent` that can both access the accounts balance and transactions."
featureScope:
title: Feature Scope
type: array
items:
type: string
description: Used to describe what functions are supported by the associated `Institution`
description: Account authorisation request schema
description: The request body containing an `AccountAuthorisationRequest` json payload
ApiListResponseOfEventSubscriptionResponse:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseListMeta'
data:
type: array
items:
$ref: '#/components/schemas/EventSubscriptionResponse'
links:
type: object
additionalProperties:
type: string
forwardedData:
type: array
items:
$ref: '#/components/schemas/ResponseForwardedData'
raw:
deprecated: true
type: array
items:
$ref: '#/components/schemas/RawResponse'
paging:
$ref: '#/components/schemas/FilteredClientPayloadListTransaction'
tracingId:
type: string
writeOnly: true
ApiListResponseOfPaymentConstraints:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseListMeta'
data:
type: array
items:
$ref: '#/components/schemas/PaymentConstraintsResponse'
example:
meta:
tracingId: 661471ddb4344113a2d185b861cb3dcf
data:
- institutionId: mock-sandbox
institutionCountryCode: GB
endpointPath: /payments
endpointMethod: POST
paymentType: DOMESTIC_PAYMENT
request:
headers:
title: Header
type: object
properties:
psuID:
title: PSU Id
type: string
description: ''
body:
title: Payment Request
required:
- payee
- amount
- paymentIdempotencyId
- type
type: object
properties:
paymentIdempotencyId:
title: Payment Idempotency Id
pattern: ^.{1,35}$
type: string
description: Id for the payment
type:
enum:
- DOMESTIC_PAYMENT
title: Payment Type
type: string
description: type of the payment
contextType:
default: OTHER
enum:
- BILL
- GOODS
- SERVICES
- OTHER
- PERSON_TO_PERSON
title: Context Type
type: string
description: __Optional__. The payment context code. This defaults to `OTHER` if not specified.
reference:
title: Reference
pattern: ^.{1,18}$
type: string
description: __Mandatory__. The payment reference or description. Limited to a maximum of 18 characters
long.
example: Bill payment
payee:
title: Payee
required:
- accountIdentifications
- name
type: object
properties:
name:
title: Name
pattern: ^.{1,18}$
type: string
description: __Mandatory__. The account holder name of the beneficiary.
example: Jane Doe
accountIdentifications:
title: Account Identifications
type: array
items:
required:
- identification
- type
type: object
properties:
type:
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."
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."
description: __Mandatory__. The account identifications that identify the `Payee` bank account.
address:
title: Address
type: object
properties:
addressLines:
title: Address Lines
type: array
items:
title: Address Line
type: string
description: __Optional__. The address line of the address
streetName:
title: Street Name
type: string
description: __Optional__. The street name of the address
buildingNumber:
title: Building Number
type: string
description: __Optional__. The building number of the address
postCode:
title: Postcode
type: string
description: __Optional__. The post code of the address
townName:
title: Town
type: string
description: __Optional__. The town name of the address
county:
title: County
type: array
items:
type: string
description: __Optional__. The list of counties for the address
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"
department:
title: Department
type: string
description: __Optional__. The department for the address
subDepartment:
title: Sub-department
type: string
description: __Optional__. The sub-department for the address
addressType:
enum:
- BUSINESS
- CORRESPONDENCE
- DELIVERY_TO
- MAIL_TO
- PO_BOX
- POSTAL
- RESIDENTIAL
- STATEMENT
- UNKNOWN
title: Address Type
type: string
description: __Optional__. The type of address
description: __Conditional__. The address of the `Payee` or `Payer`.
description: __Mandatory__. Details of the beneficiary [person or business].
payer:
title: Payer
required:
- accountIdentifications
type: object
properties:
accountIdentifications:
title: Account Identifications
type: array
items:
required:
- identification
- type
type: object
properties:
type:
enum:
- IBAN
title: Account Identification Type
type: string
description: __Mandatory__. Should be IBAN only.
identification:
title: Account Identification
pattern: DE\d{20}
type: string
description: __Mandatory__. The IBAN value associated with the account identity
description: __Mandatory__. The account identifications that identify the `Payer` bank account.
address:
title: Address
type: object
properties:
addressLines:
title: Address Lines
type: array
items:
title: Address Line
type: string
description: __Optional__. The address line of the address
streetName:
title: Street Name
type: string
description: __Optional__. The street name of the address
buildingNumber:
title: Building Number
type: string
description: __Optional__. The building number of the address
postCode:
title: Postcode
type: string
description: __Optional__. The post code of the address
townName:
title: Town
type: string
description: __Optional__. The town name of the address
county:
title: County
type: array
items:
type: string
description: __Optional__. The list of counties for the address
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"
department:
title: Department
type: string
description: __Optional__. The department for the address
subDepartment:
title: Sub-department
type: string
description: __Optional__. The sub-department for the address
addressType:
enum:
- BUSINESS
- CORRESPONDENCE
- DELIVERY_TO
- MAIL_TO
- PO_BOX
- POSTAL
- RESIDENTIAL
- STATEMENT
- UNKNOWN
title: Address Type
type: string
description: __Optional__. The type of address
description: __Conditional__. The address of the `Payee` or `Payer`.
amount:
title: Amount
required:
- amount
- currency
type: object
properties:
amount:
title: Amount
minimum: 0
type: number
description: __Mandatory__. The monetary value
currency:
title: Currency
pattern: ^[A-Z]{3,3}$
type: string
description: __Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code
description: __Mandatory__. Monetary Amount.
paymentDateTime:
type: string
description: __Optional__, If present date should be greater than or equal to current date
format: date-time
description: Domestic payment request schema
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
ApiResponseOfApplicationResponse:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseMeta'
data:
$ref: '#/components/schemas/ApplicationResponse'
ApiResponseOfEventSubscriptionDeleteResponse:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseMeta'
data:
$ref: '#/components/schemas/EventSubscriptionDeleteResponse'
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
ApiResponseOfEventSubscriptionResponse:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseMeta'
data:
$ref: '#/components/schemas/EventSubscriptionResponse'
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
ApiResponseOfUserDeleteResponse:
type: object
properties:
meta:
$ref: '#/components/schemas/ResponseMeta'
data:
$ref: '#/components/schemas/UserDeleteResponse'
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
ApplicationRequest:
type: object
required:
- name
- merchantCategoryCode
- ppcUserGroup
- isContractPresent
properties:
name:
type: string
format: ^[a-zA-Z0-9 \-_\[\]\(\)]+$
description: The name of the application
merchantCategoryCode:
type: string
format: ^\d{4}$
description: 'The ISO-18245 merchant category code of the merchant the application is being created for.
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'
ppcUserGroup:
type: string
description: 'The payment user group from the purpose code list for the application.
Allowed values:
- WHOLESALE_FI_FI
- COMMERCIAL
- CONSUMER_GOODS_SERVICES
- FINANCE
- INSURANCE
- PROPERTY
- UTILITIES
- TAX
- SALARIES_INCOMES
- INVESTMENTS
- FOREIGN_EXCHANGE
- GOVERNMENT
- BENEFIT_PAYMENTS
- MEDICAL
- PENSIONS'
example: WHOLESALE_FI_FI
callbackUrls:
type: array
description: The application callback URLs
items:
type: string
isContractPresent:
type: boolean
description: Indicates if a contract is in place with the merchant and a KYB process has been completed
ApplicationResponse:
type: object
properties:
id:
type: string
format: uuid
description: The id of the application returned
example: 2698db90-6635-4f76-b673-5ce8e2aeda0e
rootApplicationId:
type: string
format: uuid
description: The id of the root application
example: eb25e1ee-f6af-4131-92fe-748e177bf950
name:
type: string
format: ^[a-zA-Z0-9 \-_\[\]\(\)]+$
description: The name of the application
merchantCategoryCode:
type: string
format: ^\d{4}$
description: 'The ISO-18245 merchant category code of the merchant the application is being created for.
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'
ppcUserGroup:
type: string
description: 'The payment user group from the purpose code list for the application.
Allowed values:
- WHOLESALE_FI_FI
- COMMERCIAL
- CONSUMER_GOODS_SERVICES
- FINANCE
- INSURANCE
- PROPERTY
- UTILITIES
- TAX
- SALARIES_INCOMES
- INVESTMENTS
- FOREIGN_EXCHANGE
- GOVERNMENT
- BENEFIT_PAYMENTS
- MEDICAL
- PENSIONS'
example: WHOLESALE_FI_FI
callbackUrls:
type: array
description: The application callback URLs
items:
type: string
isContractPresent:
type: boolean
description: Indicates if a contract is in place with the merchant and a KYB process has been completed
ApplicationResponseListMeta:
type: object
properties:
tracingId:
type: string
count:
type: integer
format: int32
minimum: 0
description: The number of applications in the current page.
pagination:
type: object
properties:
self:
type: object
properties:
offset:
type: integer
format: int32
minimum: 0
description: The number of skipped applications.
limit:
type: integer
format: int32
minimum: 0
description: The maximum number of applications for the current page.
sort:
type: string
description: The field by which results are sorted by. Default direction is ascending, descending is identified
by a "-" prefix.
totalCount:
type: integer
format: int32
minimum: 0
description: The total number of applications that match the given filter.
ApplicationUser:
type: object
description: Information about a user of an application.
properties:
uuid:
type: string
description: A unique identifier for the 'User' assigned by Yapily.
format: uuid
applicationUuid:
type: string
description: Unique identifier of the application the user is associated with.
format: uuid
applicationUserId:
type: string
description: __Conditional__. The user-friendly reference to the `User`.
referenceId:
type: string
createdAt:
type: string
description: Date and time of when the user was created.
format: date-time
institutionConsents:
type: array
items:
$ref: '#/components/schemas/InstitutionConsent'
vopOptOut:
type: boolean
description: __Optional__. A flag to indicate whether the user has opted out of VOP.
default: false
ApplicationUserPatchRequest:
type: object
required:
- op
- path
- value
properties:
op:
$ref: '#/components/schemas/PatchOperation'
path:
description: The path to the target location.
type: string
value:
description: The value to be replaced or tested.
type: string
Categorisation:
type: object
description: Income and Expense categorisation that the Yapily categorisation engine has determined for the transaction.
properties:
categories:
type: array
items:
type: string
source:
type: string
CategoryStructure:
type: object
properties:
name:
type: string
description:
type: string
ConsentDeleteResponse:
type: object
properties:
id:
type: string
description: __Conditional__. User-friendly identifier of the `User` that provides authorisation. 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.
format: uuid
deleteStatus:
$ref: '#/components/schemas/DeleteStatusEnum'
institutionId:
type: string
description: __Mandatory__. The `Institution` the authorisation request is sent to.
institutionConsentId:
type: string
description: Identification of the consent at the Institution.
creationDate:
type: string
description: Date and time of when the consent was authorised.
format: date-time
CurrencyExchange:
type: object
description: Provides details on the currrency exchange.
properties:
sourceCurrency:
type: string
description: Currency from which an amount is to be converted.
targetCurrency:
type: string
description: Currency to which an amount is to be converted.
unitCurrency:
type: string
description: The currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP
= xxxCUR, the unit currency is GBP.
exchangeRate:
type: number
description: 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.
DataConstraintsResponse:
required:
- institutionId
- institutionCountry
- request
type: object
properties:
institutionId:
type: string
description: The id to represent the `Institution`.
example: modelo-sandbox
institutionCountryCode:
type: string
description: 2 letter ISO Country code of the `Institution`.
example: GB
endpointPath:
type: string
description: Define the applicable API end point.
endpointMethod:
type: string
description: Https Method for the endpoint.
request:
$ref: '#/components/schemas/RequestConstraints'
DeleteStatusEnum:
type: string
description: Indicates the outcome of the delete request.
enum:
- SUCCESS
- FAILED
Enrichment:
type: object
description: Enriched data that has been derived by Yapily using it's data processing and machine learning techniques.
properties:
categorisation:
$ref: '#/components/schemas/Categorisation'
transactionHash:
$ref: '#/components/schemas/TransactionHash'
cleansedDescription:
type: string
description: Cleaned version of the `Transaction Description` that removes miscellaneous, generic and unhelpful
text.
merchant:
$ref: '#/components/schemas/EnrichmentMerchant'
location:
type: string
description: The location of where the transaction took place.
paymentProcessor:
type: string
description: A payment provider that manages (credit/debit) transactions between the `Institution` and the merchant.
correctedDate:
type: string
description: The likely date and time on which the transaction took place. This is distinct from `Booking Date Time`
which usually refers to the post-clearing value.
format: date-time
EnrichmentMerchant:
type: object
description: Details of the merchant, identified by Yapily data services.
properties:
merchantName:
type: string
description: The name of the indivdual merchant involved in the transaction e.g. (TESCO Petrol).
parentGroup:
type: string
description: The parent organisation that the merchant belongs to e.g. (TESCO).
EnumError:
type: string
enum:
- MANDATORY
- INVALID_FORMAT
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'
EventSubscriptionDeleteResponse:
title: Response upon successful unsubscribe on subscription
type: object
required:
- eventTypeId
- applicationId
- created
- deleteStatus
properties:
eventTypeId:
type: string
description: Unique identifier of the event type (for which notifications will be sent)
example: payment.status.completed
applicationId:
type: string
format: uuid
description: Application related to event subscription.
example: 2698db90-6635-4f76-b673-5ce8e2aeda0e
created:
type: string
format: date-time
description: Creation datetime of event subscription.
example: 28-07-2021 15:47:03
deleteStatus:
$ref: '#/components/schemas/DeleteStatusEnum'
EventSubscriptionRequest:
title: Request to create a subscription for notifications
type: object
required:
- eventTypeId
- notification
properties:
eventTypeId:
type: string
description: 'Unique identifier of the event type (for which notifications will be sent).
Allowed values: payment.status, payment.status.completed, payment.isoStatus'
example: payment.status.completed
notification:
$ref: '#/components/schemas/Notification'
EventSubscriptionResponse:
title: Response on successful creation of event subscription
type: object
required:
- eventTypeId
- applicationId
- created
- notification
properties:
eventTypeId:
type: string
description: Unique identifier of the event type (for which notifications will be sent)
example: payment.status.completed
applicationId:
type: string
format: uuid
description: Application related to event subscription.
example: 2698db90-6635-4f76-b673-5ce8e2aeda0e
created:
type: string
description: Creation date of event subscription.
example: 28-07-2021 15:47:03
notification:
$ref: '#/components/schemas/Notification'
FilterAndSort:
type: object
properties:
from:
type: string
description: __Optional__. The earliest date and time of resources / records that should be returned.
format: date-time
before:
type: string
description: __Optional__. The latest date and time of resources / records that should be returned.
format: date-time
limit:
type: integer
description: __Optional__. The maximum number of resources / records that should be returned.
format: int32
sort:
$ref: '#/components/schemas/SortEnum'
offset:
type: integer
format: int32
cursor:
type: string
FilteredClientPayloadListTransaction:
type: object
properties:
apiCall:
$ref: '#/components/schemas/ApiCall'
data:
type: array
items:
$ref: '#/components/schemas/Transaction'
nextCursorHash:
type: string
nextLink:
type: string
pagingMap:
type: object
additionalProperties:
$ref: '#/components/schemas/FilterAndSort'
totalCount:
type: integer
format: int64
FrequencyEnum:
type: string
description: __Mandatory__. Frequency for which the payment limits are enforced. Allowed values are [MONTHLY].
enum:
- MONTHLY
InstitutionConsent:
type: object
description: '`Institution` authorised consents which are currently in place for the `Application User`.'
properties:
institutionId:
type: string
description: __Mandatory__. The `Institution` the authorisation request is sent to.
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
IsoBankTransactionCode:
type: object
description: "Defines the underlying transaction type (e.g. Card or Debit Transactions, Loans or Mortages). \n\n Conforms\
\ to `ISO` standards - ISO 20022."
properties:
domainCode:
$ref: '#/components/schemas/IsoCodeDetails'
familyCode:
$ref: '#/components/schemas/IsoCodeDetails'
subFamilyCode:
$ref: '#/components/schemas/IsoCodeDetails'
IsoCodeDetails:
type: object
description: __Mandatory__. Details the identification of the ISO code.
properties:
code:
default: UNKNOWN
description: __Mandatory__. Unique identifier of the ISO code.
type: string
name:
default: UNKNOWN
description: __Mandatory__. Name of the ISO Code.
type: string
Merchant:
type: object
description: Details of the merchant involved in the transaction.
properties:
merchantName:
type: string
description: The name of the merchant involved in the transaction.
merchantCategoryCode:
type: string
format: ^\d{4}$
description: 'Defines the underlying services and goods that the merchant provides. 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)'
Metadata:
type: object
properties:
tracingId:
type: string
format: uuid
description: yapily tracing id
NewApplicationUser:
type: object
description: Details of a new user to be created for the application.
properties:
applicationUserId:
type: string
description: __Optional__. The unique identifier of the `Application User` assigned by the Application Owner.
example: user-234562290
referenceId:
type: string
description: __Deprecated__. A non-unique reference Id for the `Application User`.
vopOptOut:
type: boolean
description: __Optional__. A flag to indicate whether the user has opted out of VOP.
default: false
Next:
type: object
properties:
from:
type: string
format: date-time
before:
type: string
format: date-time
limit:
type: integer
format: int32
cursor:
type: string
Notification:
description: Subscription details for how and where to receive notifications.
type: object
required:
- type
- url
properties:
type:
type: string
description: How the notification will be delivered. This is currently only via WEBHOOK.
example: WEBHOOK
url:
type: string
description: URL to which the notification will be sent.
example: https://httpbin.com/new_endpoint
Pagination:
type: object
properties:
totalCount:
type: integer
format: int64
self:
$ref: '#/components/schemas/FilterAndSort'
next:
$ref: '#/components/schemas/Next'
PatchOperation:
type: string
description: The operation to be performed
enum:
- add
- replace
PaymentConstraintsResponse:
required:
- institutionId
- institutionCountry
- paymentType
- request
type: object
properties:
institutionId:
type: string
description: The id to represent the `Institution`.
example: modelo-sandbox
institutionCountryCode:
type: string
description: 2 letter ISO Country code of the `Institution`.
example: GB
endpointPath:
type: string
description: Define the applicable API end point.
endpointMethod:
type: string
description: Https Method for the endpoint.
paymentType:
$ref: '#/components/schemas/PaymentTypeOfConstraints'
request:
$ref: '#/components/schemas/RequestConstraints'
PaymentTypeOfConstraints:
title: Payment Type
type: string
description: Payment type associated with constraints.
enum:
- DOMESTIC_PAYMENT
- DOMESTIC_INSTANT_PAYMENT
- DOMESTIC_VARIABLE_RECURRING_PAYMENT
- DOMESTIC_SCHEDULED_PAYMENT
- DOMESTIC_PERIODIC_PAYMENT
- INTERNATIONAL_PAYMENT
- INTERNATIONAL_SCHEDULED_PAYMENT
- INTERNATIONAL_PERIODIC_PAYMENT
ProprietaryBankTransactionCode:
type: object
description: Transaction code that is proprietary to the `Institution`.
properties:
code:
type: string
description: __Mandatory__. Proprietary code used to identify the underlying transaction.
issuer:
type: string
description: __Mandatory__. Issuer of the proprietary code.
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
RegisteredWebhook:
type: object
properties:
id:
type: string
description: This webhook's ID, used to update or remove the webhook
format: uuid
applicationId:
type: string
format: uuid
categories:
type: array
items:
type: string
description: One or more event categories for which the webhook will be triggered
callbackUrl:
type: object
description: Callback URLs where events will be sent
properties:
main:
type: object
description: Primary URL where events will be sent
properties:
url:
type: string
backup:
type: object
description: Secondary URL where events will be sent whenever the primary URL is not responding
properties:
url:
type: string
metadata:
$ref: '#/components/schemas/WebhookMetadata'
RegisteredWebhookWithStatus:
allOf:
- $ref: '#/components/schemas/RegisteredWebhook'
- type: object
properties:
status:
$ref: '#/components/schemas/WebhookStatusType'
RequestConstraints:
required:
- body
type: object
description: Object defining the constraints rules applicable for a given requests.
properties:
headers:
$ref: '#/components/schemas/Schema'
body:
$ref: '#/components/schemas/Schema'
ResponseForwardedData:
type: object
properties:
headers:
type: object
additionalProperties:
type: string
url:
type: string
ResponseListMeta:
type: object
properties:
tracingId:
type: string
count:
type: integer
format: int32
pagination:
$ref: '#/components/schemas/Pagination'
ResponseMeta:
type: object
properties:
tracingId:
type: string
Schema:
type: object
properties:
title:
type: string
maximum:
type: number
exclusiveMaximum:
type: number
minimum:
type: number
exclusiveMinimum:
type: number
pattern:
type: string
format: regex
maxItems:
type: integer
minimum: 0
minItems:
type: integer
minimum: 0
uniqueItems:
type: boolean
required:
type: array
items:
type: string
minItems: 1
uniqueItems: true
enum:
type: array
items: {}
minItems: 1
uniqueItems: false
type:
$ref: '#/components/schemas/SchemaType'
contains:
$ref: '#/components/schemas/Schema'
not:
$ref: '#/components/schemas/Schema'
if:
$ref: '#/components/schemas/Schema'
then:
$ref: '#/components/schemas/Schema'
else:
$ref: '#/components/schemas/Schema'
allOf:
type: array
items:
$ref: '#/components/schemas/Schema'
oneOf:
type: array
items:
$ref: '#/components/schemas/Schema'
anyOf:
type: array
items:
$ref: '#/components/schemas/Schema'
items:
$ref: '#/components/schemas/Schema'
properties:
type: object
additionalProperties:
$ref: '#/components/schemas/Schema'
description:
type: string
format:
type: string
default: {}
example: {}
dependentRequired:
description: dependentRequired keyword is used to satisfy dependency between fields
type: object
additionalProperties:
type: array
items:
type: string
uniqueItems: true
default: []
$defs:
type: object
additionalProperties:
$ref: '#/components/schemas/Schema'
$ref:
type: string
x-yapily-annotations:
type: object
properties:
lastUpdatedAt:
type: string
format: date-time
x-yapily-validations:
type: object
properties:
maxDurationFromNow:
type: string
format: duration
additionalProperties: false
SchemaType:
type: string
enum:
- array
- boolean
- integer
- number
- object
- string
SortEnum:
type: string
description: The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
enum:
- date
- -date
StatementReference:
type: object
description: Unique reference for a statement period. This may be optionally populated if available.
properties:
value:
type: string
Transaction:
type: object
description: Details of a transaction (credit or debit) that has occurred on the account.
properties:
id:
type: string
description: Unique identifier of the transaction.
date:
type: string
format: date-time
bookingDateTime:
type: string
description: Date and time in UTC format of when a transaction was booked.
format: date-time
valueDateTime:
type: string
description: Date and time in UTC format when the funds either cease to be available (for debit transactions) or
become available (for credit transactions) to the account owner.
format: date-time
status:
$ref: '#/components/schemas/TransactionStatusEnum'
amount:
type: number
description: The transaction amount.
currency:
type: string
description: Currency the transaction amount is denoted in. Specified as a 3-letter ISO 4217 code.
transactionAmount:
$ref: '#/components/schemas/Amount'
grossAmount:
$ref: '#/components/schemas/Amount'
currencyExchange:
$ref: '#/components/schemas/CurrencyExchange'
chargeDetails:
$ref: '#/components/schemas/TransactionChargeDetails'
reference:
type: string
statementReferences:
type: array
items:
$ref: '#/components/schemas/StatementReference'
description:
type: string
transactionInformation:
type: array
description: Further details on the transaction. This is narrative data, caught as unstructured text.
items:
type: string
addressDetails:
$ref: '#/components/schemas/AddressDetails'
isoBankTransactionCode:
$ref: '#/components/schemas/IsoBankTransactionCode'
proprietaryBankTransactionCode:
$ref: '#/components/schemas/ProprietaryBankTransactionCode'
balance:
$ref: '#/components/schemas/TransactionBalance'
payeeDetails:
type: object
description: Details of the beneficiary [person or business].
properties:
name:
type: string
description: The account holder name of the Payee.
accountIdentifications:
type: array
description: The account identifications that identify the Payee's bank account.
items:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/AccountIdentificationType'
description: Describes the format of the account.
identification:
type: string
description: The value associated with the account identification type.
payerDetails:
type: object
description: Details of the benefactor [person or business].
properties:
name:
type: string
description: The account holder name of the Payer.
accountIdentifications:
type: array
description: The account identifications that identify the Payer's bank account.
items:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/AccountIdentificationType'
description: Describes the format of the account.
identification:
type: string
description: The value associated with the account identification type.
merchant:
$ref: '#/components/schemas/Merchant'
enrichment:
$ref: '#/components/schemas/Enrichment'
supplementaryData:
type: object
description: Additional information that cannot be captured in a structured field or block.
transactionMutability:
type: string
description: '__Optional__. Specifies the Mutability of the Transaction record.
- A transaction with a `Status` of `Pending` is mutable.
- A transaction with a `Status` of `Booked` where the `TransactionMutability` flag is not specified is not guaranteed
to be immutable (although in most instances it will be).
- A transaction with a `Status` of `Booked` with the `TransactionMutability` flag set to `Immutable` is immutable.
- A transaction with a `Status` of `Booked` with the `TransactionMutability` flag set to `Mutable` is mutable.'
example: Mutable
TransactionBalance:
type: object
properties:
type:
$ref: '#/components/schemas/AccountBalanceType'
balanceAmount:
$ref: '#/components/schemas/Amount'
TransactionChargeDetails:
type: object
description: Details the charges that will apply to the transaction.
properties:
chargeAmount:
$ref: '#/components/schemas/Amount'
TransactionHash:
type: object
description: An unique identifier for the transaction that was generated by Yapily. This is a hash of transaction attributes
and may be useful an id is not present (and therefore hasn't been provided by an Institution).
properties:
hash:
type: string
TransactionStatusEnum:
type: string
enum:
- BOOKED
- PENDING
UserDeleteResponse:
type: object
description: Deletion of the user. Includes the user profile and all associate consents.
properties:
id:
type: string
description: Unique identifier of the user.
deleteStatus:
$ref: '#/components/schemas/DeleteStatusEnum'
creationDate:
type: string
format: date-time
description: Date and time that the user was created.
userConsents:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/ConsentDeleteResponse'
ValidationError:
required:
- fieldName
- error
properties:
fieldName:
type: string
format: string
description: name of the field with error
error:
$ref: '#/components/schemas/EnumError'
ValidationErrorResponse:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/ValidationError'
VrpConfiguration:
properties:
maximumIndividualAmount:
description: Maximum amount per transaction
allOf:
- $ref: '#/components/schemas/Amount'
maximumCumulativeAmount:
description: Maximum cumulative amount
allOf:
- $ref: '#/components/schemas/Amount'
maximumCumulativeNumberOfPayments:
description: Maximum cumulative number of payments
type: integer
minimum: 0
periodicLimits:
type: array
items:
$ref: '#/components/schemas/VrpPeriodicLimit'
minItems: 1
recurringPaymentCategory:
description: 'Payment Category with allowed values: ONGOING, SUBSCRIPTION'
type: string
example: ONGOING
VrpPeriodicLimit:
required:
- maximumAmount
- frequency
- alignment
properties:
maximumAmount:
description: __Mandatory__. Maximum amount that can be specified in all payment instructions in a given period under
this VRP consent. If the Alignment is Calendar, the limit is pro-rated in the first period to the remaining number
of days.
allOf:
- $ref: '#/components/schemas/Amount'
frequency:
$ref: '#/components/schemas/FrequencyEnum'
alignment:
$ref: '#/components/schemas/AlignmentEnum'
WebhookMetadata:
type: object
description: Any data (under 10kB total) that should be associated with the Webhook. A copy of this data will be returned
on every Webhook trigger.
additionalProperties:
type: string
WebhookStatusType:
type: string
enum:
- active
- paused
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