Move money from a single source to multiple destinations.
Simplified flow of how multiple sources work
User | Balance ID | Expectation |
---|---|---|
Sender | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 | Will send a total of USD 30,000 |
Person A | bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f | Will receive 20% of USD 30,000 |
Person B | bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d | Will receive USD 10,000 |
Person C | bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b | Will receive the remaining amount left |
Parameters | Description |
---|---|
Amount | Total amount to be sent by the sender (USD 30,000), |
Source | Balance ID of the sender. |
Destinations | Balance IDs of all the balances the amount is distributed to. |
Field | Description | Required | Type |
---|---|---|---|
amount | Total amount of money to be sent. | Yes | float |
precision | Converts the transaction amount to the lowest unit possible. See also → Understanding precision. | No | int64 |
reference | Unique transaction reference. | Yes | string |
currency | Short code for your asset class. See also → Defining asset classes. | Yes | string |
source | Sender’s balance ID. | Yes | string |
destinations | Contains information about the destinations the money is being sent to. Each object within this array represents a destination and has 2 required fields — identifier and distribution . | Yes | |
identifier | Destination’s balance ID | Yes | string |
distribution | Specific amount being sent to the respective destination. | Yes | string |
narration | Short description for the respective destination. | No | string |
meta_data | Custom data associated with the transaction | No | object |
destination
field in your payload. Use the destinations
array to group the participating balances in your payload.Reference | Currency | Amount | Source | Destination |
---|---|---|---|---|
ref_001adcfgf1 | USD | 6000 | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 | bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f |
ref_001adcfgf2 | USD | 10000 | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 | bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d |
ref_001adcfgf3 | USD | 14000 | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 | bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b |
Distribution type | Description | Example |
---|---|---|
Specific amount | Provide the specific amount of money to be received | "distribution": "10000" - Means USD 10,000 from the total amount should be received |
Percentage | Calculates a percentage of the total amount to be received | "distribution": "20%" - Means 20% of the total amount should be received |
”left” | Calculates the remaining amount not assigned to a destination | "distribution": "left" - Means the remaining amount left after others have been deducted should be received |
left
distribution type once in your request body.distributions
fields is exactly equal to the value specified in the amount
field.1
, is appended for each transaction record created ensuring that the individual transaction records have unique references derived from the original transaction reference. This makes sure that each transaction record is unique through its modified reference ensuring traceability and management while preserving the integrity of the original transaction’s reference.