Skip to main content
PATCH
/
api
/
v1
/
ops
/
cooperative-payment-settings
Update Cooperative Payment Settings
curl --request PATCH \
  --url https://api.example.com/api/v1/ops/cooperative-payment-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalProvider": "<string>",
  "externalAccountId": "<string>",
  "externalWalletId": "<string>",
  "externalApiKey": "<string>"
}
'
import requests

url = "https://api.example.com/api/v1/ops/cooperative-payment-settings"

payload = {
"externalProvider": "<string>",
"externalAccountId": "<string>",
"externalWalletId": "<string>",
"externalApiKey": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalProvider: '<string>',
externalAccountId: '<string>',
externalWalletId: '<string>',
externalApiKey: '<string>'
})
};

fetch('https://api.example.com/api/v1/ops/cooperative-payment-settings', 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 => "https://api.example.com/api/v1/ops/cooperative-payment-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'externalProvider' => '<string>',
'externalAccountId' => '<string>',
'externalWalletId' => '<string>',
'externalApiKey' => '<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 := "https://api.example.com/api/v1/ops/cooperative-payment-settings"

payload := strings.NewReader("{\n \"externalProvider\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalWalletId\": \"<string>\",\n \"externalApiKey\": \"<string>\"\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/api/v1/ops/cooperative-payment-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalProvider\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalWalletId\": \"<string>\",\n \"externalApiKey\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/ops/cooperative-payment-settings")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalProvider\": \"<string>\",\n \"externalAccountId\": \"<string>\",\n \"externalWalletId\": \"<string>\",\n \"externalApiKey\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "cooperativePaymentSettingsId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalProvider": "<string>",
  "externalAccountId": "<string>",
  "externalWalletId": "<string>",
  "hasExternalApiKey": true,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}
{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [
{
"code": "invalid_type",
"message": "Required",
"path": "name"
}
]
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}
{
"statusCode": 404,
"error": "Not Found",
"message": "resource.not_found"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection.

Body

application/json

Partial cooperative payment settings payload.

externalProvider
string

Logical external billing provider.

Minimum string length: 1
externalAccountId
string

Cooperative account identifier at the provider.

Minimum string length: 1
externalWalletId
string | null

Optional external wallet identifier.

externalApiKey
string
write-only

External API key. Encrypted before persistence and never returned.

Minimum string length: 1
status
enum<string>

Settings status.

Available options:
PENDING,
ACTIVE,
REJECTED,
DISABLED

Response

OK

External billing configuration for the authenticated cooperative.

cooperativePaymentSettingsId
string<uuid>
required

Settings identifier.

organizationId
string<uuid>
required

Cooperative organization identifier.

cooperativeId
string<uuid>
required

Cooperative identifier.

externalProvider
string
required

Logical external billing provider.

externalAccountId
string
required

Cooperative account identifier at the provider.

externalWalletId
string | null
required

Optional external wallet identifier.

hasExternalApiKey
boolean
required

Indicates whether an encrypted external API key is configured.

status
enum<string>
required

Settings status.

Available options:
PENDING,
ACTIVE,
REJECTED,
DISABLED
createdBy
string<uuid> | null
required

User that created the settings.

createdAt
string<date-time>
required

Creation date.

updatedBy
string<uuid> | null
required

User that last updated the settings.

updatedAt
string<date-time>
required

Last update date.