Orders Controller Create Order

1 curl -X POST https://api.koywe.com/rest/api/v1/orders \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "type": "CHARGE", 6 "dueDate": "2024-05-27T16:52:46Z", 7 "customerId": "cus_a627a569-51c4-4fc4-ace6-a43482f1b08b", 8 "orderCurrency": "ARS", 9 "fixedOrderCurrency": "ARS", 10 "collectionCurrency": "ARS", 11 "payoutCurrency": "ARS", 12 "originBankAccountId": "baa_7300e2e1-81bc-40f4-8ea8-fcb940e2e9ac", 13 "destinationBankAccountId": "baa_7300e2e1-81bc-40f4-8ea8-fcb940e2e9ac", 14 "products": [ 15 { 16 "productId": "prd_54045a00-de09-4539-aa6a-e33e8dfd51cd", 17 "priceId": "prc_450f985d-a2d3-4f25-aa61-1b4bc0f4c025", 18 "quantity": 0 19 } 20 ], 21 "amount": 100 22 }'

1 { 2 "id": "ord_aoy4EO3kG5mGLbwp76Qz", 3 "failureMessage": "DOCUMENT_ACCOUNT_MISMATCH", 4 "rawError": "INVALID CUSTOMER", 5 "orderType": "CHARGE", 6 "status": "DRAFT", 7 "dueDate": "2024-01-15T09:30:00Z", 8 "description": "", 9 "reference": "291a1321-6fbf-4e9a-be84-329fc06c4a26", 10 "merchant": { 11 "merchantId": "mrc_31fd8637-f889-43fa-8b31-50d9296abfdc", 12 "name": "Galactic Republic Trading" 13 }, 14 "customer": { 15 "customerId": "cus_a627a569-51c4-4fc4-ace6-a43482f1b08b", 16 "firstName": "Tatooine", 17 "lastName": "Tatooine", 18 "email": "info@tatooine.gov", 19 "phone": "01134986754", 20 "documentType": "DNI", 21 "documentNumber": "TAT-001", 22 "countryId": "ctry_84b8b218-2777-4e7f-863e-7d0601ac289f" 23 }, 24 "currency": { 25 "currency": "ARS", 26 "currencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64" 27 }, 28 "fixedOrderCurrency": { 29 "currency": "ARS", 30 "currencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64" 31 }, 32 "collectionCurrency": { 33 "currency": "ARS", 34 "currencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64" 35 }, 36 "payoutCurrency": { 37 "currency": "ARS", 38 "currencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64" 39 }, 40 "destinationBankAccountId": "destinationBankAccountId", 41 "originBankAccountId": "originBankAccountId", 42 "details": [ 43 { 44 "id": "ord_7a0af4e4-47a3-4a6b-a4f4-f1f08a887970", 45 "Product": { 46 "description": "Emergency Medical Kits", 47 "productId": "prd_d315f46f-d064-48f1-864a-59d9a9009e5e", 48 "unit": "UNIDAD" 49 }, 50 "Price": { 51 "priceId": "prc_33456bc6-84f1-4a93-9eac-1cf32c1686cf", 52 "currency": "CLP", 53 "value": 5000 54 }, 55 "PaymentLink": { 56 "paymentLinkId": "plk_aff49281-ae33-4e4a-8fb4-4747d64f3907" 57 }, 58 "quantity": 1, 59 "total": 5000 60 } 61 ], 62 "isCompleted": true, 63 "isRefunded": true, 64 "createdAt": "2024-01-15T09:30:00Z", 65 "updatedAt": "2024-01-15T09:30:00Z", 66 "closedAt": "2024-01-15T09:30:00Z", 67 "paymentLinks": [ 68 { 69 "paymentLinkId": "paymentLinkId", 70 "paymentLinkStatus": "paymentLinkStatus" 71 } 72 ], 73 "amount": 1.1, 74 "amountDue": 1.1, 75 "amountPaid": 1.1, 76 "amountRefunded": 1.1, 77 "amountUsd": 1.1, 78 "amountDueUsd": 1.1, 79 "amountPaidUsd": 1.1, 80 "amountRefundedUsd": 1.1 81 }

Request

This endpoint expects an object.

typeenumRequired

Allowed values:

dueDatedatetimeRequired

customerIdstringRequired

orderCurrencyenumRequired

fixedOrderCurrencyenumRequired

collectionCurrencyenumRequired

payoutCurrencyenumRequired

originBankAccountIdstringRequired

destinationBankAccountIdstringRequired

productslist of objectsRequired

amountdoubleRequired

descriptionstringOptional

referencestringOptional

Response

idstring

ID of the order

failureMessagestring

rawErrorstring

orderTypestring

Type of the order

statusenum

dueDatedatetime

Due date of the order

descriptionstring

referencestring

merchantobject

customerobject

currencyobject

fixedOrderCurrencyobject

collectionCurrencyobject

payoutCurrencyobject

destinationBankAccountIdstring

originBankAccountIdstring

detailslist of objects

isCompletedboolean

isRefundedboolean

createdAtdatetime

updatedAtdatetime

closedAtdatetime

paymentLinkslist of objects

amountdouble

amountDuedouble

amountPaiddouble

amountRefundeddouble

amountUsddouble

amountDueUsddouble

amountPaidUsddouble

amountRefundedUsddouble

Headers

Request

Response

Errors