PaybytokenDocs
Customer Deposits
API reference · Customer Deposits

Deposit accounts and addresses

Provision and manage persistent EVM address slots for a merchant customer.

MethodEndpointPurpose
POST/api/v1/customers/:customerId/deposit-accountsCreate or idempotently retrieve an EVM account.
GET/api/v1/customers/:customerId/deposit-accountsList deposit accounts.
GET/api/v1/customers/:customerId/deposit-accounts/:depositAccountIdRetrieve one account.
GET/api/v1/customers/:customerId/deposit-accounts/:depositAccountId/addressesList address slots.
GET/api/v1/customers/:customerId/deposit-accounts/:depositAccountId/addresses/:addressIdRetrieve a slot.
PATCH/api/v1/customers/:customerId/deposit-accounts/:depositAccountId/addresses/:addressIdChange its label or restriction.
PUT/api/v1/customers/:customerId/deposit-accounts/:depositAccountId/addresses/:addressId/chains/:chainActivate another supported EVM chain.
curl https://api-prod.paybytoken.io/api/v1/customers/cus_123/deposit-accounts \
  -X POST \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY" \
  -H "Idempotency-Key: deposit-account:cus_123" \
  -H "Content-Type: application/json" \
  -d '{
    "address_family": "evm",
    "initial_address": {
      "label": "Primary deposits",
      "chains": ["base", "ethereum"]
    }
  }'

Only show an address for deposits after the requested chain and asset watch is ready. Updating a label does not change ownership. Restricting an address preserves historical deposits but stops it from being presented for new transfers.

API Workbench

Full Explorer

Open in new tab