# Payout Transaction

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    Wallet Details:
      type: object
      properties:
        walletAddress:
          type: string
          description: The wallet's blockchain address
      x-apidog-orders:
        - walletAddress
      required:
        - walletAddress
      x-apidog-folder: ''
    Payout Transaction:
      type: object
      properties:
        businessRequestId:
          type: integer
          description: The payout transaction's ID
        creationTime:
          type: integer
          description: The entity creation time in UNIX timestamp
        lastUpdateTime:
          type: integer
          description: The entity last update time in UNIX timestamp
        toAmount:
          type: string
          description: Payout amount to receiver account
        fromAmount:
          type: string
          description: Deposit amount
          nullable: true
        purpose:
          type: string
          enum:
            - GOODS_PURCHASED
            - PAYMENT_OF_GOODS
            - PAYMENT_OF_SERVICES
            - OTHER_SERVICES
          x-apidog-enum:
            - value: GOODS_PURCHASED
              name: Goods Purchased
              description: 'Buying products or merchandise  '
            - value: PAYMENT_OF_GOODS
              name: Payment Of Goods
              description: 'Making a payment for goods received  '
            - value: PAYMENT_OF_SERVICES
              name: Payment Of Services
              description: 'Making a payment for services rendered  '
            - value: OTHER_SERVICES
              name: Other Services
              description: 'Payments for miscellaneous services  '
          description: Transaction's purpose
        quoteApprovedDate:
          type: number
          description: The time the quote was approved by the client in UNIX timestamp
          nullable: true
        depositApprovedDate:
          type: number
          description: The time the deposit was approved by the client in UNIX timestamp
          nullable: true
        depositReceivedDate:
          type: number
          description: The time the deposit was received in the system in UNIX timestamp
          nullable: true
        depositReceivedAmount:
          type: string
          description: Deposit amount received by the system
          nullable: true
        payout:
          type: string
          description: Payout amount sent
          nullable: true
        fromCurrencySymbol:
          type: string
          description: Deposit currency
        toCurrencySymbol:
          type: string
          description: Payout currency
        fromBusinessId:
          type: integer
          description: The ID of the sending merchant
        toBusinessExternalAccountId:
          type: integer
          description: >-
            The ID of the receiving merchant's payout account for payout of the
            funds
        toBusinessId:
          type: integer
          description: The ID of the receiving merchant
        clientStatus:
          type: string
          enum:
            - NONE
            - OnOff_PENDING
            - OnOff_AWAITING_QUOTE_APPROVAL
            - OnOff_AWAITING_DEPOSIT
            - OnOff_IN_PROGRESS
            - OnOff_COMPLETED
            - OnOff_CANCELED
            - OnOff_EXPIRED
          x-apidog-enum:
            - value: NONE
              name: None
              description: New transaction
            - value: OnOff_PENDING
              name: Pending
              description: 'Transaction is pending and awaiting processing  '
            - value: OnOff_AWAITING_QUOTE_APPROVAL
              name: Awaiting Quote Approval
              description: 'Waiting for approval of the quote  '
            - value: OnOff_AWAITING_DEPOSIT
              name: Awaiting Deposit
              description: 'Quote generated and awaiting deposit  '
            - value: OnOff_IN_PROGRESS
              name: In Progress
              description: 'Transaction is currently being processed  '
            - value: OnOff_COMPLETED
              name: Completed
              description: 'Transaction has been successfully completed  '
            - value: OnOff_CANCELED
              name: Canceled
              description: 'Transaction has been canceled  '
            - value: OnOff_EXPIRED
              name: Expired
              description: 'Transaction has expired and is no longer active  '
          description: The current status of the transaction
        walletDetails:
          anyOf:
            - $ref: '#/components/schemas/Wallet%20Details'
            - type: 'null'
          description: The deposit details
        cancelReason:
          type: string
          enum:
            - WRONG_PAYMENT_AMOUNT
            - WRONG_RECIPIENT
            - RATE_TOO_HIGH
            - INCORRECT_INVOICE_DETAILS
            - INCORRECT_INVOICE_UNIT_PRICE
            - INCORRECT_INVOICE_QUANTITY
            - INCORRECT_INVOICE_DUPLICATE_CHARGES
            - INCORRECT_INVOICE_DISCOUNTS
            - INCORRECT_INVOICE_CURRENCY_MISMATCH
            - INCORRECT_INVOICE_ROUNDING_ERRORS
            - INCORRECT_INVOICE_PAYMENT_TERMS_NOT_APPLIED
            - INCORRECT_INVOICE_DATE
            - INCORRECT_INVOICE_DATE_FORMAT
            - INCORRECT_INVOICE_MISSING_INVOICE_NUMBER
            - INCORRECT_INVOICE_SUPPLIER_NAME_MISMATCH
            - INCORRECT_INVOICE_BENEFICIARY
            - INCORRECT_INVOICE_SWIFT_BIC_CODE
            - INCORRECT_INVOICE_IBAN_ACCOUNT_NUMBER
            - INCORRECT_INVOICE_CONTAINER_BOL
            - INCORRECT_INVOICE_FORMATTING_ERROR
            - OTHER
          x-apidog-enum:
            - value: WRONG_PAYMENT_AMOUNT
              name: Wrong Transaction Amount
              description: The total amount requested for payment is incorrect.
            - value: WRONG_RECIPIENT
              name: Wrong Recipient / Target
              description: The funds were directed to the wrong person or entity.
            - value: RATE_TOO_HIGH
              name: Rate Too High
              description: >-
                The exchange rate or service rate applied is too high for the
                client.
            - value: INCORRECT_INVOICE_DETAILS
              name: Invoice - Incorrect Details
              description: General error where invoice details do not match expectations.
            - value: INCORRECT_INVOICE_UNIT_PRICE
              name: Invoice - Incorrect unit price
              description: Price per item/service does not match
            - value: INCORRECT_INVOICE_QUANTITY
              name: Invoice - Incorrect quantity
              description: Billed quantity differs from delivered/approved quantity
            - value: INCORRECT_INVOICE_DUPLICATE_CHARGES
              name: Invoice - Duplicate charges
              description: Same item or service billed more than once
            - value: INCORRECT_INVOICE_DISCOUNTS
              name: Invoice - Missing or incorrect discounts
              description: Contract or promotional discounts not applied
            - value: INCORRECT_INVOICE_CURRENCY_MISMATCH
              name: Invoice - Currency mismatch
              description: >-
                Invoiced in the wrong currency or incorrect exchange rate
                applied
            - value: INCORRECT_INVOICE_ROUNDING_ERRORS
              name: Invoice - Rounding errors
              description: Rounding leads to an incorrect total
            - value: INCORRECT_INVOICE_PAYMENT_TERMS_NOT_APPLIED
              name: Invoice - Payment terms not applied
              description: Prior payment or advance note not applied
            - value: INCORRECT_INVOICE_DATE
              name: Invoice - Wrong date
              description: Invoice is older than 180 days
            - value: INCORRECT_INVOICE_DATE_FORMAT
              name: Invoice - Wrong date format
              description: Date formatting error
            - value: INCORRECT_INVOICE_MISSING_INVOICE_NUMBER
              name: Invoice - Missing invoice number
              description: Mandatory field missing
            - value: INCORRECT_INVOICE_SUPPLIER_NAME_MISMATCH
              name: Invoice - Supplier name mismatch
              description: Beneficiary data issue
            - value: INCORRECT_INVOICE_BENEFICIARY
              name: Invoice - Incorrect beneficiary
              description: Invoice does not match contact or receiver account
            - value: INCORRECT_INVOICE_SWIFT_BIC_CODE
              name: Invoice - Incorrect SWIFT/BIC code
              description: Banking details error
            - value: INCORRECT_INVOICE_IBAN_ACCOUNT_NUMBER
              name: Invoice - Incorrect IBAN / account number
              description: Payment details error
            - value: INCORRECT_INVOICE_CONTAINER_BOL
              name: Invoice - Incorrect container / BOL
              description: >-
                Container or Bill of Lading number does not match shipping
                records
            - value: INCORRECT_INVOICE_FORMATTING_ERROR
              name: Invoice - Formatting error
              description: Invoice layout does not meet formatting standards
            - value: OTHER
              name: Other
              description: Any other reason not listed above.
          description: The reason the transaction was cancelled
          nullable: true
        payoutStatus:
          type: string
          description: The current status of the payout to the bank account
          enum:
            - NONE
            - PROCESSING_TRACKABLE
            - PROCESSING_UNTRACKABLE
            - ARRIVED
          x-apidog-enum:
            - value: NONE
              name: N/A
              description: No payout status available or applicable.
            - value: PROCESSING_TRACKABLE
              name: En route - Trackable
              description: The payout is in transit and can be tracked by the recipient.
            - value: PROCESSING_UNTRACKABLE
              name: En route - Untrackable
              description: >-
                The payout is in transit but tracking information is
                unavailable.
            - value: ARRIVED
              name: Arrived
              description: The payout has successfully reached the destination.
          nullable: true
      required:
        - businessRequestId
        - creationTime
        - lastUpdateTime
        - toAmount
        - purpose
        - fromCurrencySymbol
        - toCurrencySymbol
        - fromBusinessId
        - toBusinessExternalAccountId
        - toBusinessId
        - clientStatus
      x-apidog-orders:
        - businessRequestId
        - creationTime
        - lastUpdateTime
        - toAmount
        - fromAmount
        - purpose
        - quoteApprovedDate
        - depositApprovedDate
        - depositReceivedDate
        - depositReceivedAmount
        - payout
        - fromCurrencySymbol
        - toCurrencySymbol
        - fromBusinessId
        - toBusinessExternalAccountId
        - toBusinessId
        - clientStatus
        - payoutStatus
        - cancelReason
        - walletDetails
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://partners-api.service.cedar.money/mock/bpapi
    description: Sandbox Partners API
  - url: https://partners-api.service.cedar.money/bpapi
    description: Live Partners API
security: []

```
