latestOpenAPI 3.1.02026-08-108094177.6 KB

087dcf516ce2

External Wallet Access Mode

Create payout with permit

Creates a bank payout with an EIP-2612 permit signature and submits it on-chain. Recipient fields must use Latin characters; the network fee is deducted from the transfer amount. Payouts count against the user's rolling 30-day limit.

post/api/v1/payout-with-permit

Headers

tokenIdstring required

The user's URID (NFT token id).

networkstring required

Network identifier: 5000 for mainnet, 5003 for testnet.

signstring required

Signature generated by the user's wallet key (EIP-191).

hashstring required

SHA3/Keccak256 hash of the original request payload.

deadlinestring required

Signature expiry: server timestamp plus a validity window (max 20 minutes).

Request body

amountstring required

Payout amount in smallest units.

permitAmountstring required

Permit amount signed in the EIP-2612 permit.

permitDeadlineinteger required

Unix seconds until which the permit is valid.

permitVinteger required

EIP-2612 signature component v.

permitRstring required

EIP-2612 signature component r.

permitSstring required

EIP-2612 signature component s.

contactIdstring required

Contact ID from the profile contacts or verify-contact.

tokenAddressstring required

Fiat token contract address to pay out from.

purposeIdstring

Payment purpose ID from verify-reference or verify-contact.

refstring

Reference ID from verify-reference or verify-contact.

Response

Response envelope. For the user API, retCode 0 means success; for the partner API, code 0 means success. Business rejections return HTTP 200 with a non-zero code.

retCodeinteger required

0 on success; non-zero indicates failure.

retMsgstring required

Human-readable message; error details when retCode is non-zero.

{"stackTrail":"components:schemas:EwaEnvelope:properties:result","oasType":"schema","type":"unknown","description":"Business payload. Shape depends on the endpoint; some endpoints return it as a JSON-encoded string."}

timeNowinteger

Server timestamp in milliseconds.