Intents

List all Intent Splits

Changed on

Retrieve a paginated list of splits across all intents, with optional filters for provider, currency, date range, and status.

get/v3.0/{ClientId}/payins/intents/splits

Request

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

Path parameters

ClientIdstring required

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

Query parameters

BeforeDateinteger

The date before which the object was created (based on the object's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDateinteger

The date after which the object was created (based on the object's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Statusstring

Allowed values: CREATED, PENDING_FUNDS_RECEPTION, AVAILABLE, PENDING, COMPLETED, REJECTED, FAILED, REVERSED, REFUND_SPLIT_PENDING, REFUND_SPLIT_REJECTED, REFUND_SPLIT_COMPLETED

The status of the Split. You can filter on multiple values by separating them with a comma.

ExternalProviderNamestring

The third-party PSP name of the parent intent to filter by.

Currencystring

The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> of the currency to filter by.

pageinteger

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageinteger

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

Response

Success

Idstring

The unique identifier of the Split.

IntentIdstring

The unique identifier of the parent Intent.

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 wallet.

FeesAmountinteger

The amount of fees.

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.

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 list_intent_splits removed and replaced with intents_list_intent_splits