Orders

An order in the Depay system represents a payment transaction initiated by scanning a QR code and completed with payment confirmation. The sequence diagram illustrates how the Depay API, Wallet Exchange API, and the user's Wallet interact to manage these orders.

The process begins when the user scans a QR code with their Wallet. The Wallet requests the order information from the Wallet Exchange API, which in turn queries the Depay API. Once the information is retrieved, it is sent back to the user's Wallet.

Next, the user makes the payment, and the Wallet sends the transaction details to the Wallet Exchange API, which forwards them to the Depay API, marking the order as "in progress." The Depay API processes the payment and notifies the result back to the Wallet via the Wallet Exchange API.

Finally, the order is closed through a request from the Wallet Exchange API to the Depay API, confirming the transaction's completion. This flow ensures efficient and secure coordination between all system components.

Gets a new order by QR

POSThttps://api.depay.us/exchange/orders/qr

After scanning the QR code, this method returns the last order of a Client/Point of Sale.

Query Parameters

Name	Type	Description
qr*	string	String from the scanned QR

Headers

Name	Type	Description
Authentication*	string	Bearer token

200 Successful operation

{
    "uuid": "df4f3ccd-1570-42f8-8504-06cf9c32209b",
    "external_reference": "EXT_REF_00002",
    "title": "title",
    "description": "description",
    "total_amount": 1.910828025477707,
    "date_time": "2023-08-29T20:41:15.852Z",
    "order_status": [
        {
            "uuid": "24e70bed-ed07-4221-9a64-9fdba4a9d153",
            "id": 13,
            "status": "pending",
            "date_time": "2023-08-29T20:41:15.908Z"
        }
    ]
}

401 Permission denied

404: Not Found Order not Found

Get an existing Order

GET https://api.depay.us/orders/{order_id}

Gets an existing order by uuid

Query Parameters

Name	Type	Description
order_id*	string	Order identifier

Headers

Name	Type	Description
Authentication*	string	Bearer Token

200: OK Successful operation

{
    "uuid": "df4f3ccd-1570-42f8-8504-06cf9c32209b",
    "external_reference": "EXT_REF_00002",
    "title": "title",
    "description": "description",
    "total_amount": 1.910828025477707,
    "date_time": "2023-08-29T20:41:15.852Z",
    "orderStatus": [
        {
            "id": 13,
            "status": "pending",
            "date_time": "2023-08-29T20:41:15.908Z"
        }
    ]
}

401: Unauthorized Permission denied

404: Not Found Order not Found

Update Order status

POST https://api.depay.us/exchange/payment

After the user has made the payment, the result should be reported to the API.

Headers

Name	Type	Description
Authorization*	string	Bearer Token

Request Body

Name	Type	Description
qr*	string	String from the scanned QR
transaction*	object
wallet_origin	string	The wallet ID of the person making the payment.
transaction_number	string	The transaction identifier
amount	number	Total amount to be paid
status	string	This field is the value of the user's decision. The accepted values are 'accepted' or 'rejected'

200: OK Successful operation

401: Unauthorized Permission denied

404: Not Found Order not Found

Request Body Example

{
    "qr": "Depay:bc3fc2d1-4da4-420c-b92e-b4ab60e1c4d6/305116c3-46a6-4444-ad74-4a1093074623/false",
    "transaction": {
        "wallet_origin": "origin_wallet",
        "transaction_number": "00000001",
        "amount": 1.38269,
        "status": "accepted"
    }
}