Skip to main content
POST
/
user
/
{id}
/
url
curl --request POST \
  --url https://api.pushcash.com/user/{id}/url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "direction": "cash_in"
}
'
{
  "url": "https://cdn.pushcash.com/widget/?param=1&param=2&param=3"
}

Documentation Index

Fetch the complete documentation index at: https://docs.pushcash.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The identifier for the user

Example:

"user_28CJjV7P4Go5PNJvfzghiD"

Body

application/json
direction
enum<string>

Direction of the payment.

  • Submit cash_in for deposits
  • Submit cash_out for withdrawals
Available options:
cash_in,
cash_out
type
enum<string>

Controls which URL is generated and, for widget URLs, which card processing type is offered to the user. If omitted, generates a widget URL that supports all processing types enabled for your instance.

  • card_only: Generate a widget URL restricted to card-only processing. Card-only credentials can be used for deposits but not withdrawals.
  • secure_debit: Generate a widget URL restricted to Push secure debit processing. Secure debit credentials are bank-authenticated and required for withdrawals.
  • apple_pay: Generate a URL for use with the SDK's ApplePay launcher.

card_only and secure_debit require the matching processing category to be enabled on your contract.

Available options:
apple_pay,
card_only,
secure_debit

Response

URL created successfully

url
string

A widget URL when type is omitted, card_only, or secure_debit; an Apple Pay URL when type is apple_pay.