Create payin key

Registers a payin key — an alias that maps to an existing bank account and can receive inbound funds. Omit co_breb.beneficiary for the first-party KYC path. When present, beneficiary is all-or-nothing and is never merged with KYC. Optional external_ref is echoed when stored.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

COP Bre-B payin key creation request.

string
length between 0 and 64
^[a-zA-Z0-9_-]+$

Client-assigned external reference (optional). ASCII alphanumeric, hyphen, and underscore; max 64 characters. Not used as the resource id.

string
enum
required

Payin key type discriminator (only CO_BREB is supported). This enumeration is extensible; new values may be added.

Allowed:
co_breb
object
required

COP Bre-B key details. Required when type is CO_BREB.

Headers
string

Idempotency key for the request.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json