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

# Get Cross-Border Collection

> Returns the current status and locked FX details for a cross-border collection.

Returns the status and locked FX details for a cross-border collection.

Use this endpoint to poll collection state when a customer is still approving the local payment request.


## OpenAPI

````yaml GET /cross-border/collections/{reference}
openapi: 3.0.0
info:
  title: NexaPay Business API
  version: 1.0.0
  description: Server-to-server merchant integration API documentation.
servers:
  - url: https://api.nexapay.ng/api/v1/business
    description: Production Server
security: []
tags: []
paths:
  /cross-border/collections/{reference}:
    get:
      tags:
        - Cross-Border Collections
      summary: Get cross-border collection status
      description: >-
        Returns the current status and locked FX details for a cross-border
        collection.
      parameters:
        - name: reference
          in: path
          required: true
          schema:
            type: string
          description: NexaPay collection reference.
        - $ref: '#/components/parameters/BusinessIdQuery'
        - $ref: '#/components/parameters/BusinessEnvHeader'
      responses:
        '200':
          description: Collection details retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  collection:
                    type: object
                    properties:
                      transactionId:
                        type: string
                        example: NexaPay20260903140945570d4ed2170c3
                      reference:
                        type: string
                        example: NexaPay20260903140945570d4ed2170c3
                      merchantReference:
                        type: string
                        nullable: true
                        example: ORDER-TEST-001
                      status:
                        type: string
                        enum:
                          - PROCESSING
                          - COMPLETED
                          - FAILED
                          - PENDING_REVIEW
                        example: PROCESSING
                      sourceAmount:
                        type: number
                        example: 20000
                      sourceCurrency:
                        type: string
                        example: UGX
                      targetAmount:
                        type: number
                        example: 7200
                      targetCurrency:
                        type: string
                        example: NGN
                      rate:
                        type: number
                        example: 0.36
                      providerRate:
                        type: number
                        example: 0.4
                      provider:
                        type: string
                        example: brails
                      country:
                        type: string
                        example: UG
                      paymentMethod:
                        type: string
                        example: MTN
                      createdAt:
                        type: string
                        format: date-time
                      completedAt:
                        type: string
                        format: date-time
                        nullable: true
                      failedAt:
                        type: string
                        format: date-time
                        nullable: true
                      failureReason:
                        type: string
                        nullable: true
        '404':
          description: Collection not found.
      security:
        - ApiKeyAuth: []
components:
  parameters:
    BusinessIdQuery:
      name: businessId
      in: query
      required: true
      schema:
        type: string
      description: >-
        The unique ID of the business profile (required for API key
        authentication).
    BusinessEnvHeader:
      name: x-business-env
      in: header
      required: false
      schema:
        type: string
        enum:
          - prod
          - test
        default: prod
      description: Target environment selector (live production vs. simulated sandbox).
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Merchant API Key (e.g., nexa-prod-... or nexa-test-...)

````