B2B Payments API overview
Related
B2B Payments moves money between two PayMe sellers. A payment contract sends a payment to another seller, or requests one, on a date you set, after the other seller approves it. A wallet transfer moves funds from one seller's PayMe balance to another's right away, without a contract.
What the API covers
| Section | What it covers |
|---|---|
| Contracts | Create and list payment contracts; upload, list, replace and delete the files attached to a contract; list the recipients of earlier contracts. |
| Wallet Transfers | Transfer funds between two sellers of the same partner. |
Read these first
| # | Page | What you learn |
|---|---|---|
| 1 | Authentication and environments | The sandbox and production hosts, and how contract calls and wallet transfers identify the seller. |
| 2 | Errors | The error response, why you check status_code and not only the HTTP status, and the contract error codes. |
| 3 | Run a B2B payment contract end to end | One contract from start to finish: payment method, creation, approval, callbacks, changes, cancellation and files. |
The concepts behind contracts (payment methods, statuses and callbacks) are on B2B payment contracts.
Machine-readable docs
Every page is available as Markdown by appending .md to its URL. Each API Reference section publishes one OpenAPI file at /b2b-payments/<section>/openapi.json, for example /b2b-payments/contracts/openapi.json.