Contas Bancárias

Obter Todas as Contas Bancárias

Obter Todas as Contas Bancárias

get

Obter Todas as Contas Bancárias

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

200Success

No content

get

/api/bank_accounts

HTTPcURLJavaScriptPython

GET /api/bank_accounts HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200Success

No content

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

get

Obter Conta Bancária por Id

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

bankAccountIdstringRequired

Id da conta bancária

Example: 5

Responses

200

Sucesso

application/json

get

/api/bank_accounts/{bankAccountId}

HTTPcURLJavaScriptPython

GET /api/bank_accounts/{bankAccountId} HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Sucesso

{
  "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

post

Criar Contas Bancárias de Utilizador

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Body

application/json

Responses

200

Sucesso / Sucesso

application/json

post

/api/bank_accounts

HTTPcURLJavaScriptPython

POST /api/bank_accounts HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "data": {
    "attributes": {
      "account_type": "DO",
      "card_number": "",
      "consent_until": null,
      "description": "Descrição de Conta Bancária",
      "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"
    },
    "type": "bank_accounts"
  }
}

Criar Contas Bancárias de FornecedorCriar Contas Bancárias de Utilizador

200

Sucesso / Sucesso

{
  "data": {
    "attributes": {
      "account_type": "DO",
      "card_number": "",
      "consent_until": null,
      "description": "Descrição de Conta Bancária",
      "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"
    },
    "id": "7",
    "relationships": {
      "supplier": {
        "data": null
      },
      "user": {
        "data": null
      }
    },
    "type": "bank_accounts"
  }
}

Remover Conta Bancária

Remover Contas Bancárias

delete

Remover Contas Bancárias

Required scopes

This endpoint requires the following scopes:

• : commercial

Authorizations

oauth2

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

bankAccountIdstringRequired

Id da conta bancária

Example: 5

Responses

200

Sucesso

application/json

delete

/api/bank_accounts/{bankAccountId}

HTTPcURLJavaScriptPython

DELETE /api/bank_accounts/{bankAccountId} HTTP/1.1
Host: {{base_url}}
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Sucesso

{
  "meta": {}
}