Create a new wallet

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Read accessread
Write accesswrite

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

external_customer_idstringRequired

External reference to the customer

currencystring<Currency>Required

Currency in which the wallet operates

Match^[A-Z]{3}$Length3 <= length <= 3

namestringOptional

Name of the wallet

rate_amountstringRequired

Cost rate per credit unit, must be non zero positive value

Match^(?!0+(?:\.0+)?$)\d+(\.\d+)?$

paid_creditsstringOptional

Number of paid credits to initialize, must be positive value

Match^(0|[1-9]\d*)(\.\d+)?$

granted_creditsstringOptional

Number of granted credits to initialize, must be positive value

Match^(0|[1-9]\d*)(\.\d+)?$

expiration_atstring<DateTimeWithZone>Optional

Cancelled date of the subscription

Formatdate-time

applies_toobject<PrepaidCreditAppliesTo>Optional

Indicates whether the prepaid credit applies to the entire invoice or only to specific line items.

recurring_transaction_rulesobject<RecurringTransactionRule>[]Optional

List of recurring transaction rules for automatic top-ups

Response Body

`application/json`

curl -X POST "https://example.com/wallets" \  -H "Content-Type: application/json" \  -d '{    "external_customer_id": "client-xyz456",    "currency": "USD",    "rate_amount": "1.5"  }'

{  "id": "13fddcdc-725b-4ca7-a522-a162ff038567",  "external_customer_id": "ext_cus_1234567890abcdef",  "status": "ACTIVE",  "available_balance": {    "value": 110,    "currency_code": "USD"  },  "ongoing_usage": {    "value": 0,    "currency_code": "USD"  },  "net_balance": {    "value": 110,    "currency_code": "USD"  },  "name": "Prepaid Wallet",  "rate_amount": "1.0",  "available_credits": "110.0",  "consumed_credits": "0.0",  "ongoing_usage_credits": "0.0",  "net_balance_credits": "110.0",  "created_at": "2025-09-17T00:00:00Z",  "applies_to": {    "fee_types": [      "SUBSCRIPTION"    ]  },  "expiration_at": "2026-08-12T12:43:31Z"}

{ "id": "13fddcdc-725b-4ca7-a522-a162ff038567", "external_customer_id": "ext_cus_1234567890abcdef", "status": "ACTIVE", "available_balance": { "value": 110, "currency_code": "USD" }, "ongoing_usage": { "value": 0, "currency_code": "USD" }, "net_balance": { "value": 110, "currency_code": "USD" }, "name": "Prepaid Wallet", "rate_amount": "1.0", "available_credits": "110.0", "consumed_credits": "0.0", "ongoing_usage_credits": "0.0", "net_balance_credits": "110.0", "created_at": "2025-09-17T00:00:00Z", "applies_to": { "fee_types": [ "SUBSCRIPTION" ] }, "expiration_at": "2026-08-12T12:43:31Z"}

Authorization

Request Body

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

On this page

Create a new wallet

Authorization

Request Body

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

Create a new wallet

Authorization

Request Body

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Response Body

201application/json

400application/json

403application/json

422application/json

500application/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Create a new wallet

Authorization

Request Body

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Response Body

201application/json

400application/json

403application/json

422application/json

500application/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`