Adds a Polygon address to the company's address book. It can receive crypto withdrawals from activeFrom, 24 hours after it is added (Payca may confirm it earlier at your request). An entry cannot be edited: disable a wrong one and add the right address again. Adding an address the book already holds returns that entry.

Parameters

NameInTypeRequiredDescription
companyId path string (uuid) yes

Your company that Payca enabled for Virtual IBAN.
Idempotency-Key header string yes

Your unique key for this operation, 1–128 characters. The same key returns the same result; a different body under it is idempotency_conflict.

Request body

application/json · object · required

FieldTypeRequiredDescription
address string yes

A Polygon address, 0x and 40 hex digits; a mixed-case one must carry a valid checksum.
label string no
network string no

Always polygon (the default).

Responses

StatusBodyDescription
200 VirtualIbanAddress

Already in the book (same key, or same address).
201 VirtualIbanAddress

Added.
400 VirtualIbanError

The request was refused; code says why (see errors).
401 —

Missing or invalid x-client-id / x-client-secret (no body).
403 VirtualIbanError

The request was refused; code says why (see errors).
409 VirtualIbanError

The request was refused; code says why (see errors).

Specification

This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.