POST
/
payments
/
initiate
curl --request POST \
  --url https://api-umbrella.io/api/services/payments/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "referenceId": "unique-ref-id-123",
  "transactionDescription": "Payment for Order #12345",
  "returnUrl": "https://example.com/callback",
  "IBAN": "DE89370400440532013000",
  "storedBIC": "BOFIIE2D",
  "language": "DE",
  "currency": "EUR",
  "amount": "100.50",
  "country": "DE"
}'
{
  "requestId": "req_123456789",
  "redirectUrl": "https://example.com/app/req_123456789"
}

For a usage description of the Payment Initiation Service, please refer to the Payment Services page.

​
Endpoint

POST /payments/initiate

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
referenceId
string

Unique identifier for the transaction.

Example:

"unique-ref-id-123"

​
transactionDescription
string

Description of the transaction.

Example:

"Payment for Order #12345"

​
returnUrl
string

URL to redirect after payment completion.

Example:

"https://example.com/callback"

​
IBAN
string

User's IBAN for direct payment.

Example:

"DE89370400440532013000"

​
storedBIC
string

Pre-stored BIC code.

Example:

"BOFIIE2D"

​
language
string

Language code.

Example:

"DE"

​
currency
string

ISO 4217 currency code.

Example:

"EUR"

​
amount
string

Payment amount formatted as a decimal string.

Example:

"100.50"

​
country
string

Country code.

Example:

"DE"

Response

200
application/json
Payment successfully initiated.
​
requestId
string

Unique identifier for the request.

Example:

"req_123456789"

​
redirectUrl
string

URL to redirect the user to the payment page.

Example:

"https://example.com/app/req_123456789"