Enviar callback de consentimento
Enviar callback de consentimento
- application/json
Request Body required
- clientCallbackId string required
- state string required
- tokenId string nullable
- code string nullable
- error string nullable
- errorDescription string nullable
- 201
- application/json
- Schema
- Example (from schema)
Schema
- paymentId string required
Identificador do pagamento
- externalId string required
Identificador externo do pagamento
- parentPaymentId string
Identificador do pagamento pai para o qual foi solicitado o estorno
- value number required
Valor do pedido
- sandboxMode boolean required
Indica se este pagamento é ou não para ambiente sandbox
- status string required
Possible values: [
created
,requested
,denied
,settled
,cancelled
,refunded
]Status do pedido
- returnUrl string required
URL necessária para redirecionar o usuário final de volta à loja do comerciante ao fim do fluxo de pagamento
- callbackProtocol string required
Possible values: [
HTTP
,NATS
]Protocolo utilizado para notificação de alterações de status do pagamento
- callbackAddress string required
URL para notificação de alterações de status do pagamento
- paymentUrl string
URL para o White Label
creditor object required
name string requiredNome do recebedor
document string requiredDocumento do recebedor
pixKeyToReceive stringChave PIX do recebedor para recebimento do pagamento
debtor object required
name string requiredNome do pagador
organization object required
id stringIdentificador da organização
name stringNome da organização
logoUrl stringLogo da organização
termsOfServiceUrl stringURL com os termos de serviço da organização
- pixMessage string
Informações adicionais sobre um pagamento, a serem enviadas ao destinatário
- createdAt string required
Data de criação
- updatedAt string required
Data da última atualização
- deletedAt string
Data de exclusão
theme object
faviconUrl string requiredDefault value:
https://fcamara.com/wp-content/uploads/2022/12/cropped-favicon-1-32x32.png
URL do favicon do cliente
logoUrl string requiredDefault value:
https://fcamara.nacao.digital/wp-content/uploads/2022/08/logo-1.png
Logo do cliente
primaryColor string requiredDefault value:
#4b4fa1
Cor primária do cliente
secondaryColor string requiredDefault value:
#eb6744
Cor secundária do cliente
{
"paymentId": "62a7a20a-df7d-402a-9f95-251c9575f7a9",
"externalId": "10518",
"parentPaymentId": "12a7a20a-df7d-402a-9f95-333c9575f7b7",
"value": 95.9,
"sandboxMode": true,
"status": "created",
"returnUrl": "https://api.mystore.example.com/checkout/order/1072430428324",
"callbackProtocol": "HTTP",
"callbackAddress": "https://api.mystore.example.com/some-path/to-notify/status-changes",
"paymentUrl": "https://checkout.openfinancefcamara.com/iniciador",
"creditor": {
"name": "FCamara - Consultoria Especializada",
"document": "03775758000190",
"pixKeyToReceive": "0377*******"
},
"debtor": {
"name": "Rodrigo Lucio"
},
"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",
"termsOfServiceUrl": "null"
},
"pixMessage": "Pagamento da nota XPTO035-002",
"createdAt": "2022-09-28T17:25:14.000Z",
"updatedAt": "2022-09-28T17:42:22.000Z",
"deletedAt": "null",
"theme": {
"faviconUrl": "https://fcamara.com/wp-content/uploads/2022/12/cropped-favicon-1-32x32.png",
"logoUrl": "https://fcamara.nacao.digital/wp-content/uploads/2022/08/logo-1.png",
"primaryColor": "#4b4fa1",
"secondaryColor": "#eb6744"
}
}