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

Omise Recipients API

Bank-account recipients that transfers pay out to.

Omise Recipients API is one of 13 APIs that Omise publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Recipients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2019-05-29.

Requests are made against 2 base URLs: https://api.omise.co, https://vault.omise.co.

6 operations 3 paths 6 schemas 1 DELETE2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2019-05-29
Base URL
https://api.omise.co
Authentication
HTTP Basic, HTTP Basic
Resource Areas
1

Authentication & Security 2

Omise Recipients API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (secretKeyAuth). It accepts HTTP basic authentication (publicKeyAuth). By default, every request must be authenticated.

  • secretKeyAuth — HTTP Basic auth against https://api.omise.co. The secret key (skeytest... or skey... ) is the username; the password is left empty.
  • publicKeyAuth — HTTP Basic auth against https://vault.omise.co for tokenization and for creating sources. The public key (pkeytest... or pkey... ) is the username; the passwor…

Paths & Operations 6

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

Recipients 6

Bank-account recipients that transfers pay out to.

POST
/recipients
Create a recipient
createRecipient body → 200401
GET
/recipients
List recipients
listRecipients → 200401
GET
/recipients/{id}
Retrieve a recipient
getRecipient 1 param → 200404
PATCH
/recipients/{id}
Update a recipient
updateRecipient 1 param body → 200404
DELETE
/recipients/{id}
Delete a recipient
deleteRecipient 1 param → 200404
PATCH
/recipients/{id}/verify
Verify a recipient
verifyRecipient 1 param → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Recipient (11 properties), List (7 properties), RecipientInput (5 properties), BankAccount (4 properties). Each schema is shown below with its type and property counts.

List
object
Omise paginated list envelope.
7 properties
Error
object
4 properties
Recipient
object
11 properties
Deleted
object
3 properties
BankAccount
object
4 properties
RecipientInput
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

omise-recipients-api-openapi.yml Raw ↑

Other APIs Omise publishes across the network.

Omise Account API
Omise Cards API
Omise Charges API
Omise Customers API
Omise Disputes API
Omise Events API
Omise Links API
Omise Refunds API
Omise Schedules API
Omise Sources API
Omise Tokens API
Omise Transfers API
Where this information came from

This is an independent, third-party profile of Omise Recipients 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.