Criar entidade e associá-la à integração

informação

Este recurso apenas está disponível para determinado tipo de integração.

Este recurso permite criar uma entidade na PayPay e que a mesma fique asssociada à integração que está a realizar o pedido. Permitindo assim, utilizar os mesmos dados de autenticação e necessitar apenas de alterar o header PayPay-ClientId (NIF da entidade) para o da entidade associada e começar a realizar na respetiva entidade.

aviso

A criação da entidade através deste recurso seguirá todos os processos de compliance necessários.

Pedido

POST /entities

{
    "clientId": "123456789",
    "name": "Entidade Teste Lda",
    "phoneNumber": "707451451",
    "address": "Estrada Regional 104 ",
    "postCode": "9000-025",
    "locality": "Funchal",
    "permanentCertificate": "1234-5678-9101",
    "economicActivity": {
        "section": "K",
        "code": 668
    },
    "availableMethods": [
        {
            "code": "CC"
        },
        {
            "code": "MB"
        },
        {
            "code": "MW"
        }
    ],
    "user": {
        "name": "John Doe",
        "taxNumber": "123456789",
        "email": "email@email.email",
        "phoneNumber": "960000000",
        "isPoliticallyExposedPerson": true
    }
}

Resposta

{
  "clientId": "123456789",
  "name": "Entidade PayPay",
  "createdAt": "2021-10-07T17:01:19+00:00"
  "stateDetails": {
	"state": "pending",
	"updatedAt": "2021-10-07T17:01:19+00:00"
  }
}

A estrutura de dados completa, bem como as opções para economicActivity e availableMethods pode ser consultada .