Move money from multiple sources to a single destination.
Simplified flow of how multiple sources work
User | Balance ID | Expectation |
---|---|---|
Recipient | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 | Will receive a total of USD 30,000 |
Person A | bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f | Will send 10% of USD 30,000 |
Person B | bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d | Will send USD 20,000 |
Person C | bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b | Will send the remaining amount left |
Parameters | Description |
---|---|
Amount | Total amount to be received by the recipient (USD 30,000). |
Sources | Balance IDs of all the balances the amount is sourced from. |
Destination | Balance ID of the recipient. |
Field | Description | Required | Type |
---|---|---|---|
amount | Total amount of money to be received. | 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 |
sources | Contains information about the sources from where the money is being sent from. Each object within this array represents a source and has 2 required fields — identifier and distribution . | Yes | |
identifier | Sender’s balance ID | Yes | string |
distribution | Specific amount being drawn from the respective source. | Yes | string |
narration | Specific description for the respective source | No | string |
destination | Recipient’s balance ID. | Yes | string |
meta_data | Custom data associated with the transaction | No | object |
source
field in your payload. Use the sources
array to group the participating balances in your payload.Reference | Currency | Amount | Source | Destination |
---|---|---|---|---|
ref_001adcfgf1 | USD | 3000 | bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 |
ref_001adcfgf2 | USD | 20000 | bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 |
ref_001adcfgf3 | USD | 7000 | bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b | bln_92e4b9b6-0b85-4ef4-87a2-682c31500d38 |
Distribution type | Description | Example |
---|---|---|
Specific amount | Provide the specific amount of money to be sent | "distribution": "20000" - Means USD 20,000 from the total amount should be sent |
Percentage | Calculates a percentage of the total amount to be sent | "distribution": "10%" - Means 10% of the total amount should be sent |
”left” | Calculates the remaining amount not assigned to a source | "distribution": "left" - Means the remaining amount left after others have been deducted should be sent |
left
distribution type once in your request body.sources
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.