Weavr
Powered by Redocly

Directdebits

directdebits_mandates_dd_id_expire

This endpoint is used to simulate the expiry of a Mandate.

SecurityAPI_Secret_Key
Request
path Parameters
dd_id
required
string
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

default

Error

post/directdebits/mandates/{dd_id}/expire
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

directdebits_mandates_dd_id_collections_cid_resolve_unpaid

This endpoint is used to simulate the cancellation of a Mandate by a merchant.

SecurityAPI_Secret_Key
Request
path Parameters
dd_id
required
string
cid
required
string
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/directdebits/mandates/{dd_id}/collections/{cid}/resolve_unpaid
Response samples
application/json
{
  • "cid": "string",
  • "mandateDdiId": "string",
  • "amount": {
    },
  • "status": "NOTICE_SENT"
}

directdebits_mandates_dd_id_collections_cid_collect

This endpoint is used to simulate the collection of funds from the mandated account

SecurityAPI_Secret_Key
Request
path Parameters
dd_id
required
string
cid
required
string
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/directdebits/mandates/{dd_id}/collections/{cid}/collect
Response samples
application/json
{
  • "cid": "string",
  • "mandateDdiId": "string",
  • "amount": {
    },
  • "status": "NOTICE_SENT"
}

directdebits_mandates_dd_id_collections_create

This endpoint is used to simulate the creation of a Mandate by a merchant on behalf of its customer

SecurityAPI_Secret_Key
Request
path Parameters
dd_id
required
string
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
required
object

A message representing a monetary amount in a particular currency.

Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/directdebits/mandates/{dd_id}/collections/create
Request samples
application/json
{
  • "amount": {
    }
}
Response samples
application/json
{
  • "cid": "string",
  • "mandateDdiId": "string",
  • "amount": {
    },
  • "status": "NOTICE_SENT"
}

directdebits_mandates_dd_id_cancel

This endpoint is used to simulate the cancellation of a Mandate by a merchant.

SecurityAPI_Secret_Key
Request
path Parameters
dd_id
required
string
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Responses
204

Success - No Content

400

Invalid Request

default

Error

post/directdebits/mandates/{dd_id}/cancel
Response samples
application/json
{
  • "message": "string",
  • "validation": {
    }
}

directdebits_mandates_create

This endpoint is used to simulate the creation of a Mandate by a merchant on behalf of its customer

SecurityAPI_Secret_Key
Request
header Parameters
call-ref
string

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

Request Body schema: application/json
required
merchantName
required
string
merchantAccountNumber
required
string
merchantSortCode
required
string
merchantReference
required
string
object (TypeId)
object (AccountDetails)
Responses
200

Success

400

Invalid Request

409

Conflict

default

Error

post/directdebits/mandates/create
Request samples
application/json
{
  • "merchantName": "string",
  • "merchantAccountNumber": "string",
  • "merchantSortCode": "string",
  • "merchantReference": "string",
  • "accountId": {
    },
  • "accountDetails": {
    }
}
Response samples
application/json
{
  • "ddiId": "string",
  • "merchantName": "string",
  • "merchantAccountNumber": "string",
  • "merchantSortCode": "string",
  • "merchantReference": "string",
  • "accountDetails": {
    }
}
➔ Next to Secure Session