Order Object

An Order represents a tokenization or redemption operation for stablecoins.

ENDPOINTS

POST/v1/ordersGET/v1/ordersGET/v1/orders/{id}

THE ORDER OBJECT

{
  "id": "84203386-d88a-92cb-b5fe-61c328euffhueif49",
  "status": "PENDING",
  "amount": "50000",
  "type": "TOKENIZE",
  "created_at": "2023-11-04T01:35:34.165Z",
  "updated_at": "2023-11-04T01:35:34.165Z",
  "origin_source_id": "84203386-d88a-92cb-b5fe-61c328euffhueif49",
  "destination_source_id": "84203386-d88a-92cb-b5fe-61c328euffhueif49",
  "activities": [
    {
      "type": "SETTLE_ORDER",
      "status": "PENDING",
      "last_update_at": "2023-11-04T01:35:34.162Z"
    }
  ],
  "status_code": null,
  "chain": "POLYGON",
  "public_data": {
    "financial_items": {
      "transfer_amount": "50000.00"
    },
    "deposit_originated_at": "2023-11-13T00:00:00.000Z"
  },
  "external_identifier": null,
  "effective_amount": "50000"
}

Attributes

iduuid

Id of the order.

statusstring

Status of the order: PENDING, SUCCEEDED, SETTLED, BROADCAST, or FAILED.

amountstring

Amount of the order. This value is a numeric string, with up to 18 digits before the decimal point and with up to 18 digits after the decimal point. Otherwise, the API will return an error.

Minimum amount for COPM: 10,000 COP (applies to both TOKENIZE and REDEEM orders).

typestring

Type of the order: TOKENIZE or REDEEM.

external_identifierstringnullable

External identifier of the order.

origin_source_iduuid

Id of the origin source. In redeem orders must be a wallet Id. In tokenize orders must be a bank account Id.

destination_source_iduuid

Id of the destination source. In redeem orders must be a bank account Id. In tokenize orders must be a wallet Id.

public_dataJSONnullable

Public data associated with the order.

activitiesarray

Activities related to the order.

chainstring

Chain information.

effective_amountstring

Effective amount of the order. The real amount that will be transferred. Numeric string with up to 18 decimal digits.

status_codestringnullable

Status code of the order: CANCELED or EXPIRED.

funding_methodstringnullable

Funding method used for the order (e.g. ORDINARY).

fulfilled_atstringnullable

Date when the order was fulfilled. ISO 8601 format.

created_atstring

Date when the order was created.

updated_atstring

Date when the order was last updated.

Status Lifecycle