Get an order by external ID
Retrieves a specific order by its external ID (merchant-provided identifier). The order must belong to the merchant and the merchant must belong to the organization.
Path parameters
merchantId
Merchant ID
organizationId
Organization ID
externalId
External ID (merchant-provided identifier)
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
Order retrieved successfully
id
Unique order ID
type
Type of order
destinationAccountId
Destination account ID (bank or wallet)
originCurrencySymbol
Origin currency symbol
destinationCurrencySymbol
Destination currency symbol
amountIn
Amount in origin currency
amountOut
Amount in destination currency
dueDate
Due date for payment links
description
Description of the order
externalId
External ID (idempotent identifier)
paymentMethods
Payment methods used
quoteId
Quote ID used for currency conversion
contactId
Contact ID identifying the counterparty to whom this order is directed. This represents the entity on the other side of the transaction.
enforcedDocument
National ID document (e.g. DNI, RUT, Cédula) that must be provided to complete the order
sendEmail
Whether email notifications are enabled
sendNotification
Whether in-app notifications are enabled
sendWhatsapp
Whether WhatsApp notifications are enabled
sendReminders
Whether order reminders are enabled
providedAction
Action URL or data provided to the user to complete the order, such as a QR code, payment link, or other actionable payment method
providedActionType
Type of provided action
Allowed values:
createdAt
Timestamp when the order was created
status
Current status of the order