Create SCT Out

Description


This endpoint is used to create a bank transfer. The Xpollens account holder can send money, if his balance allows it, from his Xpollens account to an external beneficiary bank account. If fees must be attached to this transaction, P2P feature has to be used in a distinct workflow.



Prerequisite


To deal with this endpoint :

  • The beneficiary bank account must first be registered.
  • Beneficiary account status should be one of following status : Activated = 1, Initialized = 10.
  • In order to perform the customer Strong Customer Authentication (mandatory and only for Agent partners), you must use this endpoint:
    Post /api/sca/v1.1/users/{appuserid}/sct
    or Post /api/sca/v1.1/sct
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
string
required
length ≥ 1

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

ParameterTypeFormatExampleDescription
OrderIdStringX(255)Moneyout-1Payment identifier in the third-party application
accountId
object

Account model

bankAccount
object
int64
required

Payment amount (in cents)

ParameterTypeFormatExampleDescription
AmountLongN(19)2350Payment amount(in cents)
fee
object
date-time
required

Execution date of the payment

Desired Execution date (must be in Paris local time and >= currentDate). This parameter is linked to the “Planned” parameter below.If the execution date is in the future, the planned parameter must be set up at “True”
ParameterTypeFormatExampleDescription
ExecutionDateDateD(YYYY-MM-DDTHH:mm:ss)2017-09-30T22:00:00Execution date of the payment
string | null

Payment message

Payment message
ParameterTypeFormatExampleDescription
MessageStringX(140)Transfer Xpollens of 12th August 2021Payment message
string | null

Thirdparty-reference

Thirdparty-reference
ParameterTypeFormatExampleDescription
ReferenceStringX(255)REF123456Thirdparty-reference
string | null

Transfer Label. Will show up of the counterpart account statement

Transfer Label. Will show up of the counterpart account statement
ParameterTypeFormatExampleDescription
MotifStringX(255)Transfer XpollensTransfer Label. Will show up of the counterpart account statement
boolean

This parameter is a Boolean to drive the planned operation

This Boolean drives the planned operation. If true, the execution Date of the next occurrence must be in the future. If false, the execution is the current date and the SCT is issued immediately
ParameterTypeFormatExampleDescription
PlannedBoolX(255)trueBoolean to drive the planned operation
recurrent
object
Headers
string
Defaults to 4e52e1ac-be0b-441b-8cde-b7437c8bcb3f

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