Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

connection-id
string

Connection ID for the target bank

idempotency-key
string
required

Unique key to ensure idempotency of the request

signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Path Parameters

mandate_id
string
required

The ID of the direct debit mandate

Body

application/json
amount
number
required

The amount of the direct debit

Example:

100

reference
string

Unique reference ID of the direct debit mandate

Example:

"DD123456789"

narration
string

Description of the mandate

Example:

"Monthly subscription payment"

custom_properties
object[]

Response

Direct debit triggered successfully

status
string
required
Example:

"00"

message
string
required
Example:

"Payment successful"

data
object
required