Skip to navigation
EchoIntents

List all Intents

Retrieve a paginated list of Intents, with optional filters for provider, currency, date range, and status.

Authentication

AuthorizationBearer

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.

Path parameters

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

Query parameters

BeforeDateintegerOptional

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.

AfterDateintegerOptional

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.

StatusstringOptional

Allowed values: AUTHORIZED, CAPTURED, PARTIALLY_CAPTURED, REFUNDED, REFUND_REVERSED, DISPUTED, DISPUTED_WON, DISPUTED_LOST, DEFENDED, CANCELLED

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

ExternalProviderNamestringOptional

The third-party PSP name to filter by.

CurrencystringOptional

The three-letter ISO 4217 code of the currency to filter by.

pageintegerOptional

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageintegerOptional

Min. value: 1; max. value: 100

Default value: 10

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

Response

Success
IdstringOptional
The unique identifier of the intent.
AmountintegerOptional
The full amount authorized in the Intent.
CurrencystringOptional
The currency of the intent.
StatusstringOptional

The status of the Intent.

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.
  • CAPTURED – All of the Intent Amount was captured.
  • 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.
ExternalDataobjectOptional
CreationDateintegerOptional
The date and time the Intent was created.
ExecutionDateinteger or nullOptional

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