Getting Started

Push Cash Documentation

Home

Support

List accounts

Settlement Account

When the account was created (ISO 8061 date string)

bearer

Description of the error encountered from the API request

Sandbox API used for developing an integration with Push

Welcome

Quickstart

Integration Guide

Go Live

Mobile Webview

Manual Review

Custom Limits

Loyalty

API Concepts

Settlement

Button

Webhooks

Create user

List users

Get a user

Share a user's transaction history with Push.
Integrating this endpoint is a pre-requisite for Push to approve requests to increase a user's transaction limits.


Update a user

Create intent

List intents

Get an intent

For intents which must be approved by the operator manually, approves the intent and posts the payment to the network.


Approve a pending intent

Cancel an outstanding intent which has not yet been approved.


Cancel an intent

Retrieves a single account and balance by ID

Get account

List transactions

Retrieves a specific transaction by its ID.

Get a transaction

List disputes

Retrieve a dispute

List transfers

Retrieve a transfer

Use this endpoint to simulate receiving the funds from an approved intent, creating a new transaction and updating the balance in the settlement account associated with the intent.


Simulate settlement

Use this endpoint to simulate a transfer to or from an account.
Provide one of either `from` or `to` to indicate which account should receive or send the funds.
The amount of the transfer is optional in the case you are simulating a transfer of all available funds from the balance.


Simulate transfer

Use this endpoint to simulate receiving a dispute for an approved intent.


Simulate dispute

Use this endpoint to simulate resolving a dispute and receiving your reimbursed funds as a part of the Push Cash guarantee.


Simulate dispute resolution

Simulate a loyalty opt-in event in our sandbox and receive the `user.loyalty.processed` webhook with your submitted test data

Simulate loyalty

Use this endpoint to simulate a decision being made on a limits request which sends you a webhook notification and updates the user's daily limit. 


user

intent

accounts

dispute

transfer

simulate

List accounts

Authorizations

Response