How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ansa Merchants API

The Merchants API from Ansa — 10 operation(s) for merchants.

Ansa Merchants API is one of 7 APIs that Ansa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Merchants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 13 operations across 10 paths. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against 2 base URLs: https://api.getansa.com, https://api-sandbox.getansa.com.

13 operations 10 paths 0 schemas 6 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://api.getansa.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ansa Merchants API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (sec0). By default, every request must be authenticated.

  • sec0 — API key in the Authorization header. Keys are prefixed ansasklive/ansasksandbox (merchant secret), ansacslive/ansacssandbox (client secret).

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 6 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Merchants 13
POST
/v1/merchants/{merchantId}/calculate-settlement
Calculate settlement
calculate-settlement 1 param body → 200400500
POST
/v1/merchants/{merchantId}/campaigns
Create campaign
create-incentive 1 param body → 201400500
GET
/v1/merchants/{merchantId}/campaigns
List campaigns
list-incentive-campaigns 6 params → 200400500
POST
/v1/merchants/{merchantId}/promotional-accounts
Create promotional account
create-promotional-account 1 param body → 200400500
GET
/v1/merchants/{merchantId}/promotional-accounts
List promotional accounts
get-promotional-accounts 1 param → 200500
POST
/v1/merchants/{merchantId}/fund-promotional-account
Fund promotional account
fund-promotional-account 1 param body → 200500
POST
/v1/merchants/{merchantId}/fund-wallet-funding-hold-account
Fund wallet funding hold account
fund-wallet-hold-account 1 param body → 200402409500
GET
/v1/merchants/{merchantId}/campaigns/{campaignId}
Get campaign
get-campaign 2 params → 200500
GET
/v1/merchants/{merchantId}/balance
Get merchant balance
get-merchant-balance 1 param → 200400500
GET
/v1/merchants/{merchantId}
Get merchant
get-merchant 1 param → 200500
GET
/v1/merchants/{merchantId}/promotional-accounts/{promotionalAccountId}
Get promotional account
get-promotional-account 2 params → 200500
PUT
/v1/merchants/{merchantId}/promotional-accounts/{promotionalAccountId}
Update promotional account
update-promotional-account 2 params body → 200400500
POST
/v1/merchants/{merchantId}/request-settlement
Request settlement
request-settlement 1 param body → 200400500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ansa-merchants-api-openapi.yml Raw ↑

Other APIs Ansa publishes across the network.

Ansa Add Incentive API
Ansa Customer Segments API
Ansa Customers API
Ansa Initialize Payment Session API
Ansa Refunds API
Ansa Transactions API
Where this information came from

This is an independent, third-party profile of Ansa Merchants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.