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_a7f40f90f6140a9f69459284330ee6f2/escrows/escrow_6c435c866b0377496599225bc780a82a' \ -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": "6bb8e51a-a0e3-4cb0-8a28-e3ad9c89a71c" }, "data": { "id": "escrow_6c435c866b0377496599225bc780a82a", "payment": "payment_a7f40f90f6140a9f69459284330ee6f2", "currency": "EUR", "amount_on_hold": 0, "total_amount_released": 45, "status": "canceled", "escrow_release_days": null, "escrow_releases": { "data": [ { "id": "er_8dd4414e7d04a2fb03927d520d04f494", "amount": 45, "trigger": "cancel_escrow", "proportional_release": true, "ewallets": [ { "ewallet": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 45 } ], "created_at": 1764090610, "currency": "EUR" } ], "has_more": false, "total_count": 1, "url": "/v1/payments/payment_a7f40f90f6140a9f69459284330ee6f2/escrows/escrow_6c435c866b0377496599225bc780a82a/escrow_releases" }, "created_at": 1756294558, "updated_at": 1764090610, "last_payment_completion": 1756294559 } }