Create a payment link

Authorization

OAuth2PasswordBearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*Title

Length1 <= length <= 140

currency*Currency

Length3 <= length <= 3

amount_type?LinkAmountType

Default"fixed"

Value in

"fixed"
"open"

amount_minor?|

Minor units. Required for a fixed-amount link.

min_amount_minor?|

Open-amount links only.

max_amount_minor?|

Open-amount links only.

usage?LinkUsage

Default"reusable"

Value in

"single_use"
"reusable"

expires_at?|null

redirect_url?|null

description?string|null

metadata?|null

Response Body

`application/json`

curl -X POST "https://example.com/api/b/v1/payment-links" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "currency": "str"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "slug": "string",  "title": "string",  "description": "string",  "amount_type": "string",  "amount_minor": 0,  "min_amount_minor": 0,  "max_amount_minor": 0,  "currency": "string",  "usage": "string",  "state": "active",  "redirect_url": "string",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "payments": 0}

Authorization

Cookie Parameters

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`