Referência de parâmetros de URL
A entrada de pagamento (NewPayOrder) e a entrada de salvar método (NewPayMethod) leem instruções do endereço com que são abertas. É assim que um botão Pay fixa o valor de uma taxa de candidatura, que o link de dados bancários de um fornecedor sabe a qual conta pertence e que uma página de portal pode pré-selecionar um perfil. Um valor no endereço prevalece sobre a mesma configuração no componente; consulte a Referência das configurações de componentes.
Antes de começar: os parâmetros vêm depois de ? e são separados por &. Valores com espaços ou pontuação precisam ser codificados para URL (um espaço vira %20). Os Ids de registro são os Ids do Salesforce de 15 ou 18 caracteres.
O endereço interno de pagamento é /lightning/cmp/rpay__NewPayOrder; em um site, é a página que contém o componente de entrada, por exemplo https://yourcompany.my.site.com/portal/s/new-pay-order.
Parâmetros da entrada de pagamento (NewPayOrder)
Quem e onde
| Parâmetro | Valor | Significado |
|---|
rpay__rid | Id de registro | O registro pai: uma conta, um contato ou um lead. Em uma página de registro, o PayButton o acrescenta para você. Obrigatório, a menos que a página seja de portal e identifique o usuário conectado, ou que rpay__oid esteja presente |
rpay__custid | Id do Pay Customer | Usa este Pay Customer em vez de procurar um a partir do registro pai |
rpay__ppid | Id do Pay Profile | Usa este perfil sem perguntar |
rpay__pid | Id da Processing Account | Usa esta conta sem perguntar |
rpay__pfid | Id da Processing Account | Envia a taxa de conveniência para esta conta |
rpay__lid, rpay__cid, rpay__aid, rpay__oppid | Id de lead, contato, conta, oportunidade | Vincula a ordem a esses registros, além do registro pai |
rpay__oid | Id de ordem criptografado | Abre um link de pagamento existente. O REDA Pay o inclui em todo Link URL; nunca o monte você mesmo |
Que tipo de pagamento
| Parâmetro | Valor | Significado |
|---|
rpay__ttype | rcpt ou disb | Fixa a direção: recebimento ou desembolso |
rpay__otype | imm, schd ou lnk | Fixa o tipo de ordem: pagar agora, agendar ou link de pagamento |
rpay__card | 1 ou 0 | Permite ou oculta cartões |
rpay__bank | 1 ou 0 | Permite ou oculta contas bancárias |
rpay__noimm | 1 | Oculta o botão Pay |
rpay__nosch | 1 | Oculta o botão Schedule |
rpay__nolnk | 1 | Oculta o botão Create Link |
rpay__noemd | 1 | Oculta a chave Earnest Money Deposit |
Valor, taxas e observações
| Parâmetro | Valor | Significado |
|---|
rpay__amount | Um número, por exemplo 250 ou 1250.50 | Pré-preenche o valor. Um valor que não seja número é ignorado |
rpay__fixamt | 1 | O valor não pode ser alterado (aparece como texto). Use com rpay__amount |
rpay__nofee | 1 | Nenhuma taxa de conveniência nesta ordem |
rpay__cfee | Um número | Substitui a taxa de conveniência calculada por este valor |
rpay__cnotes | Texto | Customer Notes, exibidas ao pagador e gravadas na ordem |
rpay__att1 … rpay__att4 | Texto | Attribute 1–4 na ordem, para as suas automações e relatórios |
rpay__geoskip | 1 | Não pede a localização ao navegador |
Parâmetros da entrada de salvar método (NewPayMethod)
| Parâmetro | Valor | Significado |
|---|
rpay__rid | Id de registro | O registro pai (conta, contato ou lead). Obrigatório junto com rpay__custid, ou no lugar dele |
rpay__custid | Id do Pay Customer | O cliente a quem o método pertence |
rpay__ppid | Id do Pay Profile | Usa este perfil sem perguntar |
rpay__ttype | rcpt ou disb | Para que o método pode ser usado |
rpay__default | 1 ou 0 | Torna o método salvo o padrão do cliente |
rpay__card, rpay__bank | 1 ou 0 | Permite ou oculta cada tipo |
rpay__curr | USD ou CAD | Pré-preenche a moeda da conta bancária |
rpay__cnotes | Texto | Uma observação exibida na tela |
rpay__lid, rpay__cid, rpay__aid | Ids | Vincula o método a esses registros |
Exemplos práticos
| Objetivo | Endereço |
|---|
| Botão de taxa de candidatura em um lead: $75, inalterável, cartão ou banco, só pagar agora | /lightning/cmp/rpay__NewPayOrder?rpay__amount=75&rpay__fixamt=1&rpay__ttype=rcpt&rpay__nosch=1&rpay__nolnk=1&rpay__cnotes=Application%20fee (o PayButton acrescenta rpay__rid) |
| Botão de repasse em uma conta, fixado em uma conta de processamento | /lightning/cmp/rpay__NewPayOrder?rpay__ttype=disb&rpay__ppid=a00…&rpay__pid=a01… |
| Endereço para só criar um link de pagamento, sem taxa, só banco | /lightning/cmp/rpay__NewPayOrder?rpay__rid=003…&rpay__otype=lnk&rpay__nofee=1&rpay__card=0 |
| Link de dados bancários de fornecedor no seu site público | https://yourcompany.my.site.com/public/s/process-method-link?rpay__rid=001…&rpay__ttype=disb&rpay__default=1&rpay__card=0 |
| Página de portal que pré-seleciona um perfil para todos os moradores | Coloque rpay__ppid=a00… no endereço que a navegação do portal usa, ou defina Limit Profile Selection no componente |
Uma fórmula de botão personalizado em lead fica, por exemplo, assim:
/lightning/cmp/rpay__NewPayOrder?rpay__rid={!Lead.Id}&rpay__amount=75&rpay__fixamt=1&rpay__ttype=rcpt
Regras de precedência
- Um valor na URL prevalece sobre a configuração do componente para a mesma opção.
- Nenhum dos dois pode oferecer mais do que a Processing Account e o Pay Customer permitem; eles só removem opções.
- Um perfil ou uma conta passados por Id precisam estar ativos e pertencer um ao outro; caso contrário, a tela não consegue usá-los.
rpay__oid (um link de pagamento) assume o controle: valem o valor, a escolha de taxa e as restrições de método da própria ordem, e só o Pay fica disponível.
Erros comuns a evitar
| Erro | O que acontece | Solução |
|---|
Esquecer o rpay__rid em um link de método | "Bad Request. Parent record not found." | Acrescente o Id da conta, do contato ou do lead |
rpay__amount=100e ou $100 | O valor é ignorado e fica editável | Só dígitos e um ponto decimal |
rpay__fixamt=1 sem um valor | Não há o que fixar; o pagador digita o valor | Acrescente rpay__amount |
Passar o Code de um Pay Profile em rpay__ppid | Não encontrado | rpay__ppid recebe o Id do registro; os códigos vão no Limit Profile Selection do componente |
O que vem a seguir
