Contas Bancárias

Obter Todas as Contas Bancárias

Obter Todas as Contas Bancárias

Obter Todas as Contas Bancárias

GET{{base_url}}/api/bank_accounts

Response

200

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/bank_accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Exemplo de Response

{
    "data": [
        {
            "type": "bank_accounts",
            "id": "2",
            "attributes": {
                "entity_type": "User",
                "description": null,
                "name": "BANCO BPI, SA",
                "nib": "001049282327079673218",
                "swift": "BBPIPTPL",
                "iban": "PT50001049282327079673218",
                "initial_balance": null,
                "sub_type": "ticket_account",
                "card_number": "",
                "account_type": "DO",
                "only_one_payment": null,
                "is_connected": false,
                "consent_until": null
            },
            "relationships": {
                "supplier": {
                    "data": null
                },
                "user": {
                    "data": {
                        "type": "current_company_users",
                        "id": "800000863"
                    }
                }
            }
        },
        
        (...)
    
    ]
}

Obter Contas Bancária por ID

Obter Conta Bancária por Id

Obter Conta Bancária por Id

GET{{base_url}}/api/bank_accounts/{bankAccountId}

Path parameters

bankAccountId*string

Id da conta bancária

Example: "5"

Response

200

Sucesso

Headers

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/bank_accounts/{bankAccountId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "attributes": {
      "account_type": "DO",
      "card_number": "",
      "consent_until": null,
      "description": null,
      "entity_type": "User",
      "iban": "PT50001049282327079673218",
      "initial_balance": null,
      "is_connected": false,
      "name": "BANCO BPI, SA",
      "nib": "001049282327079673218",
      "only_one_payment": null,
      "sub_type": "ticket_account",
      "swift": "BBPIPTPL"
    },
    "id": "2",
    "relationships": {
      "supplier": {
        "data": null
      },
      "user": {
        "data": {
          "id": "800000863",
          "type": "current_company_users"
        }
      }
    },
    "type": "bank_accounts"
  }
}

Criar Conta Bancária

Criar Contas Bancárias de Utilizador

Criar Contas Bancárias de Utilizador

POST{{base_url}}/api/bank_accounts

Body

application/json

dataobject

Response

200

Sucesso / Sucesso

Headers

Body

application/json

dataobject

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/bank_accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": {
        "attributes": {
          "account_type": "DO",
          "card_number": "",
          "consent_until": null,
          "description": "<p>Descrição de Conta Bancária</p>",
          "entity_id": 4,
          "entity_type": "Supplier",
          "iban": "PT50001049282327079673219",
          "initial_balance": null,
          "is_connected": false,
          "name": "BANCO BPI, SA",
          "nib": "001049282327079673219",
          "only_one_payment": null,
          "sub_type": "ticket_account",
          "swift": "BBPIPTPL",
          "__$markdownParsed": true
        },
        "type": "bank_accounts"
      }
    }),
});
const data = await response.json();

Response

200

{
  "data": {
    "attributes": {
      "account_type": "DO",
      "card_number": "",
      "consent_until": null,
      "description": "Descrição de Conta Bancária de Utilizador",
      "entity_type": "User",
      "iban": "PT50001049282327079673219",
      "initial_balance": null,
      "is_connected": false,
      "name": "BANCO BPI, SA",
      "nib": "001049282327079673219",
      "only_one_payment": null,
      "sub_type": "ticket_account",
      "swift": "BBPIPTPL"
    },
    "id": "13",
    "relationships": {
      "supplier": {
        "data": null
      },
      "user": {
        "data": null
      }
    },
    "type": "bank_accounts"
  }
}

Remover Conta Bancária

Remover Contas Bancárias

Remover Contas Bancárias

DELETE{{base_url}}/api/bank_accounts/{bankAccountId}

Path parameters

bankAccountId*string

Id da conta bancária

Example: "5"

Response

200

Sucesso

Headers

Body

application/json

metaobject

Request

JavaScriptCurlPython

const response = await fetch('{{base_url}}/api/bank_accounts/{bankAccountId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "meta": {}
}