Payments API ReferenceOrders

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

merchantIdstringRequired
Merchant ID
organizationIdstringRequired
Organization ID
externalIdstringRequired

External ID (merchant-provided identifier)

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Order retrieved successfully
idstring
Unique order ID
typeenum
Type of order
destinationAccountIdstring

Destination account ID (bank or wallet)

originCurrencySymbolstring
Origin currency symbol
destinationCurrencySymbolstring
Destination currency symbol
amountIndouble
Amount in origin currency
amountOutdouble
Amount in destination currency
dueDatestring
Due date for payment links
descriptionstring
Description of the order
externalIdstring

External ID (idempotent identifier)

paymentMethodslist of objects
Payment methods used
quoteIdstring
Quote ID used for currency conversion
contactIdstring
Contact ID identifying the counterparty to whom this order is directed. This represents the entity on the other side of the transaction.
enforcedDocumentstring

National ID document (e.g. DNI, RUT, Cédula) that must be provided to complete the order

sendEmailboolean
Whether email notifications are enabled
sendNotificationboolean

Whether in-app notifications are enabled

sendWhatsappboolean
Whether WhatsApp notifications are enabled
sendRemindersboolean
Whether order reminders are enabled
providedActionstring
Action URL or data provided to the user to complete the order, such as a QR code, payment link, or other actionable payment method
providedActionTypeenum
Type of provided action
Allowed values:
createdAtstring
Timestamp when the order was created
statusenum
Current status of the order

Errors