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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ConnexPay

ConnexPay Payment Instruction API

Controller for handling Payment Instructions.

Documentation Provider Profile APIs.io OpenAPI GitHub

ConnexPay Payment Instruction API is one of 39 APIs that ConnexPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PaymentInstruction. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 4 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://sandbox.api.connexpay.com/valet/payment/v1.

4 operations 4 paths 21 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://salesapi.connexpay.com
Authentication
API Key
Contact
Payment Valet
Resource Areas
1

Authentication & Security 1

ConnexPay Payment Instruction API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Key (ApiKey). By default, every request must be authenticated.

  • ApiKey — API Key required for access

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

PaymentInstruction 4

Controller for handling Payment Instructions.

POST
/instruction/client/{clientId}
Submit a Payment Instruction
CreatePaymentInstruction 1 param body → 200400403409415422default
GET
/instruction/client/{clientId}/clientPaymentId/{clientPaymentId}/fundingStatus
Get Funding Status
GetFundingStatus 2 params → 200400403404
GET
/instruction/client/{clientId}/clientPaymentId/{clientPaymentId}/paymentStatus
Get Payment Status
GetPaymentStatus 2 params → 200400403404default
POST
/instruction/client/{clientId}/clientPaymentId/{clientPaymentId}/void
Void a Payment Instruction
VoidPaymentInstruction 2 params body → 2004XX

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PaymentInstructionRequest (14 properties), PayeeContactCreate (7 properties), PayeeAddressCreate (7 properties), PayeeCreate (6 properties). Each schema is shown below with its type and property counts.

ContactType
string
Specifies the preferred contact method available for a payee. Valid options are 'Email', 'Fax', or 'Phone'.
PaymentStatus
string
Description of the Payment Status. Refer to your Payment Valet team for additional details.
PaymentItem
object
Details of the individual items in the payment instruction.
3 properties 2 required
PayeeAddressCreate
object
7 properties 4 required
PaymentInstructionResponseResult
object
4 properties
ValidationProblemDetails
object
Validation error details.
6 properties
ModalityType
string
Specifies the payment modality or method. The only valid option at this time is 'Card'.
StatusCodeResult
object
Status code of the response.
1 property
PayeeCreate
object
6 properties 3 required
PaymentInstructionRequest
object
14 properties 6 required
DistributionType
string
Specifies the preferred method by which the payment is delivered. Valid options at this time are 'Email' and 'Mail'.
StatusType
string
Result
object
3 properties
PaymentInstructionResponse
object
3 properties
PayeeType
string
Defines if the payee is a business or consumer. Valid options are 'Business' or 'Consumer'.
ClientDocuments
object
4 properties 1 required
RequestStatusUpdate
object
3 properties
PayeeContactCreate
object
7 properties 4 required
ProblemDetails
object
5 properties
PaymentItemType
string
Describes the type of the item in the payment breakdown. Required if ItemID or Amount are provided and valid options are 'Claim' and 'Invoice'.
PaymentRestrictions
object
Used to enforce or exclude specific payment modalities for the payment instruction.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

connexpay-paymentinstruction-api-openapi.yml Raw ↑

Other APIs ConnexPay publishes across the network.

ConnexPay 3ds API
AE Profile APIs.io
ConnexPay 3 D Secure API
AE Profile APIs.io
ConnexPay Accounting API
AE Profile APIs.io
ConnexPay Addendum API
AE Profile APIs.io
ConnexPay Authenticate API
AE Profile APIs.io
ConnexPay Authonlys API
AE Profile APIs.io
ConnexPay Cancel API
AE Profile APIs.io
ConnexPay Captures API
AE Profile APIs.io
ConnexPay Card Booking API
AE Profile APIs.io
ConnexPay Cards API
AE Profile APIs.io
ConnexPay Chargeback API
AE Profile APIs.io
ConnexPay Checkout Sessions API
AE Profile APIs.io
#PaymentInstruction
← Back to C APIs
API Details
ID
connexpay:connexpay-paymentinstruction-api
Base URL
https://salesapi.connexpay.com
Docs
https://docs.connexpay.com/reference/getting-started-with-your-api
Provider
ConnexPay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=connexpay-paymentinstruction-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/connexpay-paymentinstruction-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ConnexPay Payment Instruction 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.