Creating Cash Outs means sending an AppUser the money in their Wallet as real, physical cash (or a payout they can actually receive).
https://api.sandbox.purplx.mehttps://api.purplx.meWallet: PurplX - Wallets
Cash Out Partner Branch:
| Name | Type | Notes |
|---|---|---|
url |
Integer | Read-only permanent address of the Cash Out Partner Branch resource. |
id |
URL | Read-only unique integer ID of the Cash Out Partner Branch resource. |
name |
String | The name of the branch. |
type |
Enum | “ATM” or “Branch”. “Branch” is another name for over-the-counter Cash Out, or agent Cash Out. |
distance |
Float | The calculated distance based from the submitted query parameters lat, lng, lat_delta, lng_delta. |
active |
Boolean | A boolean field for telling if the branch still accepts Cash Out requests or not anymore. |
address |
String | The address of the branch. |
code |
String | An alpha-numeric unique identifier of the branch. |
location_name_on_map |
String | The address of the branch. |
cash_out_partner |
JSON Object | The Cash Out Partner owning the branch. |
lat |
Float | The branch’s latitude. |
lng |
Float | The branch’s longitude. |
opening_hours |
JSON Object | The opening and closing hours of the branch. |
Cash Out:
| Name | Type | Notes |
|---|---|---|
url |
Integer | Read-only permanent address of the Cash Out resource. |
id |
URL | Read-only unique integer ID of the Cash Out resource. |
code |
String | The generated reference code for the Cash Out. |
status |
Enum | When “Pending”, it means the Cash Out is still active. It can still be completed or cancelled. “Pending” means the amount is on hold, and cannot be used for something else. |
“Cancelled” means the Cash Out is no longer active, and the hold on the amount has been released.
“Completed” means the Cash Out is no longer active, as it’s been successfully completed, meaning the AppUser has received the payout amount already. |
| amounts | JSON Object | The break down of the amounts. This will include:
• payout: The actual net amount that will be received by the AppUser.
• purpl_fees: The fees collected by Purpl.
• partner_fees: The fees collected by Purpl’s Cash Out Partner. |
| branch | JSON Object | The branch initially selected, or the branch where the AppUser actually received the payout amount. |
| app_user | JSON Object | The AppUser who requested for the Cash Out. |
| datetime_created | Datetime | The datetime of when the Cash Out was created. |
| datetime_updated | Datetime | The datetime of when the Cash Out was updated. |
1st
Identify the Wallet from where the Cash Out amount will be deducted. Make sure the selected Wallet has the feature cash_out enabled.
Example request: