Retrieve Group Payment
Retrieve details of a group payment.
group_payment
ID of the group payment. String starting with gp_.
Code Samples
.NET
using System; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { string payment = "gp_7e2b7abee522ba5089eb98c7482991ea"; string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payments/group_payments/{payment}"); 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/group_payments/gp_b2eb53a2624345dc3701d59ccac2facd' ); 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/group_payments/gp_d5463a9c56c3180b40a4623df37091c3'); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?>
Python
from pprint import pprint from utilities import make_request group_payment = "gp_22c833729a6a442b13ae2a3b4f745907" response = make_request(method='get', path=f'/v1/payments/group_payments/{group_payment}') pprint(response)
/v1/payments/group_payments/:group_payment
Retrieve Group Payment
curl -X get https://sandboxapi.rapyd.net/v1/payments/group_payments/gp_89aedef8594241094a94685dcde3707b -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": "c41cf941-1d13-43e3-ae4b-264103680502" }, "data": { "id": "gp_89aedef8594241094a94685dcde3707b", "amount": 1050, "amount_to_replace": 0, "status": "closed", "currency": "USD", "country": "US", "merchant_reference_id": "12345-69089", "description": "", "metadata": { "merchant_defined": true }, "expiration": null, "cancel_reason": null, "payments": [ { "id": "payment_9aa5c53b69114517b1e20ce4ba9eedd3", "amount": 25, "original_amount": 25, "is_partial": false, "currency_code": "USD", "country_code": "US", "status": "CLO", "description": "", "merchant_reference_id": "", "customer_token": "cus_4a5e278ce40d99a8f4cd9275593c675b", "payment_method": "card_263e6ea7d8742ace8f57bb57caed7e9c", "payment_method_data": { "id": "card_263e6ea7d8742ace8f57bb57caed7e9c", "type": "us_visa_card", "category": "card", "metadata": null, "image": "", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "name": "Joe Doe", "last4": "0000", "acs_check": "unchecked", "cvv_check": "unchecked", "bin_details": { "type": null, "brand": null, "country": null, "bin_number": "446203" }, "expiration_year": "25", "expiration_month": "11", "fingerprint_token": "ocfp_1476e28831f830fb85356e3b61a1ed84" }, "expiration": 1641819397, "captured": true, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Rapyd", "transaction_id": "", "created_at": 1641214597, "metadata": {}, "failure_code": "", "failure_message": "", "paid": true, "paid_at": 1641214597, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": [], "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 25, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "us_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": "gp_89aedef8594241094a94685dcde3707b", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "not_applicable", "error_code": "", "remitter_information": {} }, { "id": "payment_8775855f7a472b3a07c5894d2badb532", "amount": 1025, "original_amount": 1025, "is_partial": false, "currency_code": "USD", "country_code": "US", "status": "CLO", "description": "", "merchant_reference_id": "", "customer_token": "cus_f6c0c6f52ce70ab15d7c3aee921f6e7d", "payment_method": "card_57fd1cc634d1ee5c0425e1e8afd3b5ce", "payment_method_data": { "id": "card_57fd1cc634d1ee5c0425e1e8afd3b5ce", "type": "us_visa_card", "category": "card", "metadata": null, "image": "", "webhook_url": "", "supporting_documentation": "", "next_action": "not_applicable", "name": "Jon Doe", "last4": "1111", "acs_check": "unchecked", "cvv_check": "unchecked", "bin_details": { "type": null, "brand": null, "country": null, "bin_number": "411111" }, "expiration_year": "25", "expiration_month": "11", "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467" }, "expiration": 1641819397, "captured": true, "refunded": false, "refunded_amount": 0, "receipt_email": "", "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_8775855f7a472b3a07c5894d2badb532", "complete_payment_url": "", "error_payment_url": "", "receipt_number": "", "flow_type": "", "address": null, "statement_descriptor": "Rapyd", "transaction_id": "", "created_at": 1641214597, "metadata": {}, "failure_code": "", "failure_message": "", "paid": true, "paid_at": 1641215836, "dispute": null, "refunds": null, "order": null, "outcome": null, "visual_codes": {}, "textual_codes": {}, "instructions": [], "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 1025, "percent": 100, "refunded_amount": 0 } ], "payment_method_options": {}, "payment_method_type": "us_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": "gp_89aedef8594241094a94685dcde3707b", "cancel_reason": null, "initiation_type": "customer_present", "mid": "", "next_action": "not_applicable", "error_code": "", "remitter_information": {} } ] } }