Create a payment request

Create an open banking payment request. Returns a Plaid Link token that the organization should embed in their frontend using Plaid Link. The customer authorizes the payment through their bank via Plaid Link.

POST /v1/payments

Create a payment request

cURL

curl --request POST \
  --url http://localhost:3000/api/v1/payments \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 25,
  "currency": "EUR",
  "description": "Monthly subscription",
  "reference": "<string>",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payerName": "<string>",
  "payerEmail": "<string>",
  "region": "EU",
  "redirectUrl": "<string>",
  "metadata": {}
}
'

Body

application/json

amount · number · required

Payment amount

Example:

25

currency · string · required

ISO 4217 currency code

Example:

"EUR"

description · string

Example:

"Monthly subscription"

reference · string

Unique payment reference (auto-generated if omitted)

customerId · string<uuid>

Associate payment with a specific customer

payerName · string

payerEmail · string

region · enum<string> · default: EU

Available options: EU, US

redirectUrl · string

URL to redirect after payment authorization

metadata · object

Response

201

Payment created with link token