Create a counterparty

POST /v1/counterparties/

Create a counterparty

cURL

curl --request POST \
  --url http://localhost/v1/counterparties/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fullName": "<string>",
  "country": "<string>",
  "type": "CLIENT",
  "tradeName": "<string>",
  "legalForm": "<string>",
  "registrationNumber": "<string>",
  "taxId": "<string>",
  "address": "<string>",
  "contactName": "<string>",
  "contactRole": "<string>",
  "contactPhone": "<string>",
  "bankName": "<string>",
  "msisdn": "<string>",
  "email": "[e-mail]",
  "iban": "<string>",
  "swiftBic": "<string>",
  "bankAccount": "<string>",
  "walletAddress": "<string>",
  "methodDetails": {
    "bankAddress": "<string>",
    "accountHolder": "<string>",
    "bankCurrency": "<string>",
    "bankCountry": "<string>",
    "momoCountry": "<string>",
    "momoNetwork": "<string>",
    "momoHolderName": "<string>",
    "momoHolderId": "<string>",
    "cryptoAsset": "<string>",
    "walletLabel": "<string>"
  },
  "documents": [
    {
      "kind": "<string>",
      "filename": "<string>",
      "mimeType": "<string>",
      "base64": "<string>",
      "storageKey": "<string>"
    }
  ],
  "accounts": [
    {
      "label": "<string>",
      "bankName": "<string>",
      "bankAddress": "<string>",
      "bankCountry": "<string>",
      "accountHolder": "<string>",
      "iban": "<string>",
      "bankAccount": "<string>",
      "swiftBic": "<string>",
      "msisdn": "<string>",
      "momoCountry": "<string>",
      "momoHolderName": "<string>",
      "momoHolderId": "<string>",
      "walletAddress": "<string>",
      "cryptoAsset": "<string>"
    }
  ]
}
'

import requests

url = "http://localhost/v1/counterparties/"

payload = {
    "fullName": "<string>",
    "country": "<string>",
    "type": "CLIENT",
    "tradeName": "<string>",
    "legalForm": "<string>",
    "registrationNumber": "<string>",
    "taxId": "<string>",
    "address": "<string>",
    "contactName": "<string>",
    "contactRole": "<string>",
    "contactPhone": "<string>",
    "bankName": "<string>",
    "msisdn": "<string>",
    "email": "[e-mail]",
    "iban": "<string>",
    "swiftBic": "<string>",
    "bankAccount": "<string>",
    "walletAddress": "<string>",
    "methodDetails": {
        "bankAddress": "<string>",
        "accountHolder": "<string>",
        "bankCurrency": "<string>",
        "bankCountry": "<string>",
        "momoCountry": "<string>",
        "momoNetwork": "<string>",
        "momoHolderName": "<string>",
        "momoHolderId": "<string>",
        "cryptoAsset": "<string>",
        "walletLabel": "<string>"
    },
    "documents": [
        {
            "kind": "<string>",
            "filename": "<string>",
            "mimeType": "<string>",
            "base64": "<string>",
            "storageKey": "<string>"
        }
    ],
    "accounts": [
        {
            "label": "<string>",
            "bankName": "<string>",
            "bankAddress": "<string>",
            "bankCountry": "<string>",
            "accountHolder": "<string>",
            "iban": "<string>",
            "bankAccount": "<string>",
            "swiftBic": "<string>",
            "msisdn": "<string>",
            "momoCountry": "<string>",
            "momoHolderName": "<string>",
            "momoHolderId": "<string>",
            "walletAddress": "<string>",
            "cryptoAsset": "<string>"
        }
    ]
}
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({
    fullName: '<string>',
    country: '<string>',
    type: 'CLIENT',
    tradeName: '<string>',
    legalForm: '<string>',
    registrationNumber: '<string>',
    taxId: '<string>',
    address: '<string>',
    contactName: '<string>',
    contactRole: '<string>',
    contactPhone: '<string>',
    bankName: '<string>',
    msisdn: '<string>',
    email: '[e-mail]',
    iban: '<string>',
    swiftBic: '<string>',
    bankAccount: '<string>',
    walletAddress: '<string>',
    methodDetails: {
      bankAddress: '<string>',
      accountHolder: '<string>',
      bankCurrency: '<string>',
      bankCountry: '<string>',
      momoCountry: '<string>',
      momoNetwork: '<string>',
      momoHolderName: '<string>',
      momoHolderId: '<string>',
      cryptoAsset: '<string>',
      walletLabel: '<string>'
    },
    documents: [
      {
        kind: '<string>',
        filename: '<string>',
        mimeType: '<string>',
        base64: '<string>',
        storageKey: '<string>'
      }
    ],
    accounts: [
      {
        label: '<string>',
        bankName: '<string>',
        bankAddress: '<string>',
        bankCountry: '<string>',
        accountHolder: '<string>',
        iban: '<string>',
        bankAccount: '<string>',
        swiftBic: '<string>',
        msisdn: '<string>',
        momoCountry: '<string>',
        momoHolderName: '<string>',
        momoHolderId: '<string>',
        walletAddress: '<string>',
        cryptoAsset: '<string>'
      }
    ]
  })
};

