5. Create an Order

---

An order is a formal request to execute a financial transaction based on a previously generated quote. Once the quotation is accepted, it is used to create an actual order with all the details of the sender and the beneficiary.

Body Request to Create an Order

To create an order, you must provide the following body request with detailed information about the sender and the beneficiary:

{
  "pogQuotationId": 90,
  "externalId": "fdsf",
  "senderNames": "Alice",
  "senderLastNames": "Brown",
  "senderEmail": "alicebrown@example.com",
  "senderPhone": "+13456789012",
  "senderDocumentId": "123456789",
  "senderDocumentType": "cc",
  "senderCountry": "CO",
  "sourceCountry": "CO",
  "beneficiaryNames": "test",
  "beneficiaryLastNames": "test",
  "beneficiaryEmail": "test@example.com",
  "beneficiaryPhone": "+13000000000",
  "beneficiaryDocumentId": "12345678",
  "beneficiaryDocumentType": "cc",
  "paymentInstructions": {
    "bankName": "BANCOLOMBIA_CO",
    "accountNumber": "123",
    "phoneNumber": "3005556666"
  },
  "paymentPurpose": "PAYMENT_OF_BILLS"
}

Field Descriptions

• pogQuotationId: The ID of the quote used for this order.
• externalId: An optional identifier that allows the client to track the order from their own system.
• senderNames and senderLastNames: Sender’s first and last names.
• senderEmail: Sender’s email address.
• senderPhone: Sender’s phone number.
• senderDocumentId and senderDocumentType: Sender’s identification document and its type.
• senderCountry: Sender’s country of origin.
• sourceCountry: The country of origin of the funds.
• beneficiaryNames and beneficiaryLastNames: Beneficiary’s first and last names.
• beneficiaryEmail: Beneficiary’s email address.
• beneficiaryPhone: Beneficiary’s phone number.
• beneficiaryDocumentId and beneficiaryDocumentType: Beneficiary’s identification document and its type.
• paymentInstructions: Payment instructions including details such as bank name, account number, and phone number associated with the beneficiary. You can see which fields to send based on the payout method in PaymentInstructions or by country in Payout Methods by Country.
• paymentPurpose: Purpose of the remittance.

• FAMILY_SUPPORT
• PAYMENT_OF_BILLS
• PURCHASE_OF_GOODS
• PROFESSIONAL_SERVICES
• RENTAL_OF_SPACES
• INVESTMENTS
• COMMISSIONS_LOANS_CAPITAL_INCREASE
• TRANSPORTATION_COSTS
• FEES

Endpoint Response

The response from the order creation endpoint provides a JSON object with detailed information about the status and details of the created transaction. Below is an example of the full response:

{
  "appliedCeiling": 4000000,
  "appliedFloor": 4000,
  "beneficiaryDocumentId": "12345678",
  "beneficiaryDocumentType": "cc",
  "beneficiaryLastNames": "test",
  "beneficiaryNames": "test",
  "calculatedFlatFee": 0,
  "calculatedPercentageFee": 0,
  "createdTime": "2024-09-25T02:09:28.011Z",
  "currency": "VES",
  "externalId": "fdsf",
  "financialEntity": null,
  "id": 17065,
  "paymentInstructions": {
    "bankName": "BANCOLOMBIA_CO",
    "accountNumber": "123",
    "phoneNumber": "3005556666"
  },
  "payoutType": null,
  "providerAmount": 1000,
  "providerReferenceId": null,
  "providerExternalId": null,
  "status": "CREATED",
  "subStatus": null,
  "sumFee": 0,
  "taxFee": 0,
  "totalFee": 0,
  "updatedTime": "2024-09-25T02:09:28.011Z",
  "payoutOrderBackendId": "29064067-873b-425f-94ea-86bea91633c6",
  "payoutTypeBackendId": "893885fd-80b1-44a7-8b04-58bfe3d43c53",
  "entityBackendId": "bc8c7363-6e23-4747-a309-be539771d752",
  "beneficiaryFirstName": null,
  "beneficiaryMiddleName": null,
  "beneficiaryLastName": null,
  "beneficiarySecondLastName": null,
  "beneficiaryDocumentIdCountry": null,
  "beneficiaryNationality": null,
  "beneficiaryCountryOfBirth": null,
  "beneficiaryGender": null,
  "beneficiaryAddress": null,
  "beneficiaryZipCode": null,
  "beneficiaryCity": null,
  "beneficiaryLocality": null,
  "beneficiaryCountry": null,
  "beneficiaryEmail": null,
  "beneficiaryState": null,
  "beneficiaryOccupation": null,
  "paymentPurpose": "INVESTMENTS",
  "senderNames": "Alice",
  "senderLastNames": "Brown",
  "senderDocumentId": "123456789",
  "senderDocumentType": "cc",
  "senderPhone": "+13456789012",
  "senderAddress": null,
  "senderCountry": "CO",
  "senderState": null,
  "senderCity": null,
  "senderEmail": "alicebrown@example.com",
  "senderBirthDate": null,
  "sfid": null,
  "isEmpty": false,
  "internalReferenceId": null,
  "sourceCountry": null,
  "b2bClientBackendId": "4b577b92-57e2-42f9-b2b4-820cb66fde20",
  "quotationBackendId": "b0d9cdcb-5b43-4e0d-84c2-aeb27e62b319",
  "quotation": {
    "id": "90",
    "quotationBackendId": "b0d9cdcb-5b43-4e0d-84c2-aeb27e62b319",
    "rateId": 66,
    "b2bClientId": 70,
    "sourceAmount": 1000,
    "targetAmount": 38148.216,
    "convertAmount": 1000,
    "value": 39.2,
    "createdTime": "2024-09-25T01:59:28.326Z",
    "updatedTime": "2024-09-25T01:59:28.326Z"
  }
}

Key Field Descriptions in the Response

• status: Current status of the order, more info.
• subStatus: Current sub-status of the order, more info.
• id: Unique identifier of the created order.
• beneficiary and paymentInstructions: Details of the beneficiary and the specific payment instructions.s
• quotation: Details of the quote associated with the order, including amounts, exchange rates, and applied pricing rules.

Check Order Status by ID

You can check the status and details of an existing order using the endpoint Get Order by ID. This process allows you to track and obtain updated information about the transaction as it progresses through different states.