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

Xfers Charge API

API for Charges

Xfers Charge API is one of 20 APIs that Xfers publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 3.

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

6 operations 5 paths 1 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3
Base URL
https://www.xfers.io/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Xfers Charge API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-XFERS-USER-API-KEY (X-XFERS-USER-API-KEY).

  • X-XFERS-USER-API-KEY — You can retrieve this by using [gettoken API](../sg/api/cutting-edgeoperation/getToken)

Paths & Operations 6

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

Charge 6

API for Charges

POST
/v3/charges
Create Charge
createCharge body → 2004XX
GET
/v3/charges
List all Charge
listCharge → 2004XX
POST
/v3/charges/{id}/authorize
Authorize Charge
authorizeCharge 1 param body → 2004XX
POST
/v3/charges/{id}/cancel
Cancel Charge
cancelCharge 1 param → 2004XX
GET
/v3/charges/{id}
Get Charge
getCharge 1 param → 2004XX
POST
/v3/charges/{id}/refunds
Refund Charge
refundCharge 2 params → 2004XX

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is error_response (3 properties). Each schema is shown below with its type and property counts.

error_response
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xfers-charge-api-openapi.yml Raw ↑

Other APIs Xfers publishes across the network.

Xfers Bank Account API
Xfers Convenience Store Transfers API
Xfers cutting_edge API
Xfers Direct Bank Transfer Payments API
Xfers Disbursements API
Xfers E-signature API
Xfers Fixed Virtual Account Bank Transfers API
Xfers Intents API
Xfers Loans API
Xfers Modify Payments API
Xfers Payment Queries API
Xfers Payment Queries (Hide first) API