Skip to main content
POST
/
payment
/
get-payment-method-register-url
Get URL for registering a payment method
curl --request POST \
  --url https://api.example.com/payment/get-payment-method-register-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "cus_1234567890",
  "entityId": "loc_1234567890",
  "type": "location"
}
'
{
  "sessionUrl": "https://stripe.com/setup/s/payment/123456789"
}

Body

application/json
​
customerId
string
required

The ID of the customer to associate with the payment method

Example:

"cus_1234567890"

​
entityId
string
required

The ID of the entity (location or business organization) to associate with the payment method

Example:

"loc_1234567890"

​
type
enum<string>
required

The type of entity - either location or businessOrganization

Available options:
location,
businessOrganization
Example:

"location"

Response

Payment method registration URL successfully created

​
sessionUrl
string

URL to redirect the customer for payment method registration

Example:

"https://stripe.com/setup/s/payment/123456789"