Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Intents

View an Intent

Retrieve the declaration of a transaction processed by a third-party PSP

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

Path parameters

ClientIdstring required

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

IntentIdstring required

The unique identifier of the Intent.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Response

Success

Idstring

The unique identifier of the intent.

Amountinteger

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

AvailableAmountToSplitinteger

The remaining amount of the Intent that can be split and transferred to the sellers' wallets.

UnfundedAmountinteger

The amount needing to be settled to the Platform's technical wallet before the Intent Splits can be executed.

Currencystring

The currency of the intent.

PlatformFeesAmountinteger

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.

Statusstring

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

The possible next actions on the intent.

CreationDateinteger

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

ExecutionDateinteger

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

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

SettlementIdsstring[]

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