fetch('http://localhost/v1/counterparties/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/v1/counterparties/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fullName' => '<string>',
    'country' => '<string>',
    'type' => 'CLIENT',
    'tradeName' => '<string>',
    'legalForm' => '<string>',
    'registrationNumber' => '<string>',
    'taxId' => '<string>',
    'address' => '<string>',
    'contactName' => '<string>',
    'contactRole' => '<string>',
    'contactPhone' => '<string>',
    'bankName' => '<string>',
    'msisdn' => '<string>',
    'email' => '[e-mail]',
    'iban' => '<string>',
    'swiftBic' => '<string>',
    'bankAccount' => '<string>',
    'walletAddress' => '<string>',
    'methodDetails' => [
        'bankAddress' => '<string>',
        'accountHolder' => '<string>',
        'bankCurrency' => '<string>',
        'bankCountry' => '<string>',
        'momoCountry' => '<string>',
        'momoNetwork' => '<string>',
        'momoHolderName' => '<string>',
        'momoHolderId' => '<string>',
        'cryptoAsset' => '<string>',
        'walletLabel' => '<string>'
    ],
    'documents' => [
        [
                'kind' => '<string>',
                'filename' => '<string>',
                'mimeType' => '<string>',
                'base64' => '<string>',
                'storageKey' => '<string>'
        ]
    ],
    'accounts' => [
        [
                'label' => '<string>',
                'bankName' => '<string>',
                'bankAddress' => '<string>',
                'bankCountry' => '<string>',
                'accountHolder' => '<string>',
                'iban' => '<string>',
                'bankAccount' => '<string>',
                'swiftBic' => '<string>',
                'msisdn' => '<string>',
                'momoCountry' => '<string>',
                'momoHolderName' => '<string>',
                'momoHolderId' => '<string>',
                'walletAddress' => '<string>',
                'cryptoAsset' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "http://localhost/v1/counterparties/"

	payload := strings.NewReader("{\n  \"fullName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"type\": \"CLIENT\",\n  \"tradeName\": \"<string>\",\n  \"legalForm\": \"<string>\",\n  \"registrationNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"address\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"contactRole\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"msisdn\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"iban\": \"<string>\",\n  \"swiftBic\": \"<string>\",\n  \"bankAccount\": \"<string>\",\n  \"walletAddress\": \"<string>\",\n  \"methodDetails\": {\n    \"bankAddress\": \"<string>\",\n    \"accountHolder\": \"<string>\",\n    \"bankCurrency\": \"<string>\",\n    \"bankCountry\": \"<string>\",\n    \"momoCountry\": \"<string>\",\n    \"momoNetwork\": \"<string>\",\n    \"momoHolderName\": \"<string>\",\n    \"momoHolderId\": \"<string>\",\n    \"cryptoAsset\": \"<string>\",\n    \"walletLabel\": \"<string>\"\n  },\n  \"documents\": [\n    {\n      \"kind\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"mimeType\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"storageKey\": \"<string>\"\n    }\n  ],\n  \"accounts\": [\n    {\n      \"label\": \"<string>\",\n      \"bankName\": \"<string>\",\n      \"bankAddress\": \"<string>\",\n      \"bankCountry\": \"<string>\",\n      \"accountHolder\": \"<string>\",\n      \"iban\": \"<string>\",\n      \"bankAccount\": \"<string>\",\n      \"swiftBic\": \"<string>\",\n      \"msisdn\": \"<string>\",\n      \"momoCountry\": \"<string>\",\n      \"momoHolderName\": \"<string>\",\n      \"momoHolderId\": \"<string>\",\n      \"walletAddress\": \"<string>\",\n      \"cryptoAsset\": \"<string>\"\n    }\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("http://localhost/v1/counterparties/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fullName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"type\": \"CLIENT\",\n  \"tradeName\": \"<string>\",\n  \"legalForm\": \"<string>\",\n  \"registrationNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"address\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"contactRole\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"msisdn\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"iban\": \"<string>\",\n  \"swiftBic\": \"<string>\",\n  \"bankAccount\": \"<string>\",\n  \"walletAddress\": \"<string>\",\n  \"methodDetails\": {\n    \"bankAddress\": \"<string>\",\n    \"accountHolder\": \"<string>\",\n    \"bankCurrency\": \"<string>\",\n    \"bankCountry\": \"<string>\",\n    \"momoCountry\": \"<string>\",\n    \"momoNetwork\": \"<string>\",\n    \"momoHolderName\": \"<string>\",\n    \"momoHolderId\": \"<string>\",\n    \"cryptoAsset\": \"<string>\",\n    \"walletLabel\": \"<string>\"\n  },\n  \"documents\": [\n    {\n      \"kind\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"mimeType\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"storageKey\": \"<string>\"\n    }\n  ],\n  \"accounts\": [\n    {\n      \"label\": \"<string>\",\n      \"bankName\": \"<string>\",\n      \"bankAddress\": \"<string>\",\n      \"bankCountry\": \"<string>\",\n      \"accountHolder\": \"<string>\",\n      \"iban\": \"<string>\",\n      \"bankAccount\": \"<string>\",\n      \"swiftBic\": \"<string>\",\n      \"msisdn\": \"<string>\",\n      \"momoCountry\": \"<string>\",\n      \"momoHolderName\": \"<string>\",\n      \"momoHolderId\": \"<string>\",\n      \"walletAddress\": \"<string>\",\n      \"cryptoAsset\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/v1/counterparties/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fullName\": \"<string>\",\n  \"country\": \"<string>\",\n  \"type\": \"CLIENT\",\n  \"tradeName\": \"<string>\",\n  \"legalForm\": \"<string>\",\n  \"registrationNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"address\": \"<string>\",\n  \"contactName\": \"<string>\",\n  \"contactRole\": \"<string>\",\n  \"contactPhone\": \"<string>\",\n  \"bankName\": \"<string>\",\n  \"msisdn\": \"<string>\",\n  \"email\": \"[e-mail]\",\n  \"iban\": \"<string>\",\n  \"swiftBic\": \"<string>\",\n  \"bankAccount\": \"<string>\",\n  \"walletAddress\": \"<string>\",\n  \"methodDetails\": {\n    \"bankAddress\": \"<string>\",\n    \"accountHolder\": \"<string>\",\n    \"bankCurrency\": \"<string>\",\n    \"bankCountry\": \"<string>\",\n    \"momoCountry\": \"<string>\",\n    \"momoNetwork\": \"<string>\",\n    \"momoHolderName\": \"<string>\",\n    \"momoHolderId\": \"<string>\",\n    \"cryptoAsset\": \"<string>\",\n    \"walletLabel\": \"<string>\"\n  },\n  \"documents\": [\n    {\n      \"kind\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"mimeType\": \"<string>\",\n      \"base64\": \"<string>\",\n      \"storageKey\": \"<string>\"\n    }\n  ],\n  \"accounts\": [\n    {\n      \"label\": \"<string>\",\n      \"bankName\": \"<string>\",\n      \"bankAddress\": \"<string>\",\n      \"bankCountry\": \"<string>\",\n      \"accountHolder\": \"<string>\",\n      \"iban\": \"<string>\",\n      \"bankAccount\": \"<string>\",\n      \"swiftBic\": \"<string>\",\n      \"msisdn\": \"<string>\",\n      \"momoCountry\": \"<string>\",\n      \"momoHolderName\": \"<string>\",\n      \"momoHolderId\": \"<string>\",\n      \"walletAddress\": \"<string>\",\n      \"cryptoAsset\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

201

{
  "ok": true,
  "data": {
    "id": "<string>",
    "fullName": "<string>",
    "type": "<string>",
    "country": "<string>",
    "tradeName": "<string>",
    "legalForm": "<string>",
    "registrationNumber": "<string>",
    "taxId": "<string>",
    "address": "<string>",
    "contactName": "<string>",
    "contactRole": "<string>",
    "contactPhone": "<string>",
    "bankName": "<string>",
    "msisdn": "<string>",
    "email": "<string>",
    "iban": "<string>",
    "swiftBic": "<string>",
    "bankAccount": "<string>",
    "walletAddress": "<string>",
    "documents": [
      {
        "kind": "<string>",
        "filename": "<string>",
        "storageKey": "<string>"
      }
    ],
    "methodDetails": {},
    "isVerified": true,
    "isBlacklisted": true,
    "approvedAt": "<string>",
    "rejectionReason": "<string>",
    "docsRequiredAt": "<string>",
    "createdAt": "<string>",
    "accounts": []
  }
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

bearerAuthcookieAuth

Authorization · string · header · required

JWT utilisateur ou clé API kp_<env>_xxx

Body

application/json

fullName · string · required

Required string length: 1 - 180

country · string · required

Required string length: 2

type · enum<string> · default: CLIENT

Available options: CLIENT, FOURNISSEUR, PARTENAIRE, EMPLOYE, FILIALE, PRESTATAIRE

tradeName · string

Maximum string length: 180

legalForm · string

Maximum string length: 60

registrationNumber · string

Maximum string length: 80

taxId · string

Maximum string length: 80

address · string

Maximum string length: 300

contactName · string

Maximum string length: 180

contactRole · string

Maximum string length: 120

contactPhone · string

Maximum string length: 32

bankName · string

Maximum string length: 160

msisdn · string

Required string length: 8 - 20

email · string<email>

Maximum string length: 180

iban · string

Required string length: 15 - 34

swiftBic · string

Required string length: 8 - 11

bankAccount · string

Maximum string length: 40

walletAddress · string

Required string length: 20 - 80

walletChain · enum<string>

Available options: MTN_BJ, MTN_CI, MTN_CM, ORANGE_CI, ORANGE_SN, ORANGE_ML, ORANGE_BF, ORANGE_CM, MOOV_BJ, MOOV_TG, MOOV_CI, MOOV_BF, WAVE_CI, WAVE_SN, FREE_SN, TMONEY_TG, MOBICASH_ML, MOBICASH_BF, DJAMO_CI, MIXX_SN, MTN_CG, AIRTEL_CG, ORANGE_CD, AIRTEL_CD, VODACOM_CD, AFRICELL_CD, AIRTEL_GA, MOMO_NG, AIRTEL_NG, MTN_GH, VODAFONE_GH, AIRTELTIGO_GH, BANK_XOF, BANK_XAF, BANK_NGN, BANK_GHS, BANK_CDF, BANK_EUR, BANK_USD, ETH, POLYGON, TRON

methodDetails · object

Show child attributes

documents · object[]

Maximum array length: 8

Show child attributes

accounts · object[]

Maximum array length: 20

Show child attributes

Response

201

application/json

Default Response

ok · enum<boolean> · required

Available options: true

data · object · required

Show child attributes