Create an internal transfer

Description


This endpoint allows to create an Internal Transfer.
An Internal Transfer is a money transfer between two accounts from the same partner, it can be used between two end-user accounts, two partner accounts as well as between a partner account and an end-user account to collect funds (fees, debt, n-fold payments).



Prerequisite


  • To access this endpoint, authentication is required. Credentials are to be provided in the request headers as part of the authentication process.
  • Accounts must be linked to the same partner.

CheckLimits


Creating an Internal transfer with the "checkLimits" parameter set to "false" allows to process the payment without impacting limit user or controlling account limits (weekly, monthly, annual) of both the sender and the recipient.

ProcessUnpaid


Creating an Internal transfer with the "processUnpaid" parameter set to "true" allows to process the payment even though the sender does not have the amount required on his accounts.
If applicable, then the sender's account will be credited with the missing amount from the partner "Profit and Loss" account.

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

Description

This endpoint allows to create an Internal Transfer. An Internal Transfer is a money transfer between two accounts from the same partner, it can be used between two end-user accounts, two partner accounts as well as between a partner account and an end-user account to collect funds (fees, debt, n-fold payments).


Prerequisite

  • To access this endpoint, authentication is required.
  • Credentials are to be provided in the request headers as part of the authentication process.
  • Accounts must be linked to the same partner.

CheckLimits

Creating an Internal transfer with the "checkLimits" parameter set to "false" allows to process the payment without impacting limit user or controlling account limits (weekly, monthly, annual) of both the sender and the recipient.


ProcessUnpaid

Creating an Internal transfer with the "processUnpaid" parameter set to "true" allows to process the payment even though the sender does not have the amount required on his accounts. If applicable, then the sender's account will be credited with the missing amount from the partner "Profit and Loss" account.

Body Params

Create internal transfer request

string
required
length ≥ 1

Id of the Internal Transfer. Specified by the partner.

ParameterTypeFormatExampleDescription
InternalTransferIdStringX(255)P2P_2024931940Id of the Internal Transfer. Specified by the partner.
string
required
length ≥ 1

Id of the user account / partner account (debited account).

amount
object
required
recipient
object
required

Recipient account for internal transfer

extraDatas
object
boolean | null

If true, process the Internal Transfer even though user does not have enough balance.

boolean

If false, allows Internal Transfers without impacting limit used or controlling account limits.

Headers
string
Defaults to 0a85f532-507d-49f2-b5c9-968bab358013

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