Skip to main content

Documentation

Retrieve Escrow

Retrieve details of the escrow for a payment.

    • payment

    • ID of the payment. String starting with payment_.

    • escrow

    • ID of the escrow. String starting with escrow_.

Code Samples
    • .NET

      • using System;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        string payment = "payment_dfaea6d5c3aa8be4ddecdbb293e3a2ce";
                        string escrow = "escrow_b871de8911d15d4ffb890db454f21af5";
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payments/{payment}/escrows/{escrow}");
        
                        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/payments/payment_b8f1f3c75eb74fc318daa89418f6c8e9/escrows/escrow_8484400128afa6aa8b31297088e81f45'
            );
        
            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/payments/payment_a813e2bac82bad744b98defa727f7e3c/escrows/escrow_f3c4db8e23bde2973704a7f9f32baabb");
            var_dump($object);
        } catch(Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        payment = "payment_35544ff0d05c578c87ad171f2dd2ba6e"
        escrow = "escrow_71193eec47ff06ce000e0c4423cbb68d"
        response = make_request(method='get',
                                path=f'/v1/payments/{payment}/escrows/{escrow}')
        
        pprint(response)
        
  • /v1/payments/:payment/escrows/:escrow

  • Retrieve Escrow

  • curl -X get
    https://sandboxapi.rapyd.net/v1/payments/payment_47095e052bbe16080a402af937f377d3/escrows/escrow_df0a95af70e696947706cb59bd53d46f
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -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": "973e49ac-3965-473a-b06d-2f3efd939050"
        },
        "data": {
            "id": "escrow_df0a95af70e696947706cb59bd53d46f",
            "payment": "payment_47095e052bbe16080a402af937f377d3",
            "currency": "MXN",
            "amount_on_hold": 0,
            "total_amount_released": 0,
            "status": "pending",
            "escrow_release_days": null,
            "escrow_releases": null,
            "created_at": 1654064794,
            "updated_at": 1654064794,
            "last_payment_completion": null
        }
    }