EchoIntents

The Intent object

The Intent object represents the declaration of a payment authorization made via a third-party PSP.

Read more about Mangopay Echo →

Attributes

IdstringOptional
The unique identifier of the intent.
AmountintegerOptional

The full amount authorized in the Intent, which must equal the sum of the total amounts of all LineItems.

AvailableAmountToSplitintegerOptional
The remaining amount of the Intent that can be split and transferred to the sellers' wallets.
UnfundedAmountintegerOptional
The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed.
CurrencystringOptional
The currency of the intent.
PlatformFeesAmountintegerOptional

The amount of fees to be diverted to the platform's Fees Wallet when the Intent is split. This value can be overridden when the Split is created.

The PlatformFeesAmount value must the sum of all line item Seller.FeesAmount values.

StatusstringOptional

The status of the Intent, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent Status may differ from the Status of Intent LineItems.

Intent Status values:

  • AUTHORIZED – The Intent Amount was authorized for acquisition by the PSP and can be captured or canceled.
  • PARTIALLY_CAPTURED – Part of the Intent Amount from one or more LineItems was captured. The other parts are either still available for capture or cancel.
  • CAPTURED – All of the Intent Amount was captured. Part of it may have been subsequently refunded or disputed.
  • CANCELLED – All of the Intent Amount was canceled.
  • REFUNDED – All of the CapturedAmount of all LineItems was refunded.
  • REFUND_REVERSED – The refund could not be completed and the funds were returned to the platform.
  • DISPUTED – All of the CapturedAmount of all LineItems was disputed.
  • DEFENDED – The dispute is being defended by the platform.
  • DISPUTED_WON – The dispute was resolved in favor of the platform.
  • DISPUTED_LOST – The dispute was resolved against the platform.
NextActionsstringOptional
The possible next actions on the intent.
ExternalDataobjectOptional

Information about the transaction authorization processed by the third-party PSP.

BuyerobjectOptional
Information about the buyer.
LineItemslist of objectsOptional

Information about the items purchased in the transaction. A maximum of 100 line items can be created per Intent.

The sum of all line item amounts must equal the Intent Amount value. The total for each line items is calculated as ((UnitAmount x Quantity) - DiscountAmount), which is shown in the TotalLineItemAmount returned. The TaxAmount is indicative and included in the UnitAmount.

The sum of all line item Seller.FeesAmount values must equal the Intent PlatformFeesAmount value.

Captureslist of objectsOptional
Information about the amounts captured against the Intent.
Refundslist of objectsOptional
Information about the Refunds created against the Intent.
Disputeslist of objectsOptional
Information about the Disputes created against against the Intent.
Cancelslist of objectsOptional
Information about the amounts Canceled in the Intent.
Splitslist of objectsOptional
Information about the Splits created against the Intent.
CreationDateintegerOptional

Unix timestamp (UTC) of the date and time the object was created.

ExecutionDateintegerOptional

Unix timestamp (UTC) of the date and time the Intent moved to AUTHORIZED.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

SettlementIdslist of stringsOptional

The unique identifier of the Settlement(s) linked to this Intent, if successfully created by uploading a settlement file to POST Create a Settlement.