Get Payin Recipient
Check whether a wallet’s address is registered (and approved) as an payin recipient with the provider.
Authentication
✅ Organization User (CustomerEmployee)✅ Delegated User (
EndUser)✅ Service Account
Required Permissions
Payins:Read: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
Query Parameters
The payin provider to check the recipient with.
CircleMint The wallet whose recipient status to check.
1 - 64Fiat 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.