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

Lead Bank Instant Payments API

The Instant Payments API from Lead Bank — 7 operation(s) for instant payments.

Lead Bank Instant Payments API is one of 22 APIs that Lead Bank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Instant Payments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 7 paths, and defines 27 schemas. It is described by OpenAPI 3.0.1, at version v1.0.

Requests are made against 2 base URLs: https://api.sandbox.lead.bank, https://api.lead.bank.

8 operations 7 paths 27 schemas 2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1.0
Base URL
gated-partner-access
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Lead Bank Instant Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 8

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

Instant Payments 8
POST
/v1/instant_payments
Create an instant payment
create-an-instant-payment 1 param body → 200400403422500
GET
/v1/instant_payments
List all instant payments
list-all-instant-payments 10 params → 200403422500
GET
/v1/instant_payments/{instant_payment_id}
Retrieve an instant payment
retrieve-an-instant-payment 1 param → 200403404500
POST
/v1/instant_payments/{instant_payment_id}/return
Return an instant payment
return-an-instant-payment 2 params body → 200400403404422500
POST
/v1/instant_payments/{instant_payment_id}/cancel
Cancel an instant payment
cancel-an-instant-payment 1 param → 200400404422500
POST
/v1/instant_payments/{instant_payment_id}/request_return
Request return for an instant payment
request-return-for-instant-payment 2 params body → 200400403404409422500
POST
/v1/instant_payments/{instant_payment_id}/reject_return_request
Reject return request for an instant payment
reject-return-request-for-instant-payment 1 param body → 200400403404422500
POST
/v1/instant_payments/check_availability
Check instant payment availability
check-instant-payment-availability body → 200400422500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are InstantPayment (20 properties), InstantPaymentReturnRequest (6 properties), APIError (6 properties), InstantPaymentReturnRequestResolution (4 properties). Each schema is shown below with its type and property counts.

AccountNumberID
string
The ID of the Lead Bank Account Number object.
IncomingInstantPaymentReturnRequestReason
string
The reason for the return request. creditoraccountnumberinvalid - Invalid creditor account number wrongamount - Wrong amount customerrequested - Requested by c…
InstantPaymentReturnRequestResolution
object
The resolution details of the return request.
4 properties 2 required
OutgoingInstantPaymentReturnRequestRejectionReason
string
The reason for rejecting an incoming return request. accountclosed - Account closed nonsufficientfunds - Insufficient funds customerrequested - Customer decisi…
InstantPaymentReturnRequestStatus
string
The current status of the return request object. For incoming return requests: responseneeded, accepted, rejected. For outgoing return requests: pending, accep…
APIError
object
6 properties
InstantPaymentRejectionReason
string
The reason for the rejection. accountclosed - Closed creditor account creditoraccountnumberinvalid - Invalid creditor account number accountblocked - Blocked a…
InstantPayment
object
20 properties 16 required
InstantPaymentParty
object
Details of a party in an instant payment.
2 properties 2 required
IncomingInstantPaymentReturnRequestRejectionReason
string
The reason for a rejected return request. accountclosed - Account closed nonsufficientfunds - Insufficient funds customerrequested - Customer decision legaldec…
InstantPaymentRelatedObjects
object
This instant payment's related instant payments or other objects.
2 properties
InstantPaymentRejection
object
If this instant payment was rejected, this object contains details on the rejection.
3 properties 2 required
OutgoingInstantPaymentReturnReason
string
The reason for initiating an return. honorreturnrequest - Honoring a return request wrongamount - Wrong amount duplication - Duplicate payment initiatingpartyu…
InstantPaymentAmount
integer
The amount of the instant payment in cents.
CurrencyCode
string
A three-letter currency code as defined in ISO 4217.
Direction
string
Who is initiating the transaction. outgoing: You are sending a transaction to a counterparty. incoming: You are receiving a transaction from a counterparty.
InstantPaymentReturnDetails
object
If this instant payment is a return, this object contains details on the return.
2 properties 1 required
InstantPaymentIdentifiers
object
The instant payment's identifiers.
3 properties
AccountID
string
The ID of the Account object.
InstantPaymentReturnRequest
object
A return request associated with an instant payment.
6 properties 3 required
IncomingInstantPaymentReturnReason
string
The reason for a return. honorreturnrequest - Honoring a return request wrongamount - Wrong amount duplication - Duplicate payment initiatingpartyunrecognized…
InvalidParameterDetail
object
2 properties
InstantPaymentCounterpartyStatus
string
The current status of the instant payment from the counterparty's perspective. If outgoing: posted, underreview, or rejected. If incoming: posted or null.
InstantPaymentAvailability
object
Result of an instant payment availability check.
2 properties 2 required
InstantPaymentStatus
string
The current status of the instant payment object. If outgoing: created, underreview, canceled, rejected, posted. If incoming: underreview, rejected, posted.
InstantPaymentAgent
object
Details of a financial institution in an instant payment.
1 property 1 required
OutgoingInstantPaymentReturnRequestReason
string
The reason for initiating a return request. creditoraccountnumberinvalid - Invalid creditor account number wrongamount - Wrong amount customerrequested - Reque…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lead-bank-instant-payments-api-openapi.yml Raw ↑

Other APIs Lead Bank publishes across the network.

Lead Bank Lend API
Lead Bank Move API
Lead Bank Issue API
Lead Bank Store API
Lead Bank File Integrations (SFTP)
Lead Bank Webhooks
Lead Bank Account Number API
Lead Bank ACH API
Lead Bank Blockchain Payment API
Lead Bank Compliance API
Lead Bank Entity API
Lead Bank Events API
Where this information came from

This is an independent, third-party profile of Lead Bank Instant Payments 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.