Retornar Parceiros

Importante

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

Todos os Parceiros

Retorna um array de objetos com todos os parceiros.

GET/v1/partners

Exemplos

200 | OK

Request

  curl GET https://usendpay.marlim.co/v1/partners
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{}'

Response

[
  {
    "active": true,
    "id": "pa_Anakin777Luke666Skywalker",
    "date_created": "1983-05-25T00:00:00.000Z",
    "date_updated": "1983-05-25T00:00:00.000Z",
    "company_name": "Galactic Empire",
    "document_number": "0BBY5BBY",
    "site_url": "https://starwars.returnofthejedi.sw",
    "exchangerate_id": "",
    "managing_partner": {
      "document_number": "11122233344",
      "name": "Darth Vader",
      "phone_number": "+5511988776655",
      "email": "vader@returnofthejedi.sw"
    },
    "api_keys": {
      "test": "uak_test_C-3PO-S1e2e3Threepio",
      "live": "uak_live_R2-D2-A1r2too-Deetoo"
    }
  },
  {
    "active": true,
    "id": "pa_Yoda987ObiWanKenobi678",
    "date_created": "1978-04-21T00:00:00.000Z",
    "date_updated": "1978-04-21T00:00:00.000Z",
    "company_name": "Galactic Senate",
    "document_number": "1032BBY",
    "site_url": "https://starwars.theempirestrikesback.sw",
    "exchangerate_id": "",
    "managing_partner": {
      "document_number": "11122233344",
      "name": "Vice Chair",
      "phone_number": "+5511988776655",
      "email": "chair@theempirestrikesback.sw"
    },
    "api_keys": {
      "test": "uak_test_C-3PO-S1e2e3Threepio",
      "live": "uak_live_R2-D2-A1r2too-Deetoo"
    }
  },
  {
    "active": true,
    "id": "pa_Ewoks432Leia123Solo",
    "date_created": "1977-05-25T00:00:00.000Z",
    "date_updated": "1977-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 Sidious",
      "phone_number": "+5511988776655",
      "email": "sidious@anewhope.sw"
    },
    "api_keys": {
      "test": "uak_test_C-3PO-S1e2e3Threepio",
      "live": "uak_live_R2-D2-A1r2too-Deetoo"
    }
  }
]

Filtrar por Número de Documento

Retorna um objeto com o parceiro filtrado usando a variável document_number.

GET/v1/partners?document_number={{value}}

Variáveis Path

Atributo	Obrigatório	Tipo
document_number	sim	string

Exemplos

200 | OK

Request

  curl GET https://usendpay.marlim.co/v1/partners?document_number=25000BBY
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{}'

Response

{
  "active": true,
  "id": "pa_Ewoks432Leia123Solo",
  "date_created": "1977-05-25T00:00:00.000Z",
  "date_updated": "1977-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 Sidious",
    "phone_number": "+5511988776655",
    "email": "sidious@anewhope.sw"
  },
  "api_keys": {
    "test": "uak_test_C-3PO-S1e2e3Threepio",
    "live": "uak_live_R2-D2-A1r2too-Deetoo"
  }
}

Filtrar por ID do Parceiro

Retorna um objeto com o parceiro filtrado usando partner_id no PATH da URL.

GET/v1/partners/:partner_id

Path Url

Atributo	Obrigatório	Tipo
partner_id	sim	string

Exemplos

200 | OK

Request

  curl GET https://usendpay.marlim.co/v1/partners/pa_Anakin777Luke666Skywalker
  --H "Content-Type": "application/json"
  --H "api_key": "api_key_value"
  --data-raw '{}'

Response

{
  "active": true,
  "id": "pa_Anakin777Luke666Skywalker",
  "date_created": "1983-05-25T00:00:00.000Z",
  "company_name": "Galactic Empire",
  "document_number": "0BBY5BBY",
  "site_url": "https://starwars.returnofthejedi.sw",
  "exchangerate_id": "",
  "managing_partner": {
    "document_number": "11122233344",
    "name": "Darth Vader",
    "phone_number": "+5511988776655",
    "email": "vader@returnofthejedi.sw"
  },
  "api_keys": {
    "test": "uak_test_C-3PO-S1e2e3Threepio",
    "live": "uak_live_R2-D2-A1r2too-Deetoo"
  }
}