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

Halliday Payments API

Core payment operations including quotes, confirmation, and status tracking

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

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

This API exposes 7 operations across 7 paths, and defines 43 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://v2.prod.halliday.xyz.

7 operations 7 paths 43 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://v2.prod.halliday.xyz
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Halliday Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API_KEY) (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 7

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

Payments 7

Core payment operations including quotes, confirmation, and status tracking

GET
/payments
Get payment status
getPaymentStatus 1 param → 200400401403404
GET
/payments/history
Get payment history
getPaymentHistory 7 params → 200400401403
POST
/payments/quotes
Get payment quotes
getPaymentQuotes body → 200400401403
POST
/payments/confirm
Confirm a payment
confirmPayment body → 200400401403404
POST
/payments/withdraw
Return funds to owner or retry payment
withdrawPayment body → 200400401403404
POST
/payments/withdraw/confirm
Confirm withdrawal request
withdrawPaymentConfirm body → 200400401403
POST
/payments/balances
Get wallet balances
getPaymentBalances body → 200400401403404

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are PaymentStatus (24 properties), QuoteRequest (16 properties), QuoteResponse (9 properties), AmountDownstreamIssue (8 properties). Each schema is shown below with its type and property counts.

Token
string
Token identifier in the format "chain:address"
ProviderIssue
object
2 properties 2 required
Fees
object
5 properties 5 required
Amount
string
A decimal amount string.
Limits
object
2 properties
GeolocationIssue
object
2 properties 2 required
AmountIssue
object
8 properties 7 required
QuotedEntry
object
5 properties 3 required
PaymentStatus
object
24 properties 17 required
Issue
Asset
string
Identifier in the token format ("chain:address") or fiat currency code ("USD")
PaymentBalancesResult
object
4 properties 4 required
FailureContent
object
3 properties 2 required
FulfilledEntry
object
5 properties 1 required
WithdrawPaymentRequest
object
6 properties 4 required
WithdrawPaymentAuthorizationResponse
object
4 properties 5 required
TokenAmount
object
2 properties 2 required
PieceInfo
object
1 property 1 required
AssetAmount
object
2 properties 2 required
QuotedRouteItem
object
4 properties 3 required
FulfilledRouteItem
object
6 properties 4 required
FundingIssue
object
3 properties 3 required
OwnerIssue
object
3 properties 3 required
AmountDownstreamIssue
object
8 properties 7 required
DepositInfo
object
4 properties 4 required
Quote
1 required
UserVerifyInstruction
object
3 properties 3 required
EffectAmount
object
2 properties 2 required
PaymentBalancesResponse
object
1 property 1 required
UnknownIssue
object
2 properties 2 required
Resource
object
2 properties 2 required
NextInstruction
Instruction payload that returns the funding pages if the payment requires funding.
OtherIssue
object
2 properties 2 required
OnrampOrTransferInInstruction
object
4 properties 4 required
WithdrawPaymentResponse
object
2 properties 2 required
ChangeAmount
object
4 properties 3 required
WithdrawPaymentAuthorizationRequest
object
4 properties 3 required
ErrorResponse
object
Error response for known errors
1 property 1 required
QuoteRequest
object
16 properties 2 required
RequestForPaymentBalances
object
2 properties
PayinMethodIssue
object
2 properties 2 required
QuoteResponse
object
9 properties 9 required
FixedInputQuoteRequest
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

halliday-payments-api-openapi.yml Raw ↑

Other APIs Halliday publishes across the network.

Halliday Assets API
Halliday Chains API
Halliday Webhooks API