Order object
| Name | Description | Format | Mandatory | Example |
|---|---|---|---|---|
| uuid | Unique identifier of the order Generated by Lyra Collect | an..36 | N/A | 8ea5e574-e198-55d4-ba23-f9405ec4226c |
| href | URL to access this resource Generated by Lyra Collect | see example | N/A | https://secure.lyra.com/marketplace/orders/ 8ea5e574-e198-55d4-ba23-f9405ec4226c |
| created_at | Date and time of resource creation Generated by Lyra Collect | see example | N/A | 2015-01-17T09:39:54.948Z |
| updated_at | Date and time of the last resource modification Generated by Lyra Collect | see example | N/A | 2015-01-17T09:39:54.948Z |
| marketplace | UUID of the Marketplace | an..36 | X | 6ea5e574-e198-55d4-ba23-f9405ec4226b |
| reference | Order reference | an..32+"-" | X | CMD-123456 |
| description | Order description | an..255 | Order 123456 - Margaritas x2 + 4 seasons x1 | |
| vads_transaction_id | Transaction identifier Lyra Collect | n..6 | N/A | 379 Note: Field deprecated here. |
| vads_transaction_date | Date and time of the Lyra Collect transaction in the YYYYMMDDHHMMSS format | an..14 | N/A | 20150320094512 Note: Field deprecated here. |
| buyer | Buyer details | Buyer object | X | |
| alias | Token ID in the gateway | ans..64 | 1144951ea7ab42989c97159b3dfc0382 | |
| shipping | Shipping details | Shipping object | ||
| amount | Order total amount, expressed in the smallest currency unit. | n..12 | N/A | 50000 for EUR 500. |
| currency | Currency of the order (ISO 4217) | a3 | X | EUR |
| language | Display language of the payment pages (ISO 639-1) | a2 | FR | |
| capture_delay | Indicates the delay (in days) before the capture at the bank | Positive integer between 0 and 6 | No. Only available in creation (POST) | 3 |
| expected_capture_date | Expected capture date, in UTC timezone, in the YYYYMMDDHHMMSS format. | Date | No. Only available in update (PUT) | 20180716083000 |
| status | Order status Generated by Lyra Collect | an..10 | N/A | PENDING |
| webhook_result | Result of the notification sent to the Marketplace Generated by Lyra Collect | n..3 | N/A | 200 |
| url_return | Default buyer return URL on the Marketplace website. | an..512 | http://www.sitemarketplace.com/url_de_retour.html | |
| url_success | Buyer return URL on the Marketplace website after a successfully completed payment. | an..200 | http://www.sitemarketplace.com/url_success.html | |
| url_refused | Buyer return URL on the Marketplace website after a refused payment. | an..200 | http://www.sitemarketplace.com/url_refused.html | |
| url_cancel | Buyer return URL on the Marketplace website after a canceled payment. | an..200 | http://www.sitemarketplace.com/url_cancel.html | |
| url_error | Buyer return URL on the Marketplace website after a payment that resulted in an error. | an..200 | http://www.sitemarketplace.com/url_error.html | |
| return_mode | Data transmission method used when returning to the merchant website. | a4 | POST | |
| links | Links to the Items resources Generated by Lyra Collect | see example | N/A | {
"items": {
"href": "https://secure.lyra.com/
marketplace/orders/8ea5e574-e198-55d4-
ba23-f9405ec4226c/items"
}
} |
| persist_url | Persistent payment link | url | N/A | "https://secure.lyra.com/marketplace/t/ioeD1uRP" |
| expiry_date | Expiration date of the persistent link | see example | N/A | "2021-02-15T15:37:47.632009Z" |
| form_token | Token of the embedded form | an | Example: ffa0yfV2FQuR3aak1SwsgcuZg195eyJhbW9 OjEwOTAwLCJjdXJyZW5jeSI6IkVVUiIsIm1v UiOiJURVNUIiwidmVyc2lvbiI6Mywib3JkZXJJ I6IjVjNDk1N2E5LWNkOGEtNGJhZC1hMGN gxMTZiMWE3ZDdmNiIsInNob3BOYW1lIjoi yYSBTTVMiLCJicmFuZFByaW9yaXR5IjpbIkJ TkNPTlRBQ1QiLCJDQiIsIkUtQ0FSVEVCTEVV RSIsIk1BU1RFUkNBUkQiLCVGQVVMVCJ9fX 0a702 |