Create a P2P transfer

Description


Create an internal transfer (also known as P2P). The transfer applies a debit on the account provided in the Url, and credits the account entered as beneficiary.

This endpoint is used to transfer money between 2 accounts (fees, debt, installment of n-times payment…)

Prerequisite

Accounts must be part of the same Partner
The account availableBalance should be sufficient


Disable limits check

Creating a transfer with the CheckLimits parameter set to false allows you to override the limits (weekly, monthly, annual) of the sender and the recipient. Therefore, this value should only be set to true for funds where beneficiary account is owned by Partner.



Automatically generate unpaids

Creating a transfer with the ProcessUnpaid parameter set to true allows you to override the sender availableBalance. In this case, another transfer is automatically created to cover for the missing amount. The sender account is the partner Profit&Loss, so use this parameter wisely!


Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

User identifier of partner

Body Params

Create P2P request

int64
required

Payment amount (in cents)

ParameterTypeFormatExampleDescription
AmountLongN(19)2350Payment amount(in cents)
sender
object

Account model

beneficiary
object
required

Account model

string | null

Payment message

Payment message
ParameterTypeFormatExampleDescription
MessageStringX(140)Transfer Xpollens of 12th August 2021Payment message
string
required
length ≥ 1

Payment identifier in the third-party application and specified by the partner

ParameterTypeFormatExampleDescription
OrderIdStringX(255)P2P-1Payment identifier in the third-party application
boolean | null

Check limits - Use to bypass the check on the user limits

string | null

Tag - Use to put extra data

string | null

Label - Use to put extra data

string | null

SubLabel - Use to put extra data

boolean | null

Process unpaid if User have not enough balance to proceed the P2P

fee
object
Headers
string
Defaults to da397e2d-1a65-4b56-a2f0-1a8e50653fda

Correlation Id

string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json