Purpl Cash Out Partner Integration

For developers at institutions that pay out cash to Purpl users (banks, exchange houses, money transfer operators, ATM networks).

1. How it works

A user picks one of your branches in the Purpl app and requests a cash out. Purpl holds the amount and gives the user:

a Purpl reference: 10 digits, for example 2661097988.
a security code: 6 digits, valid for 60 minutes, refreshable in the app.

The user brings both to your branch. Your system then:

Retrieves the cash out by its Purpl reference.
Shows the teller the amount and the receiver details.
Pays the cash.
Tells Purpl the cash out is completed.

The user’s wallet is debited on step 4, not before. An uncompleted cash out stays on hold until the user cancels it in the app.

User (Purpl app)          Purpl API                    Your system
     |                        |                             |
     |-- request cash out --->|                             |
     |<-- reference + code ---|                             |
     |                        |                             |
     |----------- walks into your branch ----------------->|
     |                        |<-- GET  /cash-outs/{ref}/ --|
     |                        |--- pending + amounts ------>|
     |                        |                             |-- pays cash
     |                        |<-- PATCH /cash-outs/{ref}/ -|   (completed)
     |<-- push: completed ----|--- completed -------------->|

There are no webhooks. You pull the cash out when the customer arrives. Purpl never calls your system.

2. Integration steps

Step 1: Setup

Send us:

What	Notes
Branch list	Per branch or ATM: name, your branch code (unique, stable), address, latitude, longitude, type (`Branch` or `ATM`), opening hours.

Purpl creates on the test environment: