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)

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

1	import requests
2
3	url = "https://api.koywe.com/api/v1/organizations/organizationId/merchants/merchantId/orders/external/externalId"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "ord_123456789",
3	"type": "PAYIN",
4	"destinationAccountId": "bank-account-123",
5	"originCurrencySymbol": "COP",
6	"destinationCurrencySymbol": "COP",
7	"amountIn": 1000000,
8	"amountOut": 900000,
9	"dueDate": "2026-01-28T12:36:55.523694Z",
10	"description": "Payment for invoice #1234",
11	"externalId": "payin-ext-001",
12	"paymentMethods": [
13	{
14	"method": "PSE",
15	"extra": {
16	"bankAccount": {
17	"name": "BANCOLOMBIA"
18	},
19	"phone": {
20	"countryCode": "+57",
21	"number": "3178901234"
22	},
23	"email": "email"
24	}
25	}
26	],
27	"quoteId": "quote-123",
28	"contactId": "contact-123",
29	"enforcedDocument": "45676946",
30	"sendEmail": true,
31	"sendNotification": true,
32	"sendWhatsapp": true,
33	"sendReminders": true,
34	"providedAction": "https://checkout.row.com/order/123456789",
35	"providedActionType": "QR",
36	"createdAt": "2025-06-13T22:54:54.363Z",
37	"status": "DRAFT"
38	}

Get an order by external ID

Path parameters

Headers

Response

Errors