Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Carry1st Refunds API

Request refunds against processed transactions.

Carry1st Refunds API is one of 4 APIs that Carry1st publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against 2 base URLs: https://api-gateway.carry1st.com, https://api-gateway.platform.stage.carry1st.com.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api-gateway.carry1st.com
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

Carry1st Refunds API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as AccessToken (accessToken).

  • basicAuth — Base64(APIKEY:APISECRET) used only on the auth/token and auth/refresh endpoints.
  • accessToken — Bearer issued by generateAccessToken; required on all Gateway API requests.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Refunds 1

Request refunds against processed transactions.

POST
/api/pay1st/transactions/refunds/create
Refund Request
createRefundRequest 2 params body → 201400401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are RefundResponse (12 properties), RefundRequest (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

RefundRequest
object
5 properties 1 required
Error
object
Standard Pay1st error envelope.
3 properties
RefundResponse
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

carry1st-refunds-api-openapi.yml Raw ↑

Other APIs Carry1st publishes across the network.

Carry1st Authentication API
Carry1st Payment Methods API
Carry1st Payments API