Configure Merchant OpenFinance

POST/dpm/pix/v1/merchants/openfinance

__Configure Merchant OpenFinance__ This endpoint sets up and manages a merchant (seller) in the Getnet Open Finance PIX ecosystem. A single endpoint handles all maintenance operations for the merchant. The `operation` field in the request body determines which one runs. **Notes:** - This documentation covers the `assets` and `domain` operations, which apply to the Biometric PIX flow. - Operations are synchronous. A successful call returns `204 No Content` with no response body. - There is no webhook associated with this endpoint.

Header Parameters

x-seller-idstringrequired

Unique identifier of the commercial establishment (seller) registered on the Getnet platform.

usernamestring

User who is registering. This information can be used for audit purposes.

Body application/json

operation"assets" | "domain"required

Operation to run. - `assets`: update the visual assets shown during the Biometric PIX journey. - `domain`: update the merchant's redirect domain.

payloadobject

Operation data. The expected schema depends on `operation`.

Show payload properties

url_logostring<uri>

Public URL of the merchant's logo image. Must be reachable without authentication.

primary_colorstring

Primary color, in hexadecimal format.

secondary_colorstring

Secondary color, in hexadecimal format.

url_fontstring<uri>

Google Fonts CSS link used to load the font with its weight and style variants.

name_fontstring

Merchant's typeface family name.

Response

Operation completed successfully. The response has no body, the HTTP status is the only confirmation.

Invalid request. Check required fields, formats, and accepted values.

statusCodeinteger

HTTP status code of the error.

errorstring

Short HTTP error name.

messagestring

Detailed error message.

Invalid credentials or expired token. Generate a new access token.

statusCodeinteger

HTTP status code of the error.

errorstring

Short HTTP error name.

messagestring

Detailed error message.

Resource not found; for example, the seller_id does not exist or is not enabled for PIX.

statusCodeinteger

HTTP status code of the error.

errorstring

Short HTTP error name.

messagestring

Detailed error message.

Internal server error, or a failure communicating with the pix-openfinance-merchant-adp adapter. Retry with exponential backoff; contact Getnet support if it persists.

statusCodeinteger

HTTP status code of the error.

errorstring

Short HTTP error name.

messagestring

Detailed error message.

curl -X POST "https://api.pre.globalgetnet.com/dpm/pix/v1/merchants/openfinance" \ -H "Content-Type: application/json" \ -H "x-seller-id: <x-seller-id>" \ -H "username: <username>" \ -d '{ "operation": "assets", "payload": { "url_logo": "https://resources.linaopenx.com.br/fa_getnet_completo_r", "primary_color": "#FF0000", "secondary_color": "#FFFFFF", "url_font": "https://fonts.googleapis.com/css2?family=Amaranth:ital", "name_font": "Roboto" } }'

const response = await fetch(`https://api.pre.globalgetnet.com/dpm/pix/v1/merchants/openfinance`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ "operation": "assets", "payload": { "url_logo": "https://resources.linaopenx.com.br/fa_getnet_completo_r", "primary_color": "#FF0000", "secondary_color": "#FFFFFF", "url_font": "https://fonts.googleapis.com/css2?family=Amaranth:ital", "name_font": "Roboto" } }) }); const data = await response.json();

import requests response = requests.request( "POST", "https://api.pre.globalgetnet.com/dpm/pix/v1/merchants/openfinance", json={ "operation": "assets", "payload": { "url_logo": "https://resources.linaopenx.com.br/fa_getnet_completo_r", "primary_color": "#FF0000", "secondary_color": "#FFFFFF", "url_font": "https://fonts.googleapis.com/css2?family=Amaranth:ital", "name_font": "Roboto" } }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.pre.globalgetnet.com/dpm/pix/v1/merchants/openfinance"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "operation": "assets", "payload": { "url_logo": "https://resources.linaopenx.com.br/fa_getnet_completo_r", "primary_color": "#FF0000", "secondary_color": "#FFFFFF", "url_font": "https://fonts.googleapis.com/css2?family=Amaranth:ital", "name_font": "Roboto" } }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://api.pre.globalgetnet.com/dpm/pix/v1/merchants/openfinance", strings.NewReader(`{ "operation": "assets", "payload": { "url_logo": "https://resources.linaopenx.com.br/fa_getnet_completo_r", "primary_color": "#FF0000", "secondary_color": "#FFFFFF", "url_font": "https://fonts.googleapis.com/css2?family=Amaranth:ital", "name_font": "Roboto" } }`)) req.Header.Set("Content-Type", "application/json") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.pre.globalgetnet.com/dpm/pix/v1/merchants/openfinance")) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString("{\n \"operation\": \"assets\",\n \"payload\": {\n \"url_logo\": \"https://resources.linaopenx.com.br/fa_getnet_completo_r\",\n \"primary_color\": \"#FF0000\",\n \"secondary_color\": \"#FFFFFF\",\n \"url_font\": \"https://fonts.googleapis.com/css2?family=Amaranth:ital\",\n \"name_font\": \"Roboto\"\n }\n}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.pre.globalgetnet.com/dpm/pix/v1/merchants/openfinance") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/json" request.body = "{\n \"operation\": \"assets\",\n \"payload\": {\n \"url_logo\": \"https://resources.linaopenx.com.br/fa_getnet_completo_r\",\n \"primary_color\": \"#FF0000\",\n \"secondary_color\": \"#FFFFFF\",\n \"url_font\": \"https://fonts.googleapis.com/css2?family=Amaranth:ital\",\n \"name_font\": \"Roboto\"\n }\n}" response = http.request(request) puts response.body