Retrieve Beneficiary
Retrieve details of a payout beneficiary.
Note
The Retrieve Beneficiary - individual response includes additional fields for the ca_general_bank payout method. The Retrieve Beneficiary - company response includes additional fields for the us_ach_bank payout method.
beneficiary
ID of the
beneficiaryobject. String starting with beneficiary_.
.NET
using System; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { string beneficiaryId = "beneficiary_8ba699483c80b7fb9f7e658be3275703"; string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payouts/beneficiary/{beneficiaryId}"); 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/payouts/beneficiary/beneficiary_8ba699483c80b7fb9f7e658be3275703' ); 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/payouts/beneficiary/beneficiary_8ba699483c80b7fb9f7e658be3275703'); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?>
Python
from pprint import pprint from utilities import make_request beneficiary_id = 'beneficiary_8ba699483c80b7fb9f7e658be3275703' results = make_request(method='get', path=f'/v1/payouts/beneficiary/{beneficiary_id}') pprint(results)
/v1/payouts/beneficiary/:beneficiary
Retrieve Beneficiary - individual
curl -X get https://sandboxapi.rapyd.net/v1/payouts/beneficiary/beneficiary_8ba699483c80b7fb9f7e658be3275703 -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": "5dd490da-c4b8-4556-859d-61224ee6c9b0" }, "data": { "id": "beneficiary_8ba699483c80b7fb9f7e658be3275703", "last_name": "Doe", "first_name": "John", "country": "CA", "entity_type": "individual", "address": "1 Main Street", "name": "John Doe", "postcode": "12345", "city": "Montreal", "state": "Quebec", "account_number": "1234567", "currency": "USD", "identification_type": "identification_id", "identification_value": "123456789", "bank_name": "John Doe", "merchant_reference_id": "JDoe", "bic_swift": "12345678XXX", "payment_type": "priority", "category": "bank" } }
Retrieve Beneficiary - company
curl -X get https://sandboxapi.rapyd.net/v1/payouts/beneficiary/beneficiary_d895d90d276869efe1e359386a1fb3e3 -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": "d1231150-7398-4ec2-9525-d46a0a39b7d5" }, "data": { "id": "beneficiary_d895d90d276869efe1e359386a1fb3e3", "country": "US", "entity_type": "company", "name": "All Star Limousine", "company_name": "All Star Limousine", "account_number": "0987654321", "currency": "USD", "identification_type": "company_registered_number", "identification_value": "9876543210", "bank_name": "All Star Limousine", "merchant_reference_id": "AllStarLimo", "aba": "987654321", "category": "bank" } }