Customer Migrations Guide: Post Business Import
Overview
Return status for a contract sub-process owned by the business in the URL.
Responses
The following responses may be returned from the API.
| Status code | Description |
|---|---|
404 - Not Found | The requested resource was not found. Resource not found:{
"detail": "The requested resource was not found.",
"code": "not_found"
} |
400 - Bad Request | Validation error. Invalid parameters:{
"code": "validation_failed",
"detail": "The request has invalid parameters.",
"validation_errors": [
{
"detail": "Unknown field found: task_id.",
"code": "unknown_field",
"attr": "task_id"
}
]
} |
200 - OK | The response body. |
401 - Unauthorized | Authentication credentials were not provided or are invalid. |
Overview
Use this endpoint to create a payment instruction for a business.
Schema
Responses
The following responses may be returned from the API.
| Status code | Description |
|---|---|
201 - Created |
If the payload is valid, a {
"reference": "abc-defg",
"external_business_identifier": "external-123343243"
} |
400 - Bad Request |
If there are validation errors, a This error can be returned if we have persistent issues communicating with the upstream payment vendor (we call their API to verify the instruction exists, and retrieve the details to store in Kraken). In this case, the request should not be retried in its current form. |
401 - Unauthorized |
If there are authorization errors, a |
500 - Internal Server Error |
If an unexpected error occurs, a This error can be returned if we have intermittent issues communicating with the upstream payment vendor (we call their API to verify the instruction exists, and retrieve the details to store in Kraken). In this case, the request should be retried as-is. |
Payloads
Example payload
{
"import_supplier_code": "TENTACLE_UTILITIES",
"external_business_identifier": "EXTERNAL-1234",
"vendor": "STRIPE",
"reference": "THIS-IS-A-FAKE-REFERENCE",
"type": "CARD",
"accounts": [
{
"external_account_number": "EXTERNAL-ACCOUNT-123"
},
{
"external_account_number": "EXTERNAL-ACCOUNT-1234"
}
]
}Overview
Accept a contract batch and return its asynchronous sub-process identifier.
Schema
Responses
The following responses may be returned from the API.
| Status code | Description |
|---|---|
201 - Created | The business contract batch has been scheduled. Business contract creation scheduled response:{
"identifier": "123e4567-e89b-12d3-a456-426614174000"
} |
400 - Bad Request | Validation errors occurred while processing the request. |
401 - Unauthorized | Authentication credentials were not provided or are invalid. |
Payloads
Business contract batch
{
"payload": {
"import_supplier": "TENTACLE_ENERGY",
"external_business_identifier": "EXTERNAL-1234",
"business_contracts": [
{
"identifier": "BUSINESS-CONTRACT-123",
"valid_from_date": "2026-01-01",
"signed_at_date": "2025-12-01",
"versions": [
{
"applicable_at_date": "2026-01-01",
"terms": []
}
]
}
]
},
"task_params": {
"is_dry_run": false
}
}