Customer Migrations Guide: Post Business Import
Overview
Use this endpoint to add contracts to a business.
Schema
Responses
The following responses may be returned from the API.
| Status code | Description |
|---|---|
201 - Created |
If the payload is valid, a {
"business_contracts": [
{
"identifier": "123-12345"
},
{
"identifier": "456-12346"
}
]
} |
400 - Bad Request | The post business import endpoint does both validation and creation, so you will receive:
If there are validation errors, a
If there are creation errors, a |
404 - Not Found |
If a business is not found, then a |
500 - Internal Server Error |
If an unexpected error occurs, a |
Payloads
Example payload
{
"import_supplier_code": "TENTACLE_ENERGY",
"external_business_identifier": "EXTERNAL-1234",
"business_contracts": [
{
"valid_from_date": "2023-01-01",
"signed_at_date": "2023-01-01",
"versions": [
{
"applicable_at_date": "2023-01-01",
"terms": []
}
],
"identifier": "ABC"
}
]
}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"
}
]
}