Intents

Execute an Intent Split

Changed on

Release the funds of a Split to the wallet of the seller of the Intent line item.

Once the Intent funds have been settled (in a Settlement) and the funds have been received on the platform's technical wallet, the Split status becomes AVAILABLE, meaning you can use this endpoint to execute the transfer of funds to the Seller's wallet.

post/v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}/execute

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v3.0/{ClientId}/payins/intents/{IntentId}/splits/{SplitId}/execute
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

IntentIdstring required

The unique identifier of the Intent.

SplitIdstring required

The unique identifier of the Split.

Response

Success

Idstring

The unique identifier of the Split.

LineItemIdstring

The unique identifier of the line item.

SellerIdstring

The unique identifier of the seller of the line item.

WalletIdstring

The unique identifier of the wallet to credit the seller's funds.

SplitAmountinteger

The amount to transfer to the seller's WalledId.

The sum of the SplitAmount values of all Splits must be lower than or equal to the AvailableAmountToSplit of the Intent.

FeesAmountinteger

The amount of fees.

The sum of the FeesAmount values of all Splits must be lower than or equal to the PlatformFeesAmount of the Intent.

TransferDateinteger

The future date when the funds are to be automatically transferred to the seller's wallet.

Descriptionstring

The description of the Split.

Statusstring

The status of the Split:

  • CREATED – The Split was successfully declared via the API but it is not yet confirmed whether the funds for the parent Intent are available.
  • PENDING_FUNDS_RECEPTION – The Split is linked to an Intent that has been reconciled with a settlement file. The system is waiting for the funds to be confirmed in the technical wallet.
  • AVAILABLE – The funds for the parent Intent have been received and confirmed. The Split is ready to be executed.
  • PENDING – The Split execution has been initiated and is being processed.
  • COMPLETED – The transfer was successful and the funds have been moved to the seller's wallet.
  • REJECTED – The Split execution failed immediately due to a synchronous error (e.g. invalid wallet ID). The platform can retry execution or reverse the Split.
  • FAILED – The Split execution was initiated but the transfer failed due to an asynchronous error (e.g. insufficient funds in the source wallet). A new Split must be created to retry.
  • REVERSED – The Split was canceled by the platform while in AVAILABLE or REJECTED status.
  • REFUND_SPLIT_PENDING – A refund has been declared on the parent Intent and the refund of this Split is pending.
  • REFUND_SPLIT_REJECTED – The refund of this Split was rejected.
  • REFUND_SPLIT_COMPLETED – The refund of this Split was completed successfully.
Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id execute_intent_split removed and replaced with intents_execute_intent_split