Ir para a documentação
SparkGlimSparkGlim Programadores
Pesquisar em toda a documentação

Experimente um tema na sua língua ou um caminho API exato.

    Referência API

    Configurar método de pagamento aprovado

    Cria configuração de pagamento com permissões e aprovação; não ativa prestadores arbitrários.

    POSThttps://api.sparkglim.net/api/white-label/portal/reseller/payment-methods

    Modelo de acesso

    Modelo de acesso
    Sessão SparkGlim e permissões de membro
    Âmbito necessário
    payments:write
    Disponibilidade documentada
    Implementado no código

    Disponibilidade verificada no código, sem garantia de produção.

    Use o fluxo de membros da equipa Criador. A revenda não concede acesso ilimitado à base ou administração.

    Cabeçalhos

    NomeTipoValidação
    AuthorizationObrigatório

    Sessão Bearer SparkGlim existente; associação e capacidades atribuídas autorizam cada operação no servidor.

    stringValidação: Token Bearer de uma sessão autenticada existente.

    Pedido

    NomeTipoValidação
    providerTypeObrigatório

    Configuração aprovada de pagamento de revenda; dados sensíveis protegidos pelo servidor.

    enumValidação: paystack | expresspay | hubtel | manual.
    methodTypeObrigatório

    Configuração aprovada de pagamento de revenda; dados sensíveis protegidos pelo servidor.

    enumValidação: bank | mobile_money | card | wallet.
    ownerMemberIdOpcional

    Relação ou revisão existente da conta; propriedade e capacidades são verificadas no servidor.

    string|nullValidação: UUID.
    ownerCreatorIdOpcional

    Relação ou revisão existente da conta; propriedade e capacidades são verificadas no servidor.

    string|nullValidação: UUID.
    labelOpcional

    Configuração aprovada de pagamento de revenda; dados sensíveis protegidos pelo servidor.

    string|nullValidação: <=120.
    publicDetailsOpcional

    Configuração aprovada de pagamento de revenda; dados sensíveis protegidos pelo servidor.

    objectValidação: Objeto JSON.
    encryptedDetailsOpcional

    Configuração aprovada de pagamento de revenda; dados sensíveis protegidos pelo servidor.

    objectValidação: Configuração protegida no servidor; nunca publique credenciais.
    metadataOpcional

    Metadados JSON aceites; nunca substituem autorização, preços ou propriedade.

    objectValidação: Objeto JSON.

    Pedido

    Os exemplos descrevem o contrato e não são executados. Use registos de teste autorizados; nunca cole segredos reais aqui.

    POST /api/white-label/portal/reseller/payment-methods
    http
    POST /api/white-label/portal/reseller/payment-methods HTTP/1.1
    Host: api.sparkglim.net
    Authorization: Bearer <EXISTING_SESSION_TOKEN>
    Content-Type: application/json
    
    {
      "providerType": "manual",
      "methodType": "bank",
      "label": "Example approved method"
    }

    Resposta

    Resposta de sucesso · HTTP 201
    json
    {
      "success": true,
      "data": {
        "id": "11111111-1111-4111-8111-111111111111",
        "status": "pending"
      }
    }
    Resposta de erro · HTTP 400
    json
    {
      "success": false,
      "error": "<ERROR_MESSAGE>"
    }

    Validação, permissões, registos indisponíveis e falhas usam estado HTTP e erro do controlador.

    Limites e novas tentativas

    Limite padrão: 100 pedidos por IP em 60 segundos. Aplicam-se também controlos específicos.

    Compatibilidade do código

    As operações autorizadas exigem testes específicos da conta.

    • server/src/api/router.ts
    • server/src/api/routes/white-label.ts
    • server/src/white-label/reseller-service.ts
    • server/src/white-label/schemas.ts