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
BackBase

BackBase Payment Orders API

Core payments API.

Documentation Provider Profile APIs.io OpenAPI GitHub

BackBase Payment Orders API is one of 8 APIs that BackBase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Payment Orders. The published artifact set on APIs.io includes an OpenAPI specification and 12 JSON Schemas.

This API exposes 12 operations across 9 paths, and defines 59 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against 3 base URLs: http://localhost:4010, http://localhost:8080, https://localhost:8081.

12 operations 9 paths 59 schemas 1 DELETE5 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.backbase.com
Resource Areas
1

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 5 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

payment-orders 12

Core payments API.

GET
/client-api/v2/payment-orders
Retrieve list of payments orders
getPaymentOrders 21 params → 200400500403
POST
/client-api/v2/payment-orders
Start a new Payment Order initiation process
postPaymentOrders 1 param body → 201202403401500400
POST
/client-api/v2/payment-orders/validate
Validate a payment order
postValidate body → 200500400
PUT
/client-api/v2/payment-orders/bulk-approvals
Approve or reject a set of given payment orders at once
putBulkApprovals body → 200500400403
GET
/client-api/v2/payment-orders/approvals
Retrieve payment orders that can be approved or rejected by the user
getApprovablePaymentOrders 2 params → 200500400403
GET
/client-api/v2/payment-orders/{paymentOrderId}
Get payment order by id
getPaymentOrderById 3 params → 200404500400403
PUT
/client-api/v2/payment-orders/{paymentOrderId}
Updates a single payment order
putPaymentOrderById 2 params body → 201202403401500400
DELETE
/client-api/v2/payment-orders/{paymentOrderId}
Deletes a payment order if:
deletePaymentOrderById 2 params → 204500400403
PUT
/client-api/v2/payment-orders/{paymentOrderId}/approvals
Put approvals by payment order id
putApprovalsByPaymentOrderId 1 param body → 202403500400
POST
/client-api/v2/payment-orders/{paymentOrderId}/cancel
Post cancel by payment order id
postCancelByPaymentOrderId 1 param body → 200500400403404
GET
/client-api/v2/payment-orders/currencies
Get currencies
getCurrencies → 200500400
GET
/client-api/v2/payment-orders/rate
Get rate
getRate 2 params → 200500400

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are PaymentOrderGetResponse (32 properties), IdentifiedPaymentOrder (31 properties), PresentationApprovalDetailDto (18 properties), PaymentOrdersValidatePostResponse (17 properties). Each schema is shown below with its type and property counts.

AccountIdentification
object
2 properties 1 required
TimeFrame
object
3 properties 3 required
SelectedContactDto
object
Holds the contact and account id when an account from a contact was selected while creating a payment. This information is not persisted in DBS but can be used…
2 properties
currencies-get-response-body
object
Currency
1 property 1 required
CurrenciesGetResponseBody
PresentationApprovalDetailDto
object
A detailed approval object that holds extended details of a single item to be approved.
18 properties 10 required
CurrenciesGet
array
Currencies available for payment response
internal-server-error
object
Represents HTTP 500 Internal Server Error
1 property
OriginatorAccount
object
The product identification of the originator
4 properties 2 required
PaymentOrderApprovalPutRequest
object
2 properties 1 required
unauthorized-error
object
2 properties
Identification
object
2 properties 2 required
PaymentOrdersGet
array
List of Payment Orders
not-found-error
object
2 properties
InvolvedParty
object
This object is a common denominator for the debtor or creditor party.
4 properties 1 required
PresentationRecordDto
object
A single record of either an approval or rejection by a user on an approval request.
8 properties 5 required
InitiateTransaction
object
The object defining the transaction to be initiated.
14 properties 3 required
EntityDescription
object
3 properties 3 required
ErrorItem
object
A validation error
3 properties
PaymentOrdersValidatePost
object
10 properties 3 required
PresentationPolicyDto
object
This object describes how a policy is built up. It tells you what policies apply (policyItems) or if you can self-approve.
5 properties 2 required
ExchangeRateInformation
object
The detailed information on the exchange rate that has been used in the payment transaction.
4 properties
BreachReportError
object
4 properties 1 required
PolicyItemDetailsDto
object
A detailed policy item with the full approval type.
2 properties 2 required
PaymentOrdersPost
object
10 properties 3 required
InitiatePaymentOrder
object
10 properties 3 required
BadRequestError
object
2 properties 1 required
PaymentOrdersValidatePostResponse
object
17 properties 3 required
PaymentOrderPut
object
BreachInfo
object
5 properties 3 required
PaymentId
string
Unique identification of the payment order.
BulkPaymentOrdersApprovalPutRequest
object
3 properties 2 required
bad-request-error
object
2 properties 1 required
Bank
object
This object is used to identify the counterparty or correspondent bank.
4 properties
Actions
array
An array of actions that could be performed on a payment order. Actions that can be done are dependant on the payment itself.
RateGet
object
1 property 1 required
Schedule
object
Schedule for recurring transfer. Mandatory if paymentMode is RECURRING
8 properties 4 required
PresentationApprovalTypeDto
object
A simple object that represents a type of approval that can be placed on an approval.
4 properties 3 required
PaymentOrderCancelPostResponse
object
1 property 1 required
ApprovalTypeDto
object
An approval type, also known as approval level, is used to allow a hierarchy of approvals to grant to various users or groups to allow complex policies to be d…
4 properties 3 required
forbidden-error
object
2 properties
error-item
object
3 properties
ContextualInformation
object
5 properties 3 required
PaymentOrdersPostResponse
object
13 properties 2 required
RemittanceInformation
object
This is the object representation of the remittance info and can contain different types of remittance info. It is only used in responses, not for input reques…
2 properties 2 required
PresentationPolicyItemDto
object
2 properties 2 required
PaymentOrderCancelPostRequest
object
1 property 1 required
LogicalPolicyDetailsDto
object
A policy declaration that allows you to add logical operators to the contained policy items.
3 properties
IdentifiedTransaction
object
The object defining the identified transaction, which means the counterparty will have a arrangementId where applicable.
14 properties 3 required
UnauthorizedError
object
2 properties
InitiateCounterpartyAccount
object
The counterparty Account is the original account identification plus the type of account if applicable. It also holds the details of the selected contact, if a…
2 properties
PostalAddress
object
Postal address object with fields
7 properties
PaymentOrderGetResponse
object
32 properties 3 required
BulkPaymentOrdersApprovalPutResponse
object
5 properties 4 required
CounterpartyAccount
object
The counterparty Account is the original account identification plus the arrangement if applicable.
5 properties 1 required
BreachReportItem
object
5 properties 1 required
currency
object
3 properties 2 required
Currency
IdentifiedPaymentOrder
object
31 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

backbase-payment-orders-api-openapi.yml Raw ↑

Other APIs BackBase publishes across the network.

BackBase Approve API
AE Profile APIs.io
BackBase Bbt API
AE Profile APIs.io
BackBase Patch API
AE Profile APIs.io
BackBase Test API
AE Profile APIs.io
BackBase Utility API
AE Profile APIs.io
BackBase Validate API
AE Profile APIs.io
BackBase Wallet API
AE Profile APIs.io
#Payment Orders
← Back to B APIs
API Details
ID
backbase:backbase-payment-orders-api
Base URL
https://api.backbase.com
Docs
https://www.backbase.com/insight/guides
Provider
BackBase
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=backbase-payment-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/backbase-payment-orders-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 BackBase Payment Orders 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.