KKonsol Developers
API referenceAcquirers

Create an acquirer

POST
/integration/v1/acquirers

Creates an acquirer.

Set external_ref to find it later by your own reference. Send an Idempotency-Key so that a retry returns the first response.

Authorization

integrationKey
headerAuthorizationBearer <token>

Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>. Konsol issues it.

Header Parameters

Idempotency-Key?string

A unique value per logical request, such as a UUID. Within 24 hours a repeat with the same key, path and body returns the first response; the same key with a different path or body is a 409.

Length1 <= length <= 255

Request Body

application/json
  1. body
external_ref?ExternalRef

Your own reference for a record: any format, compared exactly and case-sensitively. Leading or trailing whitespace is refused rather than trimmed, so a stored reference always matches what was sent.

Match^\S(.*\S)?$
Length1 <= length <= 128
name*string
Length1 <= length <= 255
status?string
Default"active"
Value in"active""inactive"
business_reg_no?string
Length1 <= length <= 12
tax_id_no?string
Length1 <= length <= 64
sst_no?string
Length1 <= length <= 64
contact?

A point of contact. Every field is optional, and a record may come back with none of them.

address?

A postal address. Send the whole object or leave it out: line1, city, postcode, state and country are required whenever an address is sent. A response returns it exactly as sent.

billing?

The name and optional address to bill. If you send it, name is required.

Response Body

The created acquirer

application/json
  1. response
id*string
Formatuuid
external_ref?|null
name*string
status*string
Value in"active""inactive"
business_reg_no?string|null
tax_id_no?string|null
sst_no?string|null
contact?|null
address?|null
billing?|null
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
deleted_at*|

When the record was deleted, or null. Lists return deleted records only with include_deleted=true.

Formatdate-time
Example Request
curl -X POST 'https://api.konsol.my/integration/v1/acquirers' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "external_ref": "ACQ-MBB",  "name": "string",  "status": "active",  "business_reg_no": "string",  "tax_id_no": "string",  "sst_no": "string",  "contact": {    "person": "string",    "phone": "string",    "email": "user@example.com"  },  "address": {    "line1": "string",    "line2": "string",    "city": "string",    "postcode": "string",    "state": "MY-01",    "country": "MY"  },  "billing": {    "name": "string",    "address": {      "line1": "string",      "line2": "string",      "city": "string",      "postcode": "string",      "state": "MY-01",      "country": "MY"    }  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "deleted_at": "2019-08-24T14:15:22Z"}