Centrapay Payment Requests API
The payment-requests API from Centrapay — 16 operation(s) for payment-requests.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/centrapay:centrapay-payment-requests-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Centrapay Payment Requests API
version: 1.0.0
x-page:
title: Payment Requests
description: Payment request models and related endpoints
nav:
path: Payment Requests
order: 1
intro: 'Payment Requests represent the intention for a merchant to receive payment for goods and services. Payment Requests define the amount to be paid and the Asset Types that are acceptable for payment.
A Payment Request is shared with, and paid by, a patron. The [Payment Flows Guide](/guides/payment-flows/) has more details regarding negotiation of Payment Requests.
Payment Requests have the following statuses:
- `new`: after being created.
- `paid`: after being paid with one or more transactions.
- `cancelled`: after being cancelled or voided by the merchant.
- `expired`: after expiry time is reached without being paid or cancelled.
Payment requests can also be refunded for a short period of time after being paid.
Payment request state transitions can be notified to webhooks.
'
models:
- payment-request
- payment-option
- accepted-collections
- payment-condition
- line-item
- product-classification
- paid-by
- asset-totals
- payment-activity
- strategy
extras:
- title: Payment Activity Types
depth: 3
body: '| Name | Description |
| ----------------- | ----------------------------------------------------------------------------------------------------------- |
| request | [Payment Request](#payment-request-model) was created. |
| preAuthRequest | [Payment Request](#payment-request-model) was created with the `preAuth` flag set to "true". |
| paid | [Payment Request](#payment-request-model) was paid. |
| payment | A payment was made towards the [Payment Request](#payment-request-model). |
| refund | Funds were returned to the shopper. |
| cancellation | [Payment Request](#payment-request-model) was cancelled by the merchant or the shopper. |
| expiry | [Payment Request](#payment-request-model) wasn''t paid before time out. |
| accept-condition | A [Payment Condition](#payment-condition-model) was accepted. |
| decline-condition | A [Payment Condition](#payment-condition-model) was declined. |
| authorization | A Pre Auth [Payment Request](#payment-request-model) was approved and confirmations can be made against it. |
| confirmation | Funds on a Pre Auth have been drawn down on. |
| release | Pre Auth has been finalised and any remaining funds from Authorization have been returned. |
'
- title: Cancellation Reasons
depth: 2
body: '| Reason | Description |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CANCELLED_BY_MERCHANT | The merchant cancelled the Payment Request by calling the cancel or void endpoint. |
| CANCELLED_BY_PATRON | The patron cancelled the transaction. |
| PATRON_CODE_INVALID | The patron code on the Payment Request was invalid. |
| PAYMENT_FAILED | The Payment Request failed for an unknown reason. |
| PATRON_CODE_EXPIRED | The patron code on the Payment Request has expired. |
| DECLINED_BY_PATRON | The payment was declined by the patron during approval steps. |
| DECLINED_BY_MERCHANT | The payment was declined by the merchant during approval steps. |
| PAYMENT_DECLINED | The payment parameters were valid but payment was declined because additional payment restrictions were violated. For example, asset not active, asset overdrawn, quota exceeded or line item category restrictions. |
| PAYMENT_REQUEST_EXPIRED | The Payment Request has expired. |
| NO_AVAILABLE_PAYMENT_OPTIONS | No payment options match the requested payment parameters. |
| INACTIVE_ASSET | The asset used to pay the Payment Request is inactive. |
'
servers:
- url: https://service.centrapay.com
description: Centrapay production API (host taken from the curl examples on https://docs.centrapay.com/api/payment-requests; the source spec declares no servers[])
tags:
# --- truncated at 32 KB (306 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/centrapay/refs/heads/main/openapi/centrapay-payment-requests-api-openapi.yml