Search…
⌃K
💌

P2P

Overview

The P2P object represents a payment from one of your activated nerve connections to another. P2P payments must be individually authorized by the sender within 10 minutes of creation, using a verification code sent to their mobile device. Once committed, P2P payments are initiated immediately, and cannot be canceled.

Permission Required

Executing peer to peer transactions requires the payment.debit permission from the source account connection and the payment.credit permission from the destination account connection. Since peer to peer implementations typically allow free money flow to/from all peers, we recommend requesting both permissions from all users.

Methods

post
/p2p
Create P2P
post
/p2p/{id}/commit
Commit P2P
get
/p2p/{id}
Get P2P
put
/p2p/{id}
Update P2P
get
/p2p
List P2P
get
/account-connection/{id}/p2p
List P2P for Account Connection
get
/account-connection/{id}/p2p/{peer_id}
List P2P between two Account Connections
​

Properties

id string Identifier for this payout.
source string ID of Account Connection sending money.
destination string ID of Account Connection receiving money.
description string Description of payout. (Visible to creators.)
amount_in_cents number Amount in cents, e.g. $1.00 would be the number 100.
status string Status of payout. One of
created
Initial status after object creation. Requires Commit P2P method to be executed.
pending
P2P has been committed, but payment is not complete.
sent
The payment was completed and the amount is now available in the destination account.
error
The payment encountered an error during processing. The reasons a payment might be set to error include non-sufficient funds, suspected fraud, or failed validation.
expires_at date When the P2P expires, set to 10 minutes after object creation.
failed_commits number Count of failed commit attempts. Once a P2P has failed 3 times, it instantly expires.
user_data object User defined data that can be attached to the object. See the User Data section for details.