# Get Collections Transaction by ID

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/receive/{id}:
    get:
      summary: Get Collections Transaction by ID
      deprecated: false
      description: Retrieve a single collections transaction by its ID.
      tags:
        - API Documentation/Transactions/Collections (Fiat-to-Fiat)
      parameters:
        - name: id
          in: path
          description: The ID of the collections transaction to retrieve
          required: true
          example: '1'
          schema:
            type: string
        - name: x-api-key
          in: header
          description: ''
          required: true
          example: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed
          schema:
            type: string
        - name: x-api-secret
          in: header
          description: ''
          required: true
          example: >-
            CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collections%20Transaction'
          headers: {}
          x-apidog-name: OK
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API%20Error'
              examples:
                '2':
                  summary: IP Not Whitelisted
                  value:
                    exception:
                      errorCode: API_IP_NOT_WHITELISTED
                      message: Access Denied - IP not whitelisted
                '3':
                  summary: Resource Not Found
                  value:
                    exception:
                      errorCode: RESOURCE_NOT_FOUND
                      message: Business with id [1] not found
          headers: {}
          x-apidog-name: Error
      security: []
      x-apidog-folder: API Documentation/Transactions/Collections (Fiat-to-Fiat)
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/669455/apis/api-14995531-run
components:
  schemas:
    Collections Transaction:
      type: object
      properties:
        businessRequestId:
          type: integer
          description: The collections 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 requesting merchant that initiated the transaction for
            collection of funds
        toBusinessExternalAccountId:
          type: integer
          description: >-
            The ID of the requesting merchant's payout account for payout of the
            funds
        toBusinessId:
          type: integer
          description: The ID of the paying merchant, this merchant deposits the funds
        clientStatus:
          type: string
          description: The current status of the transaction
          enum:
            - NONE
            - Receive_PENDING
            - Receive_AWAITING_QUOTE_APPROVAL
            - Receive_AWAITING_DEPOSIT
            - Receive_IN_PROGRESS
            - Receive_COMPLETED
            - Receive_CANCELED
            - Receive_EXPIRED
          x-apidog-enum:
            - value: NONE
              name: None
              description: New transaction
            - value: Receive_PENDING
              name: Pending
              description: 'Transaction is pending and awaiting processing  '
            - value: Receive_AWAITING_QUOTE_APPROVAL
              name: Awaiting Quote Approval
              description: 'Waiting for approval of the quote  '
            - value: Receive_AWAITING_DEPOSIT
              name: Awaiting Deposit
              description: 'Quote approved and awaiting deposit  '
            - value: Receive_IN_PROGRESS
              name: In Progress
              description: 'Transaction is currently being processed  '
            - value: Receive_COMPLETED
              name: Completed
              description: 'Transaction has been successfully completed  '
            - value: Receive_CANCELED
              name: Canceled
              description: 'Transaction has been canceled  '
            - value: Receive_EXPIRED
              name: Expired
              description: 'Transaction has expired and is no longer active  '
        payoutStatus:
          type: string
          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.
          description: The current status of the payout to the bank account
          nullable: true
        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
        bankDetails:
          description: The deposit details
          anyOf:
            - $ref: '#/components/schemas/Bank%20Details'
            - type: 'null'
      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
        - bankDetails
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Bank Details:
      type: object
      properties:
        accountNumber:
          type: string
          description: The deposit bank account number
        nameOnAccount:
          type: string
          description: The name of the deposit bank account
        bankName:
          type: string
          description: The deposit bank name
        bankAddress:
          type: string
          description: The deposit bank full address
        reference:
          type: string
          description: The deposit reference number
      x-apidog-orders:
        - accountNumber
        - nameOnAccount
        - bankName
        - bankAddress
        - reference
      required:
        - accountNumber
        - nameOnAccount
        - bankName
        - bankAddress
        - reference
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    API Error:
      type: object
      properties:
        exception:
          type: object
          properties:
            errorCode:
              type: string
              enum:
                - INTERNAL_SERVER_ERROR
                - RATE_LIMIT_EXCEEDED
                - URL_INVALID
                - MOCK
                - API_KEY_MISSING
                - API_KEY_INVALID
                - API_KEY_NO_ACCESS
                - API_SECRET_MISSING
                - API_SECRET_INVALID
                - API_IP_NOT_WHITELISTED
                - RESOURCE_NOT_FOUND
                - REQUIRED_FIELD_MISSING
                - BAD_REQUEST
                - BUSINESS_KYC_NOT_VALID
                - BUSINESS_NOT_ACTIVE
                - BUSINESS_CANNOT_UPDATE_VALID
                - BUSINESS_REQUEST_CANCEL_FAILED
                - BUSINESS_REQUEST_ACTION_UNAVAILABLE
                - BUSINESS_REQUEST_ACTION_FAILED
                - BUSINESS_REQUEST_INVALID_TO_AMOUNT
                - CREDENTIALS_NOT_FOUND
                - CURRENCY_NOT_FOUND
                - INVALID_CURRENCY
                - BUSINESS_EXTERNAL_ACCOUNT_CANNOT_UPDATE_NON_PENDING_ACCOUNT
                - BUSINESS_INVOICE_FAILED_TO_DOWNLOAD_INVOICE
              x-apidog-enum:
                - value: INTERNAL_SERVER_ERROR
                  name: Internal Server Error
                  description: 'Internal server error  '
                - value: RATE_LIMIT_EXCEEDED
                  name: Rate Limit Exceeded
                  description: 'Rate limit exceeded  '
                - value: URL_INVALID
                  name: URL Invalid
                  description: 'Invalid URL  '
                - value: MOCK
                  name: Sandbox Error
                  description: 'Error in sandbox service  '
                - value: API_KEY_MISSING
                  name: API Key Missing
                  description: 'API key missing  '
                - value: API_KEY_INVALID
                  name: API Key Invalid
                  description: 'API key invalid  '
                - value: API_KEY_NO_ACCESS
                  name: API Key No Access
                  description: 'Access Denied  '
                - value: API_SECRET_MISSING
                  name: API Secret Missing
                  description: 'API secret missing  '
                - value: API_SECRET_INVALID
                  name: API Secret Invalid
                  description: 'API secret invalid  '
                - value: API_IP_NOT_WHITELISTED
                  name: API IP Not Whitelisted
                  description: 'Access Denied - IP not whitelisted  '
                - value: RESOURCE_NOT_FOUND
                  name: Resource Not Found
                  description: 'Resource not found  '
                - value: REQUIRED_FIELD_MISSING
                  name: Required Field Missing
                  description: 'Required field missing  '
                - value: BAD_REQUEST
                  name: Bad Request
                  description: 'Request body is invalid  '
                - value: BUSINESS_KYC_NOT_VALID
                  name: Merchant KYC Not Valid
                  description: 'Merchant KYC not valid  '
                - value: BUSINESS_NOT_ACTIVE
                  name: Merchant Not Active
                  description: 'Merchant not active  '
                - value: BUSINESS_CANNOT_UPDATE_VALID
                  name: Merchant Cannot Update Valid
                  description: 'Cannot update merchant after KYC status is valid  '
                - value: BUSINESS_REQUEST_CANCEL_FAILED
                  name: Transaction Cancel Failed
                  description: 'Failed to cancel request  '
                - value: BUSINESS_REQUEST_ACTION_UNAVAILABLE
                  name: Transaction Action Unavailable
                  description: 'Action unavailable  '
                - value: BUSINESS_REQUEST_ACTION_FAILED
                  name: Transaction Action Failed
                  description: 'Failed to perform action  '
                - value: BUSINESS_REQUEST_INVALID_TO_AMOUNT
                  name: Transaction Invalid To Amount
                  description: 'Invalid to amount  '
                - value: CREDENTIALS_NOT_FOUND
                  name: Credentials Not Found
                  description: 'Failed to find credentials  '
                - value: CURRENCY_NOT_FOUND
                  name: Currency Not Found
                  description: 'Currency not found  '
                - value: INVALID_CURRENCY
                  name: Invalid Currency
                  description: 'Invalid currency  '
                - value: BUSINESS_EXTERNAL_ACCOUNT_CANNOT_UPDATE_NON_PENDING_ACCOUNT
                  name: Receiver Account Cannot Update Non Pending Account
                  description: 'Cannot update non-pending account  '
                - value: BUSINESS_INVOICE_FAILED_TO_DOWNLOAD_INVOICE
                  name: Invoice Failed To Download Invoice
                  description: 'Failed to download invoice from URL  '
              description: The API error code
            message:
              type: string
              description: Exception message with additional details
          required:
            - errorCode
            - message
          x-apidog-orders:
            - errorCode
            - message
          description: Exception details
          x-apidog-ignore-properties: []
      required:
        - exception
      x-apidog-orders:
        - exception
      x-apidog-ignore-properties: []
      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: []

```
