openapi: 3.0.3
info:
  title: Mangopay REST Bank Accounts API
  description: The Mangopay REST API enables platforms to manage users, e-wallets, pay-ins, payouts, transfers, foreign exchange, KYC/KYB identity verification, fraud prevention, and dispute handling for multi-party payment flows.
  version: '2.01'
  contact:
    name: Mangopay Support
    url: https://hub.mangopay.com
servers:
- url: https://api.mangopay.com/v2.01/{clientId}
  description: Production
  variables:
    clientId:
      default: your-client-id
      description: Your Mangopay Client ID
- url: https://api.sandbox.mangopay.com/v2.01/{clientId}
  description: Sandbox
  variables:
    clientId:
      default: your-client-id
      description: Your Mangopay Client ID
security:
- OAuth2: []
tags:
- name: Bank Accounts
paths:
  /users/{userId}/bankaccounts/iban:
    post:
      tags:
      - Bank Accounts
      summary: Create an IBAN Bank Account
      operationId: post_users_userId_bankaccounts_iban
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#create-iban-bank-account](https://mangopay.com/docs/endpoints/payouts#create-iban-bank-account)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              OwnerName: '{{$randomFullName}}'
              OwnerAddress:
                AddressLine1: '{{$randomStreetAddress}}'
                AddressLine2: '{{$randomStreetName}}'
                City: Paris
                Region: Ile-de-France
                PostalCode: '75001'
                Country: FR
              IBAN: FR7630004000031234567890143
              BIC: BNPAFRPP
              Tag: Created using Mangopay API Postman Collection
  /users/{userId}/bankaccounts/us:
    post:
      tags:
      - Bank Accounts
      summary: Create a US Bank Account
      operationId: post_users_userId_bankaccounts_us
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#create-us-bank-account](https://mangopay.com/docs/endpoints/payouts#create-us-bank-account)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              OwnerName: '{{$randomFullName}}'
              OwnerAddress:
                AddressLine1: '{{$randomStreetAddress}}'
                AddressLine2: '{{$randomStreetName}}'
                City: Paris
                Region: Ile-de-France
                PostalCode: '75001'
                Country: FR
              AccountNumber: '11696419'
              ABA: 071000288
              DepositAccountType: CHECKING
              Tag: Created using Mangopay API Postman Collection
  /users/{userId}/bankaccounts/ca:
    post:
      tags:
      - Bank Accounts
      summary: Create a CA Bank Account
      operationId: post_users_userId_bankaccounts_ca
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#create-ca-bank-account](https://mangopay.com/docs/endpoints/payouts#create-ca-bank-account)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              OwnerName: '{{$randomFullName}}'
              OwnerAddress:
                AddressLine1: '{{$randomStreetAddress}}'
                AddressLine2: '{{$randomStreetName}}'
                City: Paris
                Region: Ile-de-France
                PostalCode: '75001'
                Country: FR
              AccountNumber: '11696419'
              BranchCode: '00152'
              InstitutionNumber: '614'
              BankName: The Official Canadian Bank
              Tag: Created using Mangopay API Postman Collection
  /users/{userId}/bankaccounts/gb:
    post:
      tags:
      - Bank Accounts
      summary: Create a GB Bank Account
      operationId: post_users_userId_bankaccounts_gb
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#create-gb-bank-account](https://mangopay.com/docs/endpoints/payouts#create-gb-bank-account)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              OwnerName: '{{$randomFullName}}'
              OwnerAddress:
                AddressLine1: '{{$randomStreetAddress}}'
                AddressLine2: '{{$randomStreetName}}'
                City: Paris
                Region: Ile-de-France
                PostalCode: '75001'
                Country: FR
              SortCode: 010039
              AccountNumber: '11696419'
              Tag: Created using Mangopay API Postman Collection
  /users/{userId}/bankaccounts/other:
    post:
      tags:
      - Bank Accounts
      summary: Create an OTHER Bank Account
      operationId: post_users_userId_bankaccounts_other
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#create-other-bank-account](https://mangopay.com/docs/endpoints/payouts#create-other-bank-account)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              OwnerName: '{{$randomFullName}}'
              OwnerAddress:
                AddressLine1: '{{$randomStreetAddress}}'
                AddressLine2: '{{$randomStreetName}}'
                City: Paris
                Region: Ile-de-France
                PostalCode: '75001'
                Country: FR
              Country: FR
              BIC: BNPAFRPP
              AccountNumber: '11696419'
              Tag: Created using Mangopay API Postman Collection
  /users/{userId}/bankaccounts/{legaluserbankaccountid}:
    get:
      tags:
      - Bank Accounts
      summary: View a Bank Account
      operationId: get_users_userId_bankaccounts_legaluserbankaccountid
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: legaluserbankaccountid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#view-bank-account](https://mangopay.com/docs/endpoints/payouts#view-bank-account)'
    put:
      tags:
      - Bank Accounts
      summary: Deactivate a Bank Account
      operationId: put_users_userId_bankaccounts_legaluserbankaccountid
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: legaluserbankaccountid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#deactivate-bank-account](https://mangopay.com/docs/endpoints/payouts#deactivate-bank-account)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              Active: false
  /users/{userId}/bankaccounts:
    get:
      tags:
      - Bank Accounts
      summary: List Bank Accounts for a User
      operationId: get_users_userId_bankaccounts
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/payouts#list-bank-accounts-for-user](https://mangopay.com/docs/endpoints/payouts#list-bank-accounts-for-user)'
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.mangopay.com/v2.01/{clientId}/oauth/token
          scopes: {}