Create BAX merchant agreement - Dintero Documentation

aid_account_management_stores_sid_bax_merchant_agreements_post

curl --request POST \
  --url https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bax_number": "1234567",
  "organization_number": "123456789",
  "name": "Dintero Oslo",
  "address": {
    "address_line": "Sommerkroveien 34",
    "postal_code": "0349",
    "postal_place": "Oslo",
    "country": "NO",
    "address_line_2": "PB 123"
  }
}
'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements"

payload = {
    "bax_number": "1234567",
    "organization_number": "123456789",
    "name": "Dintero Oslo",
    "address": {
        "address_line": "Sommerkroveien 34",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "country": "NO",
        "address_line_2": "PB 123"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bax_number: '1234567',
    organization_number: '123456789',
    name: 'Dintero Oslo',
    address: {
      address_line: 'Sommerkroveien 34',
      postal_code: '0349',
      postal_place: 'Oslo',
      country: 'NO',
      address_line_2: 'PB 123'
    }
  })
};

fetch('https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements"

	payload := strings.NewReader("{\n  \"bax_number\": \"1234567\",\n  \"organization_number\": \"123456789\",\n  \"name\": \"Dintero Oslo\",\n  \"address\": {\n    \"address_line\": \"Sommerkroveien 34\",\n    \"postal_code\": \"0349\",\n    \"postal_place\": \"Oslo\",\n    \"country\": \"NO\",\n    \"address_line_2\": \"PB 123\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bax_number\": \"1234567\",\n  \"organization_number\": \"123456789\",\n  \"name\": \"Dintero Oslo\",\n  \"address\": {\n    \"address_line\": \"Sommerkroveien 34\",\n    \"postal_code\": \"0349\",\n    \"postal_place\": \"Oslo\",\n    \"country\": \"NO\",\n    \"address_line_2\": \"PB 123\"\n  }\n}")
  .asString();

{
  "bax_number": "1234567",
  "organization_number": "123456789",
  "name": "Dintero Oslo",
  "address": {
    "address_line": "Sommerkroveien 34",
    "postal_code": "0349",
    "postal_place": "Oslo",
    "country": "NO",
    "address_line_2": "PB 123"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "valid",
  "store_id": "T66600000-0001",
  "payout_destination_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "mismatched_fields": [
    "organization_number"
  ],
  "deleted_at": "2023-11-07T05:31:56Z",
  "deleted_by": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

POST

https://api.dintero.com/v1

accounts

{aid}

stores

{store_id}

bax-merchant-agreements

aid_account_management_stores_sid_bax_merchant_agreements_post

curl --request POST \
  --url https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bax_number": "1234567",
  "organization_number": "123456789",
  "name": "Dintero Oslo",
  "address": {
    "address_line": "Sommerkroveien 34",
    "postal_code": "0349",
    "postal_place": "Oslo",
    "country": "NO",
    "address_line_2": "PB 123"
  }
}
'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements"

payload = {
    "bax_number": "1234567",
    "organization_number": "123456789",
    "name": "Dintero Oslo",
    "address": {
        "address_line": "Sommerkroveien 34",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "country": "NO",
        "address_line_2": "PB 123"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bax_number: '1234567',
    organization_number: '123456789',
    name: 'Dintero Oslo',
    address: {
      address_line: 'Sommerkroveien 34',
      postal_code: '0349',
      postal_place: 'Oslo',
      country: 'NO',
      address_line_2: 'PB 123'
    }
  })
};

fetch('https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements"

	payload := strings.NewReader("{\n  \"bax_number\": \"1234567\",\n  \"organization_number\": \"123456789\",\n  \"name\": \"Dintero Oslo\",\n  \"address\": {\n    \"address_line\": \"Sommerkroveien 34\",\n    \"postal_code\": \"0349\",\n    \"postal_place\": \"Oslo\",\n    \"country\": \"NO\",\n    \"address_line_2\": \"PB 123\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dintero.com/v1/accounts/{aid}/stores/{store_id}/bax-merchant-agreements")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bax_number\": \"1234567\",\n  \"organization_number\": \"123456789\",\n  \"name\": \"Dintero Oslo\",\n  \"address\": {\n    \"address_line\": \"Sommerkroveien 34\",\n    \"postal_code\": \"0349\",\n    \"postal_place\": \"Oslo\",\n    \"country\": \"NO\",\n    \"address_line_2\": \"PB 123\"\n  }\n}")
  .asString();

{
  "bax_number": "1234567",
  "organization_number": "123456789",
  "name": "Dintero Oslo",
  "address": {
    "address_line": "Sommerkroveien 34",
    "postal_code": "0349",
    "postal_place": "Oslo",
    "country": "NO",
    "address_line_2": "PB 123"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "valid",
  "store_id": "T66600000-0001",
  "payout_destination_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "mismatched_fields": [
    "organization_number"
  ],
  "deleted_at": "2023-11-07T05:31:56Z",
  "deleted_by": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication (token authentication) should be used for accessing the API.

Use Get Token to get an access token for client credentials. Pass the token in the request header:

Authorization: Bearer {access_token}

where the access_token is JSON Web Tokens (JWT).

Path Parameters

aid

string<^[PT]{1}\d{8}$>

required

An id that uniquely identifies the account.

Required string length: 9

store_id

string

required

Store ID as returned in the store creation response.

Maximum string length: 255

Body

application/json

A BankAxept (BAX) merchant agreement for the store. The BAX number identifies a point of sale registered with BankAxept by organization number, name and visiting address.

On create and update, organization_number, name, address.address_line and address.postal_code must match the registered data for the store:

name: the store's store_name. If the store has none, the organization's trade_name, then its name.
main_unit store: the payout destination's organization number and address.
sub_unit store: the sub-unit's organization number and address in the Norwegian business register (BRREG).

Values are compared ignoring case and whitespace.

If a value doesn't match, the request fails with 400. The response lists the fields that don't match in error.errors. Each item has the field, the expected value from the store and the actual value from the request, for example [{"field": "name", "expected": "Dintero Oslo", "actual": "Dintero"}].

bax_number

string

required

BankAxept merchant number. Unique across all agreements that aren't deleted.

Pattern: ^\d{6,7}$

Example:

"1234567"

organization_number

string

required

Organization number on the agreement

Example:

"123456789"

name

string

required

Name on the agreement

Example:

"Dintero Oslo"

address

object

required

Visiting address on the agreement

Show child attributes

Response

BAX merchant agreement

A BankAxept merchant agreement registered for a store. Agreements are never updated, only deleted. The most recent agreement for a store that isn't deleted is the current one.

bax_number

string

required

BankAxept merchant number. Unique across all agreements that aren't deleted.

Pattern: ^\d{6,7}$

Example:

"1234567"

organization_number

string

required

Organization number on the agreement

Example:

"123456789"

name

string

required

Name on the agreement

Example:

"Dintero Oslo"

address

object

required

Visiting address on the agreement

Show child attributes

string<uuid>

required

read-only

status

enum<string>

required

valid - the agreement matches the store
mismatch - the store no longer matches the agreement, see mismatched_fields. Create a new agreement, or change the store back so it matches.

The status is checked again when the store or its payout destination changes.

Available options:

valid,

mismatch

store_id

string

required

read-only

Example:

"T66600000-0001"

payout_destination_id

string

required

read-only

The store's payout destination when the agreement was created

created_at

string<date-time>

required

read-only

created_by

string

required

read-only

updated_at

string<date-time>

required

read-only

updated_by

string

required

read-only

mismatched_fields

enum<string>[]

Fields where the store no longer matches the agreement

Available options:

organization_number,

name,

address_line,

postal_code

deleted_at

string<date-time>

read-only

Only set in the response to a delete, together with deleted_by

deleted_by

string

read-only