openapi: 3.2.0
info:
  title: Trolley API
  version: '1'
  description: Canonical contract generated from audited API documentation.
servers:
- url: https://api.trolley.com
security:
- ApiKeyAuth: []
paths:
  /v1/balances:
    get:
      operationId: getV1Balances
      summary: Retrieve all account balances
      description: Generated from `api/balances/all_account.md`.
      tags:
      - balances
      x-doc-source: api/balances/all_account.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/balances/info:
    get:
      operationId: getV1BalancesInfo
      summary: Get Funding Information
      description: Generated from `partner/bank-account-list.md`.
      tags:
      - partner
      x-doc-source: partner/bank-account-list.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/balances/paymentrails:
    get:
      operationId: getV1BalancesPaymentrails
      summary: Retrieve Trolley account balance
      description: Generated from `api/balances/account_balance.md`.
      tags:
      - balances
      x-doc-source: api/balances/account_balance.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/balances/paypal:
    get:
      operationId: getV1BalancesPaypal
      summary: Retrieve PayPal account balance
      description: Generated from `api/balances/paypal_balance.md`.
      tags:
      - balances
      x-doc-source: api/balances/paypal_balance.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/batches:
    delete:
      operationId: deleteV1Batches
      summary: Delete multiple batches
      description: Generated from `api/payments/delete_multiple_batch.md`.
      tags:
      - payments
      x-doc-source: api/payments/delete_multiple_batch.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      operationId: getV1Batches
      summary: List all batches
      description: Generated from `api/payments/list_all.md`.
      tags:
      - payments
      x-doc-source: api/payments/list_all.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: postV1Batches
      summary: Create a batch
      description: Generated from `api/payments/create_batch.md`.
      tags:
      - payments
      x-doc-source: api/payments/create_batch.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                currency:
                  type: string
                description:
                  type: string
                payments:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
                tags:
                  type: string
              additionalProperties: true
            example: {}
  /v1/batches/{batch-id}/generate-quote:
    post:
      operationId: postV1BatchesBatchIdGenerateQuote
      summary: Generate quote
      description: Generated from `api/payments/generate_quote.md`.
      tags:
      - payments
      x-doc-source: api/payments/generate_quote.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example: {}
  /v1/batches/{batch-id}/payments:
    get:
      operationId: getV1BatchesBatchIdPayments
      summary: List all Payments in Batch
      description: Generated from `api/payments/list_payments_in_batch.md`.
      tags:
      - payments
      x-doc-source: api/payments/list_payments_in_batch.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: postV1BatchesBatchIdPayments
      summary: Create a payment
      description: Generated from `api/payments/create_payment.md`.
      tags:
      - payments
      x-doc-source: api/payments/create_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: string
                category:
                  type: string
                coverFees:
                  type: string
                currency:
                  type: string
                externalId:
                  type: string
                forceUsTaxActivity:
                  type: string
                memo:
                  type: string
                recipient:
                  type: string
                sourceAmount:
                  type: string
                sourceCurrency:
                  type: string
                tags:
                  type: string
                targetAmount:
                  type: string
                targetCurrency:
                  type: string
                taxReportable:
                  type: string
              additionalProperties: true
              required:
              - recipient
            example:
              recipient: ''
  /v1/batches/{batch-id}/payments/{payment-id}:
    delete:
      operationId: deleteV1BatchesBatchIdPaymentsPaymentId
      summary: Delete a payment
      description: Generated from `api/payments/delete_payment.md`.
      tags:
      - payments
      x-doc-source: api/payments/delete_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      operationId: getV1BatchesBatchIdPaymentsPaymentId
      summary: Retrieve a payment
      description: Generated from `api/payments/retrieve_payment.md`.
      tags:
      - payments
      x-doc-source: api/payments/retrieve_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: patchV1BatchesBatchIdPaymentsPaymentId
      summary: Update a payment
      description: Generated from `api/payments/update_payment.md`.
      tags:
      - payments
      x-doc-source: api/payments/update_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: string
                category:
                  type: string
                coverFees:
                  type: string
                currency:
                  type: string
                externalId:
                  type: string
                memo:
                  type: string
                sourceAmount:
                  type: string
                sourceCurrency:
                  type: string
                tags:
                  type: string
                targetAmount:
                  type: string
                targetCurrency:
                  type: string
                taxReportable:
                  type: string
              additionalProperties: true
            example: {}
  /v1/batches/{batch-id}/start-processing:
    post:
      operationId: postV1BatchesBatchIdStartProcessing
      summary: Process a batch
      description: Generated from `api/payments/process_batch.md`.
      tags:
      - payments
      x-doc-source: api/payments/process_batch.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example: {}
  /v1/batches/{batch-id}/summary:
    get:
      operationId: getV1BatchesBatchIdSummary
      summary: Batch summary
      description: Generated from `api/payments/batch_summary.md`.
      tags:
      - payments
      x-doc-source: api/payments/batch_summary.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/batches/{id}:
    delete:
      operationId: deleteV1BatchesId
      summary: Delete a batch
      description: Generated from `api/payments/delete_batch.md`.
      tags:
      - payments
      x-doc-source: api/payments/delete_batch.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      operationId: getV1BatchesId
      summary: Retrieve a batch
      description: Generated from `api/payments/retrieve_batch.md`.
      tags:
      - payments
      x-doc-source: api/payments/retrieve_batch.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/geography/countries/CA:
    get:
      operationId: getV1GeographyCountriesCa
      summary: List of Regions
      description: Generated from `api/references/2-list_of_regions.md`.
      tags:
      - references
      x-doc-source: api/references/2-list_of_regions.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/geography/countries/{code}:
    get:
      operationId: getV1GeographyCountriesCode
      summary: List of Regions
      description: Generated from `api/references/2-list_of_regions.md`.
      tags:
      - references
      x-doc-source: api/references/2-list_of_regions.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/iframe/config:
    post:
      operationId: postV1IframeConfig
      summary: Widget Configuration
      description: Generated from `partner/widget.md`.
      tags:
      - partner
      x-doc-source: partner/widget.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                colors:
                  type: string
              additionalProperties: true
              required:
              - colors
            example:
              colors: ''
  /v1/invoices/create:
    post:
      operationId: postV1InvoicesCreate
      summary: Create an invoice
      description: Generated from `api/invoices/create_invoice.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/create_invoice.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                dueDate:
                  type: string
                externalId:
                  type: string
                invoiceDate:
                  type: string
                lines:
                  type: string
                recipientId:
                  type: string
                tags:
                  type: string
              additionalProperties: true
              required:
              - recipientId
            example:
              recipientId: ''
  /v1/invoices/create-lines:
    post:
      operationId: postV1InvoicesCreateLines
      summary: Create an invoice line
      description: Generated from `api/invoices/create_invoice_line.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/create_invoice_line.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                invoiceId:
                  type: string
                lines:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
              additionalProperties: true
              required:
              - invoiceId
              - lines
            example:
              invoiceId: ''
              lines:
              - {}
  /v1/invoices/delete:
    post:
      operationId: postV1InvoicesDelete
      summary: Delete an invoice
      description: Generated from `api/invoices/delete_invoice.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/delete_invoice.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                invoiceIds:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
              additionalProperties: true
              required:
              - invoiceIds
            example:
              invoiceIds:
              - {}
  /v1/invoices/delete-lines:
    post:
      operationId: postV1InvoicesDeleteLines
      summary: Delete an invoice line
      description: Generated from `api/invoices/delete_invoice_line.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/delete_invoice_line.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                invoiceId:
                  type: string
                invoiceLineIds:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
              additionalProperties: true
              required:
              - invoiceId
              - invoiceLineIds
            example:
              invoiceId: ''
              invoiceLineIds:
              - {}
  /v1/invoices/get:
    post:
      operationId: postV1InvoicesGet
      summary: Get invoice
      description: Generated from `api/invoices/get_invoice.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/get_invoice.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                invoiceId:
                  type: string
              additionalProperties: true
              required:
              - invoiceId
            example:
              invoiceId: ''
  /v1/invoices/payment/create:
    post:
      operationId: postV1InvoicesPaymentCreate
      summary: Create an invoice payment
      description: Generated from `api/invoices/create_invoice_payment.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/create_invoice_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                batchId:
                  type: string
                coverFees:
                  type: string
                externalId:
                  type: string
                ids:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
                memo:
                  type: string
                tags:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
              additionalProperties: true
              required:
              - ids
            example:
              ids:
              - {}
  /v1/invoices/payment/delete:
    post:
      operationId: postV1InvoicesPaymentDelete
      summary: Delete an invoice payment
      description: Generated from `api/invoices/delete_invoice_payment.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/delete_invoice_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                invoiceLineIds:
                  type: string
                paymentId:
                  type: string
              additionalProperties: true
              required:
              - paymentId
              - invoiceLineIds
            example:
              paymentId: ''
              invoiceLineIds: ''
  /v1/invoices/payment/search:
    post:
      operationId: postV1InvoicesPaymentSearch
      summary: Search invoice payments
      description: Generated from `api/invoices/search_invoice_payment.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/search_invoice_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                invoiceIds:
                  type: string
                paymentIds:
                  type: string
              additionalProperties: true
            example: {}
  /v1/invoices/payment/update:
    post:
      operationId: postV1InvoicesPaymentUpdate
      summary: Update an invoice payment
      description: Generated from `api/invoices/update_invoice_payment.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/update_invoice_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: string
                coverFees:
                  type: string
                externalId:
                  type: string
                invoiceId:
                  type: string
                invoiceLineId:
                  type: string
                memo:
                  type: string
                paymentId:
                  type: string
                tags:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
              additionalProperties: true
              required:
              - invoiceId
              - invoiceLineId
              - paymentId
              - amount
            example:
              invoiceId: ''
              invoiceLineId: ''
              paymentId: ''
              amount: ''
  /v1/invoices/search:
    post:
      operationId: postV1InvoicesSearch
      summary: Search invoices
      description: Generated from `api/invoices/search_invoices.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/search_invoices.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                coverFees:
                  type: string
                externalId:
                  type: string
                invoiceDate:
                  type: string
                invoiceIds:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
                invoiceNumber:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
                memo:
                  type: string
                page:
                  type: string
                pageSize:
                  type: string
                paymentIds:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
                recipientId:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
                tags:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
              additionalProperties: true
            example: {}
  /v1/invoices/update:
    post:
      operationId: postV1InvoicesUpdate
      summary: Update an invoice
      description: Generated from `api/invoices/update_invoice.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/update_invoice.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                dueDate:
                  type: string
                externalId:
                  type: string
                invoiceDate:
                  type: string
                invoiceId:
                  type: string
                tags:
                  type: string
              additionalProperties: true
              required:
              - invoiceId
            example:
              invoiceId: ''
  /v1/invoices/update-lines:
    post:
      operationId: postV1InvoicesUpdateLines
      summary: Update invoice lines
      description: Generated from `api/invoices/update_invoice_line.md`.
      tags:
      - invoices
      x-doc-source: api/invoices/update_invoice_line.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                invoiceId:
                  type: string
                lines:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
              additionalProperties: true
              required:
              - invoiceId
              - lines
            example:
              invoiceId: ''
              lines:
              - {}
  /v1/offline-payments:
    get:
      operationId: getV1OfflinePayments
      summary: List all offline payments
      description: Generated from `api/offlinePayments/list_all_offline_payments.md`.
      tags:
      - offlinePayments
      x-doc-source: api/offlinePayments/list_all_offline_payments.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/onboarding/update:
    post:
      operationId: postV1OnboardingUpdate
      summary: Modify Onboarding Information
      description: Generated from `partner/onboarding.md`.
      tags:
      - partner
      x-doc-source: partner/onboarding.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                businessPpm:
                  type: string
                businessTotalMonthly:
                  type: string
              additionalProperties: true
            example: {}
  /v1/payments/{payment-id}:
    get:
      operationId: getV1PaymentsPaymentId
      summary: Retrieve a payment
      description: Generated from `api/payments/retrieve_payment.md`.
      tags:
      - payments
      x-doc-source: api/payments/retrieve_payment.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/profile/sandbox:
    delete:
      operationId: deleteV1ProfileSandbox
      summary: Sandbox Merchant
      description: Generated from `partner/sandbox.md`.
      tags:
      - partner
      x-doc-source: partner/sandbox.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: postV1ProfileSandbox
      summary: Sandbox Merchant
      description: Generated from `partner/sandbox.md`.
      tags:
      - partner
      x-doc-source: partner/sandbox.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                apikey:
                  type: string
                id:
                  type: string
                merchant:
                  type: string
              additionalProperties: true
              required:
              - apikey
              - merchant
              - id
            example:
              apikey: ''
              merchant: ''
              id: ''
  /v1/profile/submerchant:
    post:
      operationId: postV1ProfileSubmerchant
      summary: Create Sub-merchant
      description: Generated from `partner/create.md`.
      tags:
      - partner
      x-doc-source: partner/create.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                merchant:
                  type: string
                onboarding:
                  type: string
              additionalProperties: true
              required:
              - merchant
              - onboarding
            example:
              merchant: ''
              onboarding: ''
  /v1/recipients:
    delete:
      operationId: deleteV1Recipients
      summary: Delete multiple recipients
      description: Generated from `api/recipient/delete_multiple_recipient.md`.
      tags:
      - recipient
      x-doc-source: api/recipient/delete_multiple_recipient.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      operationId: getV1Recipients
      summary: List all recipients
      description: Generated from `api/recipient/list_all_recipients.md`.
      tags:
      - recipient
      x-doc-source: api/recipient/list_all_recipients.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/recipients/{id}:
    delete:
      operationId: deleteV1RecipientsId
      summary: Delete a recipient
      description: Generated from `api/recipient/delete_recipient.md`.
      tags:
      - recipient
      x-doc-source: api/recipient/delete_recipient.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: patchV1RecipientsId
      summary: Update a recipient
      description: Generated from `api/recipient/update_recipient.md`.
      tags:
      - recipient
      x-doc-source: api/recipient/update_recipient.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: string
              additionalProperties: true
            example: {}
  /v1/recipients/{id}/accounts:
    post:
      operationId: postV1RecipientsIdAccounts
      summary: Create Account
      description: Generated from `api/account/create_account.md`.
      tags:
      - account
      x-doc-source: api/account/create_account.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                accountHolderName:
                  type: string
                accountNum:
                  type: string
                bankId:
                  type: string
                branchId:
                  type: string
                country:
                  type: string
                currency:
                  type: string
                emailAddress:
                  type: string
                iban:
                  type: string
                primary:
                  type: string
                swiftBic:
                  type: string
                type:
                  type: string
              additionalProperties: true
              required:
              - type
              - currency
              - country
              - accountHolderName
              - accountNum
              - emailAddress
            example:
              type: ''
              currency: ''
              country: ''
              accountHolderName: ''
              accountNum: ''
              emailAddress: ''
  /v1/recipients/{id}/accounts/{recipientAccountId}:
    delete:
      operationId: deleteV1RecipientsIdAccountsRecipientaccountid
      summary: Delete Account
      description: Generated from `api/account/delete_account.md`.
      tags:
      - account
      x-doc-source: api/account/delete_account.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      operationId: getV1RecipientsIdAccountsRecipientaccountid
      summary: Retrieve Account
      description: Generated from `api/account/retrieve_account.md`.
      tags:
      - account
      x-doc-source: api/account/retrieve_account.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: patchV1RecipientsIdAccountsRecipientaccountid
      summary: Update Account
      description: Generated from `api/account/update_account.md`.
      tags:
      - account
      x-doc-source: api/account/update_account.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example: {}
  /v1/recipients/{id}/logs:
    get:
      operationId: getV1RecipientsIdLogs
      summary: Retrieve all logs
      description: Generated from `api/recipient/retrieve_log.md`.
      tags:
      - recipient
      x-doc-source: api/recipient/retrieve_log.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/recipients/{id}/offlinePayments:
    get:
      operationId: getV1RecipientsIdOfflinepayments
      summary: Retrieve recipient's offline payments
      description: Generated from `api/recipient/retrieve_offline_payments.md`.
      tags:
      - recipient
      x-doc-source: api/recipient/retrieve_offline_payments.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: postV1RecipientsIdOfflinepayments
      summary: Create an offline payment
      description: Generated from `api/offlinePayments/create_offline_payments.md`.
      tags:
      - offlinePayments
      x-doc-source: api/offlinePayments/create_offline_payments.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                activityCount:
                  type: string
                amount:
                  type: string
                category:
                  type: string
                currency:
                  type: string
                externalId:
                  type: string
                memo:
                  type: string
                payoutMethod:
                  type: string
                processedAt:
                  type: string
                tags:
                  type: string
                taxReportable:
                  type: string
                withholdingAmount:
                  type: string
                withholdingCurrency:
                  type: string
              additionalProperties: true
              required:
              - amount
              - withholdingAmount
            example:
              amount: ''
              withholdingAmount: ''
  /v1/recipients/{id}/offlinePayments/{offlinePaymentId}:
    delete:
      operationId: deleteV1RecipientsIdOfflinepaymentsOfflinepaymentid
      summary: Delete an offline payment
      description: Generated from `api/offlinePayments/delete_offline_payments.md`.
      tags:
      - offlinePayments
      x-doc-source: api/offlinePayments/delete_offline_payments.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: patchV1RecipientsIdOfflinepaymentsOfflinepaymentid
      summary: Update an offline payment
      description: Generated from `api/offlinePayments/update_offline_payments.md`.
      tags:
      - offlinePayments
      x-doc-source: api/offlinePayments/update_offline_payments.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                activityCount:
                  type: string
                amount:
                  type: string
                category:
                  type: string
                currency:
                  type: string
                externalId:
                  type: string
                memo:
                  type: string
                payoutMethod:
                  type: string
                processedAt:
                  type: string
                tags:
                  type: string
                taxReportable:
                  type: string
                withholdingAmount:
                  type: string
                withholdingCurrency:
                  type: string
              additionalProperties: true
              required:
              - amount
              - withholdingAmount
            example:
              amount: ''
              withholdingAmount: ''
  /v1/recipients/{id}/payments:
    get:
      operationId: getV1RecipientsIdPayments
      summary: Retrieve all payments
      description: Generated from `api/recipient/retrieve_payments.md`.
      tags:
      - recipient
      x-doc-source: api/recipient/retrieve_payments.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/subscriptions:
    get:
      operationId: getV1Subscriptions
      summary: Webhooks List
      description: Generated from `partner/webhooks-list.md`.
      tags:
      - partner
      x-doc-source: partner/webhooks-list.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      operationId: postV1Subscriptions
      summary: Create Webhook
      description: Generated from `partner/webhooks-create.md`.
      tags:
      - partner
      x-doc-source: partner/webhooks-create.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                model:
                  type: string
                target:
                  type: string
              additionalProperties: true
              required:
              - action
              - model
              - target
            example:
              action: ''
              model: ''
              target: ''
  /v1/subscriptions/{id}:
    delete:
      operationId: deleteV1SubscriptionsId
      summary: Get, Update, and Delete Webhook
      description: Generated from `partner/webhook-update.md`.
      tags:
      - partner
      x-doc-source: partner/webhook-update.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    get:
      operationId: getV1SubscriptionsId
      summary: Get, Update, and Delete Webhook
      description: Generated from `partner/webhook-update.md`.
      tags:
      - partner
      x-doc-source: partner/webhook-update.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: patchV1SubscriptionsId
      summary: Get, Update, and Delete Webhook
      description: Generated from `partner/webhook-update.md`.
      tags:
      - partner
      x-doc-source: partner/webhook-update.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example: {}
  /v1/verifications:
    get:
      operationId: getV1Verifications
      summary: List all Verifications
      description: Generated from `api/trust/verification-api.md`.
      tags:
      - trust
      x-doc-source: api/trust/verification-api.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/verifications/expire:
    patch:
      operationId: patchV1VerificationsExpire
      summary: Expire a Verification
      description: Generated from `api/trust/expire-verifications.md`.
      tags:
      - trust
      x-doc-source: api/trust/expire-verifications.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example: {}
  /v1/verifications/watchlist/trigger:
    post:
      operationId: postV1VerificationsWatchlistTrigger
      summary: Trigger a Verification
      description: Generated from `api/trust/trigger-verifications.md`.
      tags:
      - trust
      x-doc-source: api/trust/trigger-verifications.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example: {}
  /v1/verifications/{verificationType}/trigger:
    post:
      operationId: postV1VerificationsVerificationtypeTrigger
      summary: Trigger a Verification
      description: Generated from `api/trust/trigger-verifications.md`.
      tags:
      - trust
      x-doc-source: api/trust/trigger-verifications.md
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            example: {}
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Use the `prsign ACCESS_KEY:SIGNATURE` format.
  schemas:
    SuccessResponse:
      type: object
      properties:
        ok:
          type: boolean
          example: true
      additionalProperties: true
    ErrorObject:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        field:
          type: string
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        ok:
          type: boolean
          example: false
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorObject'
      additionalProperties: true
x-generatedFromDocs:
  contentRoot: content/api
  contentRoots:
  - content/api
  - content/partner
  sourcesIncluded:
  - api/account/create_account.md
  - api/account/delete_account.md
  - api/account/retrieve_account.md
  - api/account/update_account.md
  - api/balances/account_balance.md
  - api/balances/all_account.md
  - api/balances/paypal_balance.md
  - api/invoices/create_invoice.md
  - api/invoices/create_invoice_line.md
  - api/invoices/create_invoice_payment.md
  - api/invoices/delete_invoice.md
  - api/invoices/delete_invoice_line.md
  - api/invoices/delete_invoice_payment.md
  - api/invoices/get_invoice.md
  - api/invoices/search_invoice_payment.md
  - api/invoices/search_invoices.md
  - api/invoices/update_invoice.md
  - api/invoices/update_invoice_line.md
  - api/invoices/update_invoice_payment.md
  - api/offlinePayments/create_offline_payments.md
  - api/offlinePayments/delete_offline_payments.md
  - api/offlinePayments/list_all_offline_payments.md
  - api/offlinePayments/update_offline_payments.md
  - api/payments/batch_summary.md
  - api/payments/create_batch.md
  - api/payments/create_payment.md
  - api/payments/delete_batch.md
  - api/payments/delete_multiple_batch.md
  - api/payments/delete_payment.md
  - api/payments/generate_quote.md
  - api/payments/list_all.md
  - api/payments/list_payments_in_batch.md
  - api/payments/process_batch.md
  - api/payments/retrieve_batch.md
  - api/payments/retrieve_payment.md
  - api/payments/update_payment.md
  - api/recipient/delete_multiple_recipient.md
  - api/recipient/delete_recipient.md
  - api/recipient/list_all_recipients.md
  - api/recipient/retrieve_log.md
  - api/recipient/retrieve_offline_payments.md
  - api/recipient/retrieve_payments.md
  - api/recipient/update_recipient.md
  - api/references/2-list_of_regions.md
  - api/trust/expire-verifications.md
  - api/trust/trigger-verifications.md
  - api/trust/verification-api.md
  - partner/bank-account-list.md
  - partner/create.md
  - partner/onboarding.md
  - partner/sandbox.md
  - partner/webhook-update.md
  - partner/webhooks-create.md
  - partner/webhooks-list.md
  - partner/widget.md
x-doc-error-codes:
- empty_field
- expired_quote
- internal_server_error
- invalid_api_key
- invalid_field
- invalid_status
- non_sufficient_funds
- not_authorized
- not_found
- partner_integration_error
- rate_limit_exceeded
