Create Agreement
POST/agreements
Creates an agreement which allows the creditor to pull funds from a debtor account.
The agreement must first be approved by the debtor party in order to pull funds from their acccount.
These direct debit payments can be on an automated schedule, ad-hoc or one-off. If a recurring schedule is provided, then debits will be automatically created as per the approved schedule.
Request
Responses
- 202
- 400
- 401
- 403
- 404
- 422
- 500
- 503
Accepted
Response Headers
Bad Request
Request is not well-formed, syntactically incorrect, or violates schema.
Response Headers
Unauthorized
Requires authentication
Response Headers
Forbidden
Token is missing required authorization scope
Response Headers
Not Found
Response Headers
Unprocessable Entity
The API cannot complete the requested action, or the request action is semantically incorrect or fails business validation.
Response Headers
Internal Server Error
An internal server error has occurred.
Response Headers
Service Unavailable - Temporarily Unavailable