Atualizar um Parceiro

Importante

Todos os recursos disponíveis nos endpoints /partners/* são direcionados apenas aos time de desenvolvimento da USEND.

Utlize esse recurso para atualizar dados ou desabilitar um parceiro. Desabilitar um parceiro, significa que a api_key utlizada pelo parceiro não terá mais acesso a nenhum recurso da API do USEND PAY.

Parceiros desabilitados, poderão ser habilitados novamente no futuro. Essa ação não é permanente.

PATCH/v1/partners/:partner_id

Parâmetros Permitidos

Atributo	Obrigatório	Tipo
active	não	boolean
site_url	não	string
exchangerate_id	não	string
managing_partner[name]	não	string
managing_partner[document_number]	não	string
managing_partner[email]	não	string
managing_partner[phone_number]	não	string

Request

HEADERS

Content-Type

application/json

api_key

api_key_value

Deve ser passado no HEADER da requisição.

BODY

active

boolean

Desabilitar ou reativiar um parceiro.

site_url

string

Site do parceiro.

exchangerate_id

string

ID do exchangerate do parceiro.

managing_partner[name]

string

Nome do sócio/responsável pelo cadastro do CNPJ.

managing_partner[document_number]

string

CPF/NIN do sócio/responsável pelo cadastro do CNPJ.

managing_partner[email]

string

Email do sócio/responsável pelo cadastro do CNPJ.

managing_partner[phone_number]

string

Número de telefone do sócio/responsável pelo cadastro do CNPJ.

Importante

Por segurança e validação interna, uma vez criado, os valores company_name e document_number de um parceiro são inalteráveis. Se o parceiro for criado com esses valores de forma incorreta, crie um novo parceiro e descarte o partner_id antigo.

200 | OK

Request

  curl PATCH https://usendpay.marlim.co/v1/partners/pa_Ewoks432Leia123Solo
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{
    "managing_partner[name]": "Darth Vader",
    "managing_partner[email]": "vader@sith.sw"
  }

Response

{
  "active": true,
  "date_created": "1977-05-25T00:00:00.000Z",
  "date_updated": "1983-05-25T00:00:00.000Z",
  "company_name": "Galactic Republic",
  "document_number": "25000BBY",
  "site_url": "https://starwars.anewhope.sw",
  "exchangerate_id": "",
  "managing_partner": {
    "document_number": "11122233344",
    "name": "Darth Vader",
    "phone_number": "+5511988776655",
    "email": "vader@sith.sw"
  }
}