canonical: https://jentic.com/apis/rapyd.net/rapyd

# Rapyd Payments Platform API

Jentic publishes the only available OpenAPI specification for Rapyd Payments Platform API, keeping it validated and agent-ready. The Rapyd Payments Platform API creates and lists payments, issues refunds, and generates hosted checkout pages for a currency and country, with Rapyd's description citing 900+ payment methods across 100+ countries. It also creates and retrieves customers and Rapyd e-wallets, and lists e-wallets filtered by currency or minimum balance. Write operations accept an idempotency header, and a sandbox host is available for testing.

## For AI agents

Create and cancel Rapyd payments, issue refunds, generate hosted checkout pages, and create customers and e-wallets on the Rapyd platform.

## Scope

Does not handle accounting, tax calculation, or subscription billing. Use for Rapyd payments, refunds, checkout pages, customers, and e-wallets only.

## Capabilities

- Create a payment with amount and currency, optionally against a customer, payment_method, or ewallet
- Cancel a payment while its status is ACT and the payment method is cancelable
- Refund a payment in full or in part with a reason and merchant_reference_id
- Generate a hosted checkout page for a country and currency with complete and error redirect URLs
- Create customers with contact details, addresses, and a default payment_method
- Create Rapyd e-wallets and list them by currency, ewallet_reference_id, or min_balance

## Use cases

### Agent-issued refunds through Jentic

A support agent handling a complaint can resolve it with a refund instead of a ticket hand-off. Through Jentic the agent searches for 'refund a payment', receives the Rapyd createRefund operation with its input schema, and sends the payment id with an amount and reason, while Jentic signs the request with the access_key, salt, timestamp, and signature headers at execution time. The agent can list recent refunds afterwards to confirm it went through.

Example prompt: Look up the payment with GET `/v1/payments/{paymentId}`, then call POST `/v1/refunds` with payment set to that id, amount 20, currency 'USD', and reason 'damaged item'

### Hosted checkout for cross-border sales

Merchants selling into many countries want local payment methods without building a payment form for each. Rapyd's POST `/v1/checkout` creates a hosted checkout page from a required country and currency, with an amount, cart_items, payment_method_types_include to narrow the methods offered, and complete_payment_url and error_payment_url for redirects.

Example prompt: Create a checkout page with POST `/v1/checkout` using amount 49.99, currency 'EUR', country 'DE', and complete_payment_url and error_payment_url set to the shop's pages

### Marketplace e-wallets

Marketplaces and platforms often hold funds for sellers before payout. Rapyd e-wallets are created with first_name, last_name, and type, can sit under a parent_ewallet, and are listed by currency or min_balance with page_number and page_size, while payments can be directed into one or more ewallets.

Example prompt: Create an e-wallet with POST `/v1/ewallets` for first_name 'Ana', last_name 'Silva', and type 'person', then list wallets with GET `/v1/ewallets` filtered by currency 'USD'

### Payment reporting

Finance teams reconcile payments by date range and customer. Rapyd's GET `/v1/payments` filters by created_after, created_before, customer, ewallet, group, and invoice, and GET `/v1/refunds` pages refunds with limit, starting_after, and ending_before.

Example prompt: List payments with GET `/v1/payments` using created_after and created_before for last week, then list refunds with GET `/v1/refunds` and match them to the payments

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/payments` | Create a payment |
| GET | `/v1/payments` | List payments |
| DELETE | `/v1/payments/{paymentId}` | Cancel a payment |
| POST | `/v1/refunds` | Create a refund |
| POST | `/v1/checkout` | Create a checkout page |
| POST | `/v1/customers` | Create a customer |
| POST | `/v1/ewallets` | Create an e-wallet |

## Key resources

- **Payments** — Create, list, retrieve, and cancel payments
- **Refunds** — Create and list refunds against payments
- **Checkout** — Hosted checkout page creation for a country and currency
- **Customers** — Create and retrieve customer profiles
- **E-wallets** — Create, list, and retrieve Rapyd e-wallets

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 74 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 76 / 100
- **View full report:** https://jentic.com/apis/rapyd.net/rapyd/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Rapyd by hand means computing a request signature from your access_key, secret_key, a random salt, a timestamp, the HTTP method, URL path, and body, then sending the access_key, salt, timestamp, and signature headers with an idempotency header on writes. Through Jentic you install once, import Rapyd from the API Directory, store the keys once, and your agent calls it.
- **Permission scoping:** Rapyd puts payment and wallet ids in the URL path for reads and cancels, but carries the target payment for a refund inside the request body, so rules bound which operations your agent may call. Limit it to the operations it needs, such as payment and refund reads, so createPayment, cancelPayment, and createRefund are not included unless you add them.
- **Credential handling:** Your Rapyd access_key and secret_key are stored once, encrypted, by your own Jentic One instance and used to sign each request at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'refund a payment' or 'create a checkout page', and Jentic returns the matching Rapyd operation with its input schema so the agent calls the right endpoint without reading the reference.

## Related APIs

- **Stripe** — Payments, subscriptions, and refunds for internet businesses
- **Checkout.com** — Global card and alternative payment processing platform
- **currencylayer** — Live and historical exchange rates

## FAQ

### Why is there no official OpenAPI spec for Rapyd Payments Platform API?

Rapyd does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Rapyd Payments Platform API via structured tooling. It is validated against the live API and kept up to date. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### What authentication does the Rapyd Payments Platform API use?

Per its OpenAPI spec, Rapyd uses a request signature scheme: each request carries access_key, salt, timestamp, and signature headers, where the signature is calculated from the access_key, secret_key, salt, timestamp, HTTP method, URL path, and request body. Through Jentic the keys are stored by your own instance and the signed headers are built at call time, so the secret_key never enters the agent's context.

### Can I cancel a Rapyd payment through the API?

Yes. DELETE `/v1/payments/{paymentId}` cancels a payment, but only while its status is ACT and the payment method has is_cancelable set to true. For a completed payment, use POST `/v1/refunds` instead.

### What are the rate limits for the Rapyd Payments Platform API?

The OpenAPI spec does not specify rate limits. Check the Rapyd documentation at https://docs.rapyd.net for current limits, and test against https://sandboxapi.rapyd.net first.

### Is there a Rapyd MCP server?

You don't need an MCP server to give your agent Rapyd. Jentic connects it directly from the API Directory: import it, store your access_key and secret_key once, and your agent calls the payment, refund, and checkout operations it needs, discovered on demand.

### Can I limit what my agent is allowed to do with the Rapyd Payments Platform API?

Yes. For example, write a rule that allows only GET `/v1/payments`, GET `/v1/payments/{paymentId}`, and GET `/v1/refunds`, so the agent can report on payments and refunds but cannot create payments, cancel them, or issue refunds, and its calls are logged.