Register Payin Recipient
Register a wallet’s address as an payin recipient with the provider. The registration then needs to be approved on the provider’s side (for Circle Mint: by an administrator in the Mint Console) before payins to that wallet can be created.
Authentication
✅ Organization User (CustomerEmployee)✅ Delegated User (
EndUser)✅ Service Account
Required Permissions
Payins:Create: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows
Body
CircleMint The wallet to register as a Circle Mint recipient.
1 - 64^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"wa-5pfuu-9euek-h0odgb6snva8ph3k"
Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC).
USD, EUR Response
Success
Payin provider.
CircleMint The wallet whose address is (to be) registered as a recipient.
1 - 64^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"wa-5pfuu-9euek-h0odgb6snva8ph3k"
Fiat currency of the payin (determines the delivered stablecoin, e.g. USD → USDC, EUR → EURC).
USD, EUR Recipient status.
NotRegistered, PendingVerification, Active The provider's recipient-registry id, once registered.