EchoIntents

Create an Intent Refund

Declare the full or partial refund of a payment processed by a third-party PSP, represented by an Intent Refund.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
IntentIdstringRequired
The unique identifier of the Intent.

Request

This endpoint expects an object.
ExternalDataobjectOptional

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

AmountintegerOptional

The amount of the Refund, required for a partial refund. The Refund Amount must equal the sum of the Amount values refunded for all line items.

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.

LineItemslist of objectsOptional
Information about the amount refunded for each line item, required for a partial refund.

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

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

Buyerobject
Information about the buyer.
LineItemslist of objects
Information about the line items included in the intent action.
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.

Refundobject
Information about the Refund.