You can split a single payment amount between multiple Rapyd wallets. The payment can be divided into 2-10 wallets. When you are listing the wallets receiving the payment, any percentage or amount that remains unlisted adding up to 100% or the total amount will be paid directly into the client wallet.
For example:
A Split Payment by percentage request for $100 only includes 2 personal wallets but does not list the client wallet in the request. 80% of the payment goes to one wallet while 10% goes to the other wallet leaving the remaining 10% out.
POST https://sandboxapi.rapyd.net/v1/payments
Request
{
"amount": 100.00,
"currency": "USD",
"payment_method": {
"type": "us_visa_card",
"fields": {
"number": "4111111111111111",
"expiration_month": "11",
"expiration_year": "22",
"cvv": "123",
"name": "John Doe"
}
},
"description": "Split payment example",
"ewallets": [
{
"ewallet": "ewallet_10a46adb3c00e2078e38741956f3686c",
"percentage": 80
},
{
"ewallet": "ewallet_728715579a9f46d5620542838d23c1e5",
"percentage": 10
}
],
"metadata": {
"merchant_defined": true
}
}
Response
{
"status": {
"error_code": "",
"status": "SUCCESS",
"message": "",
"response_code": "",
"operation_id": "184f7f46-cd0b-462c-8f74-e98611fa3252"
},
"data": {
"id": "payment_c409ba2dedf047fbb9f1b88f7a40932a",
"amount": 100,
"original_amount": 100,
"is_partial": false,
"currency_code": "USD",
"country_code": "US",
"status": "CLO",
"description": "Split payment example",
"merchant_reference_id": "",
"customer_token": "cus_46b18c86c7c9d0c3ff80a8ed01963efb",
"payment_method": "card_e6377f4f2cddfb984999806cd20e69d5",
"payment_method_data": {
"id": "card_e6377f4f2cddfb984999806cd20e69d5",
"type": "us_visa_card",
"category": "card",
"metadata": null,
"image": "",
"webhook_url": "",
"supporting_documentation": "",
"next_action": "not_applicable",
"name": "John Doe",
"last4": "1111",
"acs_check": "unchecked",
"cvv_check": "unchecked",
"bin_details": {
"type": null,
"brand": null,
"country": null,
"bin_number": "411111"
},
"expiration_year": "22",
"expiration_month": "11",
"fingerprint_token": "ocfp_2a694038316f52122bbbb3ae926cfda9"
},
"expiration": 1640189724,
"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": "Test Business",
"transaction_id": "",
"created_at": 1639584925,
"metadata": {
"merchant_defined": true
},
"failure_code": "",
"failure_message": "",
"paid": true,
"paid_at": 1639584925,
"dispute": null,
"refunds": null,
"order": null,
"outcome": null,
"visual_codes": {},
"textual_codes": {},
"instructions": [],
"ewallet_id": null,
"ewallets": [
{
"ewallet_id": "ewallet_db4ad4a76278f94c4a83dd9b28b483ed",
"amount": 10,
"percent": 10,
"refunded_amount": 0
},
{
"ewallet_id": "ewallet_10a46adb3c00e2078e38741956f3686c",
"amount": 80,
"percent": 80,
"refunded_amount": 0
},
{
"ewallet_id": "ewallet_728715579a9f46d5620542838d23c1e5",
"amount": 10,
"percent": 10,
"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": "",
"cancel_reason": null,
"initiation_type": "customer_present",
"mid": "",
"next_action": "not_applicable",
"error_code": ""
}
}
Wallet IDs ewallet_10a46adb3c00e2078e38741956f3686c & ewallet_10a46adb3c00e2078e38741956f3686c are both personal wallets, while ewallet_db4ad4a76278f94c4a83dd9b28b483ed (not included in the request) is the client wallet. The client wallet can be found by:
- Retreive Wallet by ID
- List Wallets by type=client
- The Client Portal under My Account > Account Details.
