Criar consentimento
Criar consentimento
- application/json
Request Body required
- paymentId string required
Identificador do pagamento
- requestId string required
Identificador da requisição
- pixMessage string
Informações adicionais sobre um pagamento, a serem enviadas ao destinatário
organization object required
id string requiredIdentificador da organização
name string requiredNome da organização
logoUrl string requiredLogo da organização
debtor object required
document string requiredPossible values:
<= 11 characters
, Value must match regular expression/^\d{11}$/
Número do documento do pagador (pessoa física)
documentType string requiredPossible values: [
CPF
]Tipo de documento do pagador (pessoa física)
company object
document string requiredPossible values:
<= 14 characters
, Value must match regular expression/^\d{14}$/
Número do documento da empresa do pagador (pessoa jurídica)
documentType string requiredPossible values: [
CNPJ
]Tipo de documento da empresa do pagador (pessoa jurídica)
- 200
- application/json
- Schema
- Example (from schema)
Schema
- paymentId string required
Identificador do pagamento
- externalId string required
Identificador externo do pagamento
- code string required
Default value:
A01
Código de resposta da requisição
- message string required
Default value:
Pagamento foi requisitado
Mensagem de resposta da requisição
- requestId string required
Identificador da requisição
- consentId string required
Identificador do consentimento
- paymentUrl string required
URL para o White Label
organization object required
id string requiredIdentificador da organização
name string requiredNome da organização
logoUrl string requiredLogo da organização
{
"paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
"externalId": "10518",
"code": "A01",
"message": "Pagamento foi requisitado",
"requestId": "e04f146c-2758-4fbb-a2b2-75cbf9415dws",
"consentId": "75671765-8b3f-42a8-9b9c-f1f3db31c20d",
"paymentUrl": "https://checkout.openfinancefcamara.com/iniciador",
"organization": {
"id": "b397dd9c-62b2-4632-bce7-85f56666c083",
"name": "BTG Banking",
"logoUrl": "https://banking-public-prd.s3.sa-east-1.amazonaws.com/open-finance/logo/btginvestimentos/btginvestimentos.svg"
}
}