Overview
The Transfer object allows the fund transfers between walletId accounts of the platform. This service is only accessible from an account with platform rights.
It gives the possibility to distribute the funds received from a "platform" account that initiates transactions from the API to a connected "Basic" account, according to business rules specific to the agent.
The transfers are made in this configuration, at the initiative of the platform either directly in addition to an existing transaction or WireTransfer, or manually independently of any action. This asynchronous mode is reserved for payment service Agents.
Fees can be applied and displayed. On each operation so that they are displayed on the recipient's statement of account. These fees decrease the gross amount and get injected in the calculation of the net amount.
Funds from transfers resulting from a Credit Card Transaction (Visa or Mastercard) are available on D + 2.
Example 1:
Amount = 100
Fee = 30
The destination account holder shall receive 70 and will be charged of 30 fees on a gross amount of 100.
Example 2:
Amount = 70
Fee = 0
The destination account holder shall receive 70 without fees explainations.
Platform account View that initiates transactions and transfers objects
Customer basic account View that does not access transactions but can consult transfers objects
Transfer types
1Manual Asynchronous Mode (only available for agents)
The "platform" account carries out the transaction on behalf of one or more beneficiaries, then during a second stage makes POST-/transfer actions to pay the funds on the dedicated accounts. The asynchronous mode is then triggered after the transaction as a BATCH.
Example:
Post Transaction -> In the currency of the post transfer authorization (once per account)-> in settlement currency (payout).
Check the balance available when you make a transfer because you can only transfer funds actually available.
2Auto Synchronous Mode
The "platform" account carries out a transaction by indicating, with new parameters, the dedicated accounts and their respective parts in order to automatically trigger POST/transfer actions on the agreed date. The amounts to be reversed are indicated in the transaction and therefore calculated by the initiator.
Example:
POST transaction (mt1 for ss-marchand1, mt2 for ss-marchand2…) -> in settlement currency (payout)
Example:
transfer[] = { "destinationWalletId": "89fe34c9-5731-44bf-8451787e9ad8a72a", "amount": 100 }
transfer[] = { "destinationWalletId": "fe385c40-bbe7-4aec-ae5b0a832241eb73", "amount": 40, "fee": 5 }
Integrate the CentralPay service fees (Interchange ++) into the fees calculation. You can only transfer a net amount that has enough money to settle our expenses.
Feasible Operations
It is possible to realize automatic transfers when they are associated to transactions or WireTransfer objects. It is therefore possible, for example, to make a single authorization (transaction with capture = 0) and to initiate a transfer up to 7 days after when the transaction status turns to capture = 1
To perform this operation it is necessary to link together the initial operational source carried out and thus to specify the sourceType and sourceId attributes.
http://ref-api.centralpay.net/plateform#182-create-a-transfer
sourceId String (36) |
Identifier of the transfer source Required: no Validation: Authorized for merchant |
sourceType String |
Currency Required: yes (if the HTTP parameter sourceId is set) Values: TRANSACTION |
transferReversal
This feature allows you to recall funds that you previously paid on a wallet.
This feature will be useful in case of an error or if you have issued a refund from a transaction. Indeed, in this case, the funds are withdrawn from your wallet and you will have to pull them off in your turn on the wallet of your client.
Charges may be incurred on this operation by using refundFee.
The achievable amount in a transferReversal equate to the sum of your available and pending. This allows you to make a transferReversal before the funds releasing date.