Create an Intent Split

Create a transfer to the wallet of the seller of an Intent line item.

POST /v3.0/{ClientId}/payins/intents/{IntentId}/splits

{
    "Splits" : [
        {
            "LineItemId" : "int_li_019778b4-7e87-7153-8fa0-746b23ecae7d",
            "SplitAmount" : 8000,
            "FeesAmount" : 0,
            "TransferDate" : 1742428800,
            "Description" : "Example description of the Split"
        },
        {
            "LineItemId" : "int_li_019778b4-7e87-7153-8fa0-746b23ecae7e",
            "SplitAmount" : 2500,
            "FeesAmount" : 0,
            "TransferDate" : 1742428800,
            "Description" : "Example description of the Split"
        }
    ]       
}

{
    "Splits": [
        {
            "Id": "int_split_019778c4-29c7-7c62-b7c6-775b744ab9f1",
            "LineItemId": "int_li_019778b4-7e87-7153-8fa0-746b23ecae7d",
            "SellerId": "user_m_01JXWB4GBKZYXHJX197M90JHYV",
            "WalletId": "wlt_m_01JXWB5K56PT3J0HJ8Z9YHCYFR",
            "SplitAmount": 8000,
            "FeesAmount": 0,
            "TransferDate": 1742428800,
            "Description": "Example description of the Split",
            "Status": "CREATED"
        },
        {
            "Id": "int_split_019778c4-29c7-7c62-b7c6-775b744ab9f2",
            "LineItemId": "int_li_019778b4-7e87-7153-8fa0-746b23ecae7e",
            "SellerId": "user_m_01JXWB53KC8ZZFQNC6S34W9CN0",
            "WalletId": "wlt_m_01JXWB5WF962GM9N4GC3VJVK8K",
            "SplitAmount": 2500,
            "FeesAmount": 0,
            "TransferDate": 1742428800,
            "Description": "Example description of the Split",
            "Status": "CREATED"
        }
    ]
}

Once the Intent is PARTIALLY_CAPTURED or CAPTURED, you can create Splits to set up the transfers to the seller wallet(s).

Path parameters

IntentId · string · required

The unique identifier of the Intent.

Body parameters

Splits · array (object)

The future Splits to create to transfer Intent funds to the line item sellers.

Show child attributes

LineItemId · string · required

The unique identifier of the line item.

SplitAmount · type · required

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.

FeesAmount · string

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.

TransferDate · Unix timestamp

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

Description · string

The description of the Split.

SplitOriginWalletId · string

The unique identifier of the wallet from which the split will be debited.

This parameter is required for Intents where ExternalProviderName is Mangopay. If it is not defined in the Intent it must be defined at Split creation.

Responses

200 - Response parameters

Splits · array (object)

The Splits requested.

Show child attributes

Id · string

The unique identifier of the Split.

LineItemId · string

The unique identifier of the line item.

SellerId · string

The unique identifier of the seller of the line item.

WalletId · string

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

SplitAmount · type

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.

FeesAmount · string

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.

TransferDate · Unix timestamp

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

Description · string

The description of the Split.

Status · string

The status of the Split:

• CREATED
• PENDING_FUNDS_RECEPTION
• AVAILABLE
• PENDING
• COMPLETED
• REJECTED
• FAILED
• REVERSED
• REFUND_SPLIT_PENDING
• REFUND_SPLIT_REJECTED
• REFUND_SPLIT_COMPLETED

SplitOriginWalletId · string

The unique identifier of the wallet from which the split will be debited.

This parameter is required for Intents where ExternalProviderName is Mangopay. If it is not defined in the Intent it must be defined at Split creation.

400 - Intent must be CAPTURED or PARTIALLY_CAPTURED

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Id": "fbb4a0c1-4788-404b-85c3-fcdcfc27ed4f",
    "Date": 1770047721,
    "Type": "param_error",
    "Errors": {
        "Status": "Cannot create split: intent must be in CAPTURED or PARTIALLY_CAPTURED state."
    }
}

400 - SplitOriginWalletId for Mangopay ExternalProviderName

In a hybrid flow, if the SplitOriginWalletId for Intents where ExternalProviderName is Mangopay is not provided in the Intent, it must be provided in the Split or else the following error is returned:

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Id": "da9d9f6e-6469-44c1-9ed7-231d6a3fe1d1",
    "Date": 1770909760,
    "Type": "param_error",
    "Errors": {
        "Split[0].SplitOriginWalletId": "The field is required."
    }
}

{
    "Splits": [
        {
            "Id": "int_split_019778c4-29c7-7c62-b7c6-775b744ab9f1",
            "LineItemId": "int_li_019778b4-7e87-7153-8fa0-746b23ecae7d",
            "SellerId": "user_m_01JXWB4GBKZYXHJX197M90JHYV",
            "WalletId": "wlt_m_01JXWB5K56PT3J0HJ8Z9YHCYFR",
            "SplitAmount": 8000,
            "FeesAmount": 0,
            "TransferDate": 1742428800,
            "Description": "Example description of the Split",
            "Status": "CREATED"
        },
        {
            "Id": "int_split_019778c4-29c7-7c62-b7c6-775b744ab9f2",
            "LineItemId": "int_li_019778b4-7e87-7153-8fa0-746b23ecae7e",
            "SellerId": "user_m_01JXWB53KC8ZZFQNC6S34W9CN0",
            "WalletId": "wlt_m_01JXWB5WF962GM9N4GC3VJVK8K",
            "SplitAmount": 2500,
            "FeesAmount": 0,
            "TransferDate": 1742428800,
            "Description": "Example description of the Split",
            "Status": "CREATED"
        }
    ]
}

{
    "Splits" : [
        {
            "LineItemId" : "int_li_019778b4-7e87-7153-8fa0-746b23ecae7d",
            "SplitAmount" : 8000,
            "FeesAmount" : 0,
            "TransferDate" : 1742428800,
            "Description" : "Example description of the Split"
        },
        {
            "LineItemId" : "int_li_019778b4-7e87-7153-8fa0-746b23ecae7e",
            "SplitAmount" : 2500,
            "FeesAmount" : 0,
            "TransferDate" : 1742428800,
            "Description" : "Example description of the Split"
        }
    ]       
}