openapi: 3.0.3
info:
  title: Mangopay REST Bank Accounts Wallets 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: Wallets
paths:
  /wallets:
    post:
      tags:
      - Wallets
      summary: Create a Wallet
      operationId: post_wallets
      parameters: []
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      description: '[https://mangopay.com/docs/endpoints/wallets#create-wallet](https://mangopay.com/docs/endpoints/wallets#create-wallet)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              Owners:
              - '{{USER_ID}}'
              Description: Description of the user's wallet
              Currency: '{{CURRENCY}}'
              Tag: Created using Mangopay API Postman Collection
  /wallets/{walletId}:
    put:
      tags:
      - Wallets
      summary: Update a Wallet
      operationId: put_wallets_walletId
      parameters:
      - name: walletId
        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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              Description: Description of the user's wallet
              Tag: Created using Mangopay API Postman Collection
    get:
      tags:
      - Wallets
      summary: View a Wallet
      operationId: get_wallets_walletId
      parameters:
      - name: walletId
        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
  /wallets/{usernaturalpayerwalletid}:
    put:
      tags:
      - Wallets
      summary: Update a Wallet (Natural Payer User)
      operationId: put_wallets_usernaturalpayerwalletid
      parameters:
      - name: usernaturalpayerwalletid
        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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              Description: Description of the user's wallet
              Tag: Created using Mangopay API Postman Collection
    get:
      tags:
      - Wallets
      summary: View a Wallet (Natural Payer User)
      operationId: get_wallets_usernaturalpayerwalletid
      parameters:
      - name: usernaturalpayerwalletid
        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
  /wallets/{usernaturalownerwalletid}:
    put:
      tags:
      - Wallets
      summary: Update a Wallet (Natural Owner User)
      operationId: put_wallets_usernaturalownerwalletid
      parameters:
      - name: usernaturalownerwalletid
        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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              Description: Description of the user's wallet
              Tag: Created using Mangopay API Postman Collection
    get:
      tags:
      - Wallets
      summary: View a Wallet (Natural Owner User)
      operationId: get_wallets_usernaturalownerwalletid
      parameters:
      - name: usernaturalownerwalletid
        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
  /wallets/{userlegalownerwalletid}:
    put:
      tags:
      - Wallets
      summary: Update a Wallet (Legal Owner User)
      operationId: put_wallets_userlegalownerwalletid
      parameters:
      - name: userlegalownerwalletid
        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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              Description: Description of the user's wallet
              Tag: Created using Mangopay API Postman Collection
    get:
      tags:
      - Wallets
      summary: View a Wallet with SCA (Legal Owner User)
      operationId: get_wallets_userlegalownerwalletid
      parameters:
      - name: userlegalownerwalletid
        in: path
        required: true
        schema:
          type: string
      - name: ScaContext
        in: query
        required: false
        schema:
          type: string
        description: ''
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /users/{userId}/wallets:
    get:
      tags:
      - Wallets
      summary: List Wallets for a User with SCA (Natural Owner User)
      operationId: get_users_userId_wallets
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: ScaContext
        in: query
        required: false
        schema:
          type: string
        description: ''
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /wallets/{usernaturalpayerwalletid}/transactions:
    get:
      tags:
      - Wallets
      summary: List Transactions for a Wallet (Natural Payer User)
      operationId: get_wallets_usernaturalpayerwalletid_transactions
      parameters:
      - name: usernaturalpayerwalletid
        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
  /wallets/{usernaturalownerwalletid}/transactions:
    get:
      tags:
      - Wallets
      summary: List Transactions for a Wallet with SCA (Natural Owner User)
      operationId: get_wallets_usernaturalownerwalletid_transactions
      parameters:
      - name: usernaturalownerwalletid
        in: path
        required: true
        schema:
          type: string
      - name: ScaContext
        in: query
        required: false
        schema:
          type: string
        description: ''
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /wallets/{userlegalownerwalletid}/transactions:
    get:
      tags:
      - Wallets
      summary: List Transactions for a Wallet with SCA (Legal Owner User)
      operationId: get_wallets_userlegalownerwalletid_transactions
      parameters:
      - name: userlegalownerwalletid
        in: path
        required: true
        schema:
          type: string
      - name: ScaContext
        in: query
        required: false
        schema:
          type: string
        description: ''
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.mangopay.com/v2.01/{clientId}/oauth/token
          scopes: {}