Skip to main content
GET
Get cross-border collection status
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.

Authorizations

x-api-key
string
header
required

Merchant API Key (e.g., nexa-prod-... or nexa-test-...)

Headers

x-business-env
enum<string>
default:prod

Target environment selector (live production vs. simulated sandbox).

Available options:
prod,
test

Path Parameters

reference
string
required

NexaPay collection reference.

Query Parameters

businessId
string
required

The unique ID of the business profile (required for API key authentication).

Response

Collection details retrieved successfully.

success
boolean
Example:

true

collection
object