Criar um Parceiro

Importante

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

Todos os parceiros da USEND que desejam utilizar o USEND PAY, precisam ser cadastrados previamente para receberem as suas Chaves de API, antes de utilizar qualquer recurso.

POST/v1/partners

Parâmetros#

Atributo	Obrigatório	Tipo
company_name	sim	string
document_number	sim	string
site_url	sim	string
managing_partner	sim	object
managing_partner[name]	sim	string
managing_partner[document_number]	sim	string
managing_partner[email]	sim	string
managing_partner[phone_number]	sim	string
exchangerate_id	não	string

Request#

HEADERS

Content-Type

api_key

BODY

company_name

document_number

site_url

managing_partner

managing_partner[name]

managing_partner[document_number]

managing_partner[email]

managing_partner[phone_number]

exchangerate_id

Atenção

Uma vez criado, um partner não pode mais ser deletado em ambos os ambientes. Se for necessário desabilitar um parceiro futuramente, utilize o recurso PATCH passando o parâmetro active como false.

Exemplos#

200 | OK

Request


  curl POST https://usendpay.marlim.co/v1/partners
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{
    "company_name": "Galactic Republic",
    "document_number": "25000BBY",
    "site_url": "https://starwars.anewhope.sw",
    "managing_partner[name]": "Darth Sidious",
    "managing_partner[document_number]": "11122233344",
    "managing_partner[email]": "sidious@anewhope.sw",
    "managing_partner[phone_number]": "+5511988776655"
  }

Response

{
  "active": true,
  "company_name": "Galactic Republic",
  "id": "pa_Ewoks432Leia123Solo",
  "date_created": "1977-05-25T00:00:00.000Z",
  "exchangerate_id": "",
  "api_keys": {
    "test": "uak_test_C-3PO-S1e2e3Threepio",
    "live": "uak_live_R2-D2-A1r2too-Deetoo"
  }
}