> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a remittance

> **Beta** — contact Cadana to enable access for your business.

Returns full remittance details including payment status, FX conversion
information, and proof of payment (when available).




## OpenAPI

````yaml /openapi/statutory-compliance.yaml get /v1/statutory/remittances/{remittance_id}
openapi: 3.0.0
info:
  title: Statutory Compliance API
  version: 0.1.0
  description: Statutory filing, government remittance, and compliance tracking API
  termsOfService: https://cadanapay.com/terms-and-conditions
  contact:
    email: api@cadanapay.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.cadanapay.com
    description: Prod Server
  - url: https://dev-api.cadanapay.com
    description: Dev Server
security:
  - Authorization: []
tags:
  - name: Jurisdictions
    description: Discover supported countries, required fields, and filing types
  - name: Filings
    description: >-
      Create, submit, and track statutory returns — from upcoming obligations
      through acceptance
  - name: Remittances
    description: Government payments linked to filings
  - name: Requirements
    description: Prerequisites that must be satisfied before filing
  - name: Events
    description: Immutable audit trail
  - name: Statutory Fields
    description: Submit and read entity-level statutory filing data
paths:
  /v1/statutory/remittances/{remittance_id}:
    get:
      tags:
        - Remittances
      summary: Get a remittance
      description: |
        **Beta** — contact Cadana to enable access for your business.

        Returns full remittance details including payment status, FX conversion
        information, and proof of payment (when available).
      operationId: getRemittance
      parameters:
        - $ref: '#/components/parameters/XMultiTenantKey'
        - $ref: '#/components/parameters/RemittanceId'
      responses:
        '200':
          description: Remittance details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Remittance'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    XMultiTenantKey:
      name: X-MultiTenantKey
      in: header
      required: false
      schema:
        type: string
      description: >-
        Required when using a Platform API token. The tenant key identifying
        which business to operate on.
    RemittanceId:
      name: remittance_id
      in: path
      required: true
      schema:
        type: string
      description: Remittance identifier
      example: rem_01HQ3K4N7XYZABC
  schemas:
    Remittance:
      type: object
      description: |
        Full remittance detail returned by `GET /v1/statutory/remittances/{id}`.
        Includes FX conversion details, payment tracking, and status history.
      properties:
        id:
          type: string
          example: rem_01HQ3K4N7XYZABC
        businessId:
          type: string
        filingIds:
          type: array
          items:
            type: string
          description: Filings this remittance covers
        countryCode:
          type: string
          example: MX
        authorityId:
          type: string
          description: Government authority identifier
          example: auth_mx_sat
        authorityName:
          type: string
          description: Government authority name
          example: SAT
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
          description: |
            ```
            pending ──→ processing ──→ completed
                            │
                            ▼
                          failed
            ```
        amount:
          type: number
          format: decimal
          description: Amount in local currency to be paid to the authority
          example: 45000
        fxRate:
          type: number
          format: decimal
          description: FX rate applied (if funded in a different currency)
          example: 18.001
        fundedCurrency:
          type: string
          description: Currency the business funded from
          example: USD
        fundedAmount:
          type: number
          format: decimal
          description: Amount debited from the business balance
          example: 2571.43
        paymentMethod:
          type: string
          description: How payment was made to the authority
          example: local_rails
        paymentDetails:
          allOf:
            - $ref: '#/components/schemas/paymentMethods'
          description: |
            The routing Cadana used to deliver the payment. Echoes back the
            `paymentDetails` from the create request, or — when omitted — the
            internal default routing Cadana used for the authority.
        paymentReference:
          type: string
          nullable: true
          description: Government-issued payment reference number
          example: SAT-2026-01-RFC-XAXX010101000-ISR
        receiptUrl:
          type: string
          nullable: true
          description: Proof of payment document URL
        statusHistory:
          type: array
          items:
            $ref: '#/components/schemas/StatusHistoryEntry'
        createdAt:
          type: number
          format: epoch
          description: Unix epoch timestamp
          example: 1709280000
        updatedAt:
          type: number
          format: epoch
          description: Unix epoch timestamp
          example: 1709280000
    paymentMethods:
      type: object
      required:
        - preferredMethod
      properties:
        preferredMethod:
          type: string
          enum:
            - momo
            - bank
          description: The preferred payment method type
          example: bank
        momo:
          $ref: '#/components/schemas/momoDetails'
        bank:
          $ref: '#/components/schemas/bankDetails'
    StatusHistoryEntry:
      type: object
      description: Records a single status transition on a filing or remittance.
      properties:
        from:
          type: string
          description: Previous status
          example: pending
        to:
          type: string
          description: New status
          example: in_review
        timestamp:
          type: number
          format: epoch
          description: Unix epoch timestamp of the transition
          example: 1709654400
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
              example: countryCode is required
            details:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
    momoDetails:
      type: object
      properties:
        accountName:
          type: string
          example: John Doe
        provider:
          type: string
          example: MTN
        providerCode:
          type: string
          example: MTN
        phoneNumber:
          $ref: '#/components/schemas/phoneNumber'
        currency:
          type: string
          example: GHS
    bankDetails:
      type: object
      properties:
        accountName:
          type: string
          example: SAT — ISR Federal Treasury
        accountNumber:
          type: string
          description: |
            Bank account number. For Mexico this is the 18-digit CLABE.
            For other countries, the local account number.
          example: '012345678901234567'
        accountType:
          type: string
          description: e.g., Checking, Savings
          example: Checking
        ownerType:
          type: string
          description: e.g., individual, business
          example: business
        bankCode:
          type: string
          description: The bank identification code
          example: '012'
        bankName:
          type: string
          example: BBVA México
        branchName:
          type: string
          example: Sucursal Reforma
        sortCode:
          type: string
          description: Bank sort code (used in some countries like UK)
          example: '401234'
        iban:
          type: string
          description: International Bank Account Number
          example: GB00000000000000000000
        provider:
          type: string
          example: wise
        currency:
          type: string
          example: MXN
        beneficiaryId:
          $ref: '#/components/schemas/beneficiaryId'
        address:
          $ref: '#/components/schemas/address'
        phoneNumber:
          $ref: '#/components/schemas/phoneNumber'
        email:
          type: string
          format: email
    phoneNumber:
      type: object
      required:
        - countryCode
        - number
      properties:
        countryCode:
          type: string
          example: '52'
        number:
          type: string
          example: '5512345678'
    beneficiaryId:
      type: object
      description: ID details for the beneficiary
      properties:
        type:
          type: string
          enum:
            - NIT
            - CC
            - CE
            - TI
            - PASS
          example: NIT
        value:
          type: string
          example: '123456789'
    address:
      type: object
      required:
        - line1
        - city
        - postalCode
        - state
        - countryCode
      properties:
        line1:
          type: string
          example: Av. Paseo de la Reforma 10
        line2:
          type: string
          example: Piso 30
        city:
          type: string
          example: Ciudad de México
        postalCode:
          type: string
          example: '06600'
        state:
          type: string
          example: CDMX
        countryCode:
          type: string
          description: ISO 3166-1 alpha-2 country code
          example: MX
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````