Skip to Content
EuropePayinCreate Pay-in (Europe Open Banking)

Create Pay-in (Europe Open Banking)

POST/v1/eur/payin-instancespayin:create

Create a EUR/GBP Open Banking pay-in. You may send an optional Idempotency-Key header to safely retry the same request.

Request fields

FieldTypeRequiredDescription
amountstring (numeric)YesPay-in amount
currencySymbolstringYesEUR or GBP
returnUrlstring (HTTPS URL)YesWhere the customer returns after the hosted bank widget
merchantUrlstring (HTTPS URL)Yes*Your site URL (or pass full merchantDetails)
userDetailsobjectYesEnd customer details
userDetails.emailstringYesCustomer email
merchantDetailsobjectNoAlternative to merchantUrl: full merchant info
merchantDetails.merchantNamestringNoDisplay name
merchantDetails.merchantUrlstring (HTTPS)NoSite URL
merchantDetails.merchantInternalIdstringNoYour internal reference

Provide either merchantUrl or the full merchantDetails object.

Example

{ "amount": "100", "currencySymbol": "EUR", "returnUrl": "https://merchant.com/payment/return", "merchantUrl": "https://merchant.com", "userDetails": { "email": "payer@example.com" } }

Response fields

FieldTypeDescription
transactionIdstringPoll + ledger transaction id
checkoutUrlstringRedirect the end user here to complete payment
instanceIdstringSupport / reference id
settlementCurrencystringAlways USDC (for display)
cryptoAmountstringOptional quote amount in USDC
ratestringOptional conversion rate for display

Your only pay-in UI job is to redirect the customer to checkoutUrl. After they complete the widget, track the result via Pay-in Status & Events or webhooks.

Last updated on