Skip to main content

Documentation

Retrieve an Order

Retrieve the details of an order.

    • order

    • ID of the order to pay. String starting with order_.

Code Samples
    • .NET

      • using System;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        string order = "order_20bdf9df5841e57ba80e0a68085871ea";
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/orders/{order}");
        
                        Console.WriteLine(result);
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine("Error completing request: " + e.Message);
                    }
                }
            }
        }
    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;
        
        async function main() {
          try {
            const result = await makeRequest('GET', '/v1/orders/order_20bdf9df5841e57ba80e0a68085871ea');
        
            console.log(result);
          } catch (error) {
            console.error('Error completing request', error);
          }
        }
        
    • PHP

      • <?php
        $path = $_SERVER['DOCUMENT_ROOT'];
        $path .= "/<path-to-your-utility-file>/utilities.php";
        include($path);
        
        try {
            $object = make_request('get', '/v1/orders/order_20bdf9df5841e57ba80e0a68085871ea');
            var_dump($object);
        } catch(Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        result = make_request(method='get', path='/v1/orders/order_20bdf9df5841e57ba80e0a68085871ea')
        pprint(result)
  • /v1/orders/:order

  • Retrieve an Order

  • curl -X get 'https://sandboxapi.rapyd.net/v1/orders/order_22d01f7d9122c819212da78b2f3a3cad' \
    -H 'access_key: your-access-key-here' \
    -H 'Content-Type: application/json' \
    -H 'salt: your-random-string-here' \
    -H 'signature: your-calculated-signature-here' \
    -H 'timestamp: your-unix-timestamp-here'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "9ae5df33-06c1-4d3e-98f0-33b41524ba6e"
        },
        "data": {
            "id": "order_22d01f7d9122c819212da78b2f3a3cad",
            "amount": 410,
            "amount_returned": 0,
            "payment": {
                "id": "payment_3de65b9f0d0a639b17b9cec49eb71e33",
                "amount": 410,
                "original_amount": 410,
                "is_partial": false,
                "currency_code": "USD",
                "country_code": "GB",
                "status": "CLO",
                "description": "",
                "merchant_reference_id": "",
                "customer_token": "cus_4e25112ac20e144ad073a614dc46934b",
                "payment_method": "card_b9548d9b53a565b2315fecdc6c87f158",
                "payment_method_data": {
                    "id": "card_b9548d9b53a565b2315fecdc6c87f158",
                    "type": "gb_visa_card",
                    "category": "card",
                    "metadata": {},
                    "image": "",
                    "webhook_url": "",
                    "supporting_documentation": "",
                    "next_action": "not_applicable",
                    "name": "John Doe",
                    "last4": "1111",
                    "acs_check": "unchecked",
                    "cvv_check": "unchecked",
                    "bin_details": {
                        "type": "DEBIT",
                        "brand": "VISA",
                        "level": "CLASSIC",
                        "issuer": "CONOTOXIA SP. Z O.O",
                        "country": "PL",
                        "bin_number": "411111"
                    },
                    "expiration_year": "35",
                    "expiration_month": "12",
                    "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                    "network_reference_id": "196308",
                    "rapyd_fingerprint_token": "rcfp_0bfddd6cd4ab11ea95b9121ff706f893",
                    "payment_account_reference": "V001CGKH4PLK6DGD549CNOC3VZV3X"
                },
                "auth_code": null,
                "expiration": 1764083596,
                "captured": true,
                "refunded": false,
                "refunded_amount": 0,
                "receipt_email": "johndoe@rapyd.net",
                "redirect_url": "",
                "complete_payment_url": "",
                "error_payment_url": "",
                "receipt_number": "",
                "flow_type": "",
                "address": null,
                "statement_descriptor": "Doc Team",
                "transaction_id": "",
                "created_at": 1763478796,
                "metadata": {},
                "failure_code": "",
                "failure_message": "",
                "paid": true,
                "paid_at": 1763478797,
                "dispute": null,
                "refunds": null,
                "order": null,
                "outcome": null,
                "visual_codes": {},
                "textual_codes": {},
                "instructions": [],
                "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                "ewallets": [
                    {
                        "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                        "amount": 410,
                        "percent": 100,
                        "refunded_amount": 0
                    }
                ],
                "payment_method_options": {},
                "payment_method_type": "gb_visa_card",
                "payment_method_type_category": "card",
                "fx_rate": 1,
                "merchant_requested_currency": null,
                "merchant_requested_amount": null,
                "fixed_side": "",
                "payment_fees": null,
                "invoice": "",
                "escrow": null,
                "group_payment": "",
                "cancel_reason": null,
                "initiation_type": "customer_present",
                "mid": "",
                "next_action": "not_applicable",
                "error_code": "",
                "remitter_information": {}
            },
            "created": 1763478744,
            "customer": "cus_4e25112ac20e144ad073a614dc46934b",
            "currency": "USD",
            "email": "johndoe@rapyd.net",
            "external_coupon_code": "",
            "items": [
                {
                    "amount": 200,
                    "currency": "USD",
                    "description": "Deluxe Gamer's Chair",
                    "parent": "sku_6eb43887fd478baaf9223ec7ec17da21",
                    "quantity": 2,
                    "type": "sku"
                },
                {
                    "amount": 10,
                    "currency": "USD",
                    "description": "Shipping",
                    "parent": "",
                    "quantity": 1,
                    "type": "shipping"
                }
            ],
            "metadata": {},
            "returns": [],
            "shipping_address": {
                "id": "address_0a29bdf86ef5e1e0110da358efc20ee7",
                "name": "John Doe",
                "line_1": "123 First Street",
                "line_2": "",
                "line_3": "",
                "city": "Anytown",
                "state": "NY",
                "country": "US",
                "zip": "12345",
                "phone_number": "12125559999",
                "metadata": {},
                "canton": "",
                "district": "",
                "created_at": 1763478745
            },
            "status": "paid",
            "status_transitions": {
                "canceled": 0,
                "fulfilled": 0,
                "paid": 1763478797,
                "returned": 0,
                "pending": 1763478797,
                "partial": 0
            },
            "updated": 1763478797,
            "upstream_id": "2025-11-18a",
            "tax_percent": 0
        }
    }