API de Payouts
Para termos introdutórios, como solicitar este serviço e mais informações, consulte Payouts.
Como configurar a autenticação
Para usar os métodos de gerenciamento de Payouts ou WebHooks expostos pelo serviço de Payouts, você deve incluir os cabeçalhos Authorization
e PublicKey
:
- Para configurar o cabeçalho
Authorization
, use o Método de autenticação fornecido pelo serviço de Payouts.
Exemplo:
Bearer eyJhbGciOiJIUzI1NiJ9.eyJSb2xlIjoiQWRtaW4iLCJJc3N1ZXIiOiJJc3N1ZXIiLCJVc2VybmFtZSI6IkphdmFJblVzZSIsImV4cCI6MTYyODU0ODE2NywiaWF0IjoxNjI4NTQ4MTY3fQ.jrO3u5ramYKOvoNNb0TNfBuZkbYg1EvPmCDDYXFEO4c
- Para configurar o cabeçalho
PublicKey
, use sua chave pública, que pode ser encontrada no Módulo PayU (Configuração > Configuração técnica > Chave pública).
Métodos disponíveis
A API de Payouts inclui os seguintes métodos:
- Autenticação
- Solicitar payout
- Cancelar ordem de Payout
- Criar ou atualizar um WebHook
- Excluir um WebHook
- Consultar WebHooks
Autenticação
A primeira etapa, seja qual for o método que você deseja solicitar, é autenticar sua conta usando as credenciais fornecidas pelo PayU.
O método autenticação registra o comércio retornando o Token JWT gerado para usar os serviços expostos pelos Payouts. Este token fica disponível durante 10 minutos após sua criação.
Chamada API
Para autenticar, envie a solicitação da seguinte forma:
POST
https://{env-api}.payulatam.com/v1.0/authenticate?accountId={accountId}&apiKey={apiKey}&apiLogin={apiLogin}
O valor da variável {env-api}
mostrado acima é sandbox-transfers
para teste e transfers
para o modo de produção.
Parâmetro | Descrição | Obrigatório |
---|---|---|
accountId | ID da conta do usuário para cada país associado ao comércio. | Sim |
apiKey | Senha fornecida pelo PayU. Como faço para obter minha API key | Sim |
apiLogin | Usuário ou login fornecido pelo PayU. Como faço para obter minha API Login | Sim |
Exemplo resposta
{
"token": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJSb2xlIjoiQWRtaW4iLCJJc3N1ZXIiOiJJc3N1ZXIiLCJVc2VybmFtZSI6IkphdmFJblVzZSIsImV4cCI6MTYyODU0ODE2NywiaWF0IjoxNjI4NTQ4MTY3fQ.jrO3u5ramYKOvoNNb0TNfBuZkbYg1EvPmCDDYXFEO4c"
}
Solicitar payout
Este método permite que você crie uma ou várias solicitações de Payouts para beneficiários, que podem ser novas ou existentes. Assim que você cria a solicitação, ela passa pelos estados disponíveis para Payouts.
Observação
Você precisa incluir dois cabeçalhos para usar este método, consulte Configurar autenticação para obter mais informações. Além disso, você precisa saber seu ID de vendedor e conta, você pode obter essas informações no seu Módulo PayU.Chamada API
Para criar um pedido de Payout, use a seguinte URL:
POST
https://{env-api}.payulatam.com/v1.0/supplier-transfers/{merchantId}/{accountId}
O valor da variável {env-api}
mostrado acima é sandbox-transfers
para teste e transfers
para o modo de produção.
Parâmetro | Descrição | Obrigatório |
---|---|---|
merchantId | Número de identificação do comércio no sistema PayU. | Sim |
accountId | ID da conta do usuário para cada país associado ao comércio. | Sim |
Ambos os parâmetros podem ser encontrados em seu módulo PayU.
Variáveis para pedido e resposta
Parâmetros de pedido
Nome do campo | Formato | Tamanho | Descrição | Obrigatório |
---|---|---|---|---|
transfers | Lista | Lista das transferências que você deseja criar. | Sim | |
transfers[n] > value | Numérico | Valor a ser transferido de seus fundos. A moeda deste valor é a que está configurada em sua conta PayU | Sim | |
transfers[n] > bankAccount | Este objeto contém as informações da conta bancária do beneficiário que receberá o pagamento. O beneficiário pode ser existente ou novo. |
Sim | ||
transfers[n] > bankAccount > id | Alfanumérico | 36 | Identificador da conta bancária do beneficiário. Envie este parâmetro quando quiser solicitar um pagamento para um beneficiário existente. |
Não |
transfers[n] > bankAccount > supplierType | Alfanumérico | Mín:11 Máx:16 | RTipo de relacionamento entre você e o beneficiário. Você pode escolher um dos seguintes valores:
Este parâmetro é obrigatório quando você está criando uma solicitação de pagamento para um novo beneficiário. |
Não |
transfers[n] > bankAccount > accountNumber | Alfanumérico | Máx:17 | Número da conta bancária do beneficiário. Este parâmetro é obrigatório quando você está criando uma solicitação de pagamento para um novo beneficiário. |
Não |
transfers[n] > bankAccount > bankCode | Numérico | Mín:3 Máx:4 | Código do banco que emitiu a conta do beneficiário. Veja os códigos de bancos. | Não |
transfers[n] > bankAccount > accountType | Alfanumérico | 2 | Definir CC para conta corrente e CA para conta poupança ou Nequi *.Este parâmetro é obrigatório quando você está criando uma solicitação de pagamento para um novo beneficiário. *Nequi está disponível na Colômbia. |
Não |
transfers[n] > bankAccount > country | Alfanumérico | 2 | País da conta bancária no formato ISO 3166 Alpha-2. Este parâmetro é obrigatório quando você está criando uma solicitação de pagamento para um novo beneficiário. |
Não |
transfers[n] > bankAccount > documentNumber | Numérico | 50 | Número de identificação do beneficiário. If the documentType is NIT , the document number must have a hyphen (- ) and the check digit. Exemplo: 830140299-6 .Este parâmetro é obrigatório quando você está criando uma solicitação de pagamento para um novo beneficiário. |
Não |
transfers[n] > bankAccount > documentType | Alfanumérico | 2 | Tipo de identificação do beneficiário. Veja os tipos de documentos. Este parâmetro é obrigatório quando você está criando uma solicitação de pagamento para um novo beneficiário. |
Não |
transfers[n] > bankAccount > expeditionDate | Alfanumérico | 10 | Data de expedição do documento de identidade. Formato YYYY/MM/DD . |
Não |
transfers[n] > bankAccount > fullName | Alfanumérico | Nome completo do beneficiário. Este parâmetro é obrigatório quando você está criando uma solicitação de pagamento para um novo beneficiário. |
Não | |
transfers[n] > bankAccount > birthDate | Alfanumérico | 10 | Data de nascimento do beneficiário. Formato YYYY/MM/DD . |
Não |
transfers[n] > bankAccount > state | Alfanumérico | Estado da conta bancária. Definir ACTIVE quando você está criando um beneficiário. |
Não | |
transfers[n] > bankAccount > merchantId | Numérico | Identificador da sua loja no PayU. | Não | |
transfers[n] > description | Alfanumérico | Informações adicionais sobre o pagamento. | Não |
Parâmetros de resposta
Nome do campo | Formato | Tamanho | Descrição |
---|---|---|---|
totalSuccessful | Numérico | Número de Payouts criados com sucesso. | |
totalFailed | Numérico | Número de pagamentos que não puderam ser criados. | |
successfulItems | Lista | Lista de itens que foram processados com sucesso. | |
successfulItems[n] > processingStatus | Alfanumérico | 7 | Status do pedido de Payout. Para transações bem-sucedidas, o valor é SUCCESS |
successfulItems[n] > paymentOrderId | Alfanumérico | 36 | ID gerado para a solicitação de Payout. Use este id para atualizar ou cancelar a solicitação. |
successfulItems[n] > value | Numérico | Valor do pedido. | |
successfulItems[n] > bankAccount | Este objeto contém as informações da conta bancária que receberá o pagamento. | ||
successfulItems[n] > bankAccount > processingStatus | Alfanumérico | 7 | BStatus de registro da conta bancária. Para registros bem-sucedidos, o valor é SUCCESS . |
successfulItems[n] > bankAccount > id | Alfanumérico | 36 | Identifier of the registered Bank account. |
successfulItems[n] > bankAccount > supplierType | Alfanumérico | Mín:11 Máx:16 | Relationship type selected for the payee. |
successfulItems[n] > bankAccount > accountNumber | Alfanumérico | Máx:17 | Número da conta bancária do beneficiário. |
successfulItems[n] > bankAccount > bankCode | Numérico | Mín:3 Máx:4 | Código do banco que emitiu a conta do beneficiário. Veja os códigos de bancos. |
successfulItems[n] > bankAccount > bankName | Alfanumérico | Nome do banco do beneficiário. | |
successfulItems[n] > bankAccount > accountType | Alfanumérico | 2 | Tipo de conta do beneficiário. |
successfulItems[n] > bankAccount > country | Alfanumérico | 2 | País da conta bancária . |
successfulItems[n] > bankAccount > documentNumber | Numérico | 50 | Número de identificação do beneficiário. |
successfulItems[n] > bankAccount > documentType | Alfanumérico | 2 | Tipo de identificação do beneficiário. |
successfulItems[n] > bankAccount > expeditionDate | Alfanumérico | 10 | Data de expedição do documento de identidade. |
successfulItems[n] > bankAccount > fullName | Alfanumérico | Nome completo do beneficiário. | |
successfulItems[n] > bankAccount > birthDate | Alfanumérico | 10 | Data de nascimento do beneficiário. |
successfulItems[n] > bankAccount > state | Alfanumérico | Estado da conta bancária. | |
successfulItems[n] > description | Alfanumérico | Informações adicionais sobre o pagamento. | |
failedItems | Lista | Lista de itens que falharam durante o processamento. | |
failedItems[n] > processingStatus | Alfanumérico | 7 | Status do pedido de Payout. Para transações com falha, o valor é FAILED . |
failedItems[n] > failureMessages | Lista | Lista de mensagens de erro que geraram a falha. | |
failedItems[n] > value | Numérico | Valor do pedido. | |
failedItems[n] > bankAccount | Este objeto contém as informações da conta bancária que falhou. Este elemento possui os mesmos parâmetros do objeto successfulItems[n].bankAccount . |
O seguinte exemplo de pedido envia três Payouts:
- O primeiro e o segundo pagamento são solicitados para beneficiários não registrados. O segundo falha porque o parâmetro Código bancário tem um valor inválido.
- O beneficiário pagamento é para um beneficiário registrado.
Exemplo pedido:
{
"transfers": [
{
"value": 1500000,
"bankAccount": {
"supplierType": "RELATED_THIRD_PARTY",
"accountNumber": 2198922910000,
"bankCode": "007",
"accountType": "CC",
"country": "CO",
"documentNumber": 1026304116,
"documentType": "CC",
"expeditionDate": "1996-05-17",
"fullName": "Santiago Romero Pineda",
"birthDate": "1975-03-07",
"merchantId": 510608
},
"description": "First Payment"
},
{
"value": 2000000,
"bankAccount": {
"supplierType": "RELATED_PROVIDER",
"accountNumber": 2198922910330,
"bankCode": "8",
"accountType": "CA",
"country": "CO",
"documentNumber": 102688116,
"documentType": "CC",
"expeditionDate": "2001-05-17",
"fullName": "Juan Perez",
"birthDate": "1985-04-17",
"merchantId": 510608
},
"description": "Payment of supplies"
},
{
"value": 4500000,
"bankAccount": {
"id": "e202507e-5551-4b67-be2a-a2a834bf1438"
},
"description": "Registered supplier payment"
}
]
}
Exemplo resposta:
{
"totalSuccessful": 2,
"totalFailed": 1,
"successfulItems": [
{
"processingStatus": "SUCCESS",
"paymentOrderId": "7202a9a7-ef51-4202-bd23-e604f9cbb25b",
"value": 1500000.00,
"bankAccount": {
"processingStatus": "SUCCESS",
"id": "e202507e-5551-4b67-be2a-a2a834bf1438",
"supplierType": "RELATED_THIRD_PARTY",
"accountNumber": "2198922910000",
"bankCode": "007",
"bankName": "BANCOLOMBIA",
"accountType": "CC",
"country": "CO",
"documentNumber": "1026304116",
"documentType": "CC",
"expeditionDate": "1996-05-16T05:00:00.000+00:00",
"fullName": "Santiago Romero Pineda",
"birthDate": "1975-03-06T05:00:00.000+00:00",
"state": "ACTIVE"
},
"description": "First Payment"
},
{
"processingStatus": "SUCCESS",
"paymentOrderId": "32740b81-5ecc-466c-bc09-699e6e5ceefb",
"value": 4500000.00,
"bankAccount": {
"processingStatus": "SUCCESS",
"id": "8f425a79-3f15-4e64-a1bf-2f7c087587ec",
"supplierType": "RELATED_THIRD_PARTY",
"accountNumber": "0200005555",
"bankCode": "013",
"bankName": "BBVA COLOMBIA",
"accountType": "CA",
"country": "CO",
"documentNumber": "81856522",
"documentType": "CC",
"expeditionDate": "2002-02-17T05:00:00.000+00:00",
"fullName": "Jorge Gutierrez",
"birthDate": "1986-02-11T05:00:00.000+00:00",
"state": "ACTIVE"
},
"description": "Registered supplier payment"
}
],
"failedItems": [
{
"processingStatus": "FAILED",
"failureMessages": [
"There is no registered bank with code: 8"
],
"value": 2000000,
"bankAccount": {
"processingStatus": "FAILED",
"supplierType": "RELATED_PROVIDER",
"accountNumber": "2198922910330",
"bankCode": "8",
"accountType": "CA",
"country": "CO",
"documentNumber": "102688116",
"documentType": "CC",
"expeditionDate": "2001-05-17T00:00:00.000+00:00",
"fullName": "Juan Perez",
"birthDate": "1985-04-17T00:00:00.000+00:00"
},
"description": "Payment of supplies"
}
]
}
Cancelar ordem de Payout
Este método permite solicitar o cancelamento de uma solicitação de Payout. Você só pode solicitar o cancelamento de um Payout quando seu status for IN_PAYU_PROCESS
ou anterior. Consulte Payout states para obter mais informações.
Observação
Você precisa incluir dois cabeçalhos para usar este método, consulte Configurar autenticação para obter mais informações. Além disso, você precisa saber seu ID de vendedor e conta, você pode obter essas informações no seu Módulo PayU.Chamada API
Para cancelar um pedido de Payout, use a seguinte URL:
DELETE
https://{env-api}.payulatam.com/v1.0/supplier-transfers/{merchantId}/{accountId}/{paymentOrderId}
O valor da variável {env-api}
is sandbox-transfers
para teste e transfers
para o modo de produção.
Parâmetro | Descrição | Obrigatório |
---|---|---|
merchantId | Número de identificação do comércio no sistema PayU. | Sim |
accountId | ID da conta do usuário para cada país associado ao comércio. | Sim |
paymentOrderId | ID de pagamento gerado quando o pedido foi criado pelo serviço de Solicitar pagamento. | Sim |
Variáveis para pedido
Nome do campo | Formato | Tamanho | Descrição | Obrigatório |
---|---|---|---|---|
comments | Alfanumérico | Motivo para cancelar a solicitação de Payout. | Não | |
pushPaymentId | Alfanumérico | ID de Payout da solicitação a ser cancelada. | Não |
A seguir estão os exemplos de pedido e resposta para este método.
Exemplo pedido:
{
"comments": "Request cancellation for payout",
"pushPaymentId": "1f92a225-9559-4b7f-9739-e6bb27b8b838"
}
Exemplo resposta:
{
"message": "Cancellation request received"
}
Create ou Update a WebHook
Este método permite criar ou atualizar um WebHook onde é possível configurar uma URL em que o PayU notifica os estados de um pagamento via POST
.
Você pode configurar um WebHook para os seguintes eventos:
- Criação de transferência: envia uma notificação quando uma solicitação de payout é criada. Para habilitar estas notificações, inclua o valor
TRANSFER_CREATION
no parâmetro da listaenabledEvents
. - Atualização de transferência: envia uma notificação quando a validação da triagem de sanção rejeita o beneficiário. Para habilitar estas notificações, inclua o valor
TRANSFER_UPDATE
no parâmetro da listaenabledEvents
. - Resultado de validação: envia uma notificação quando o beneficiário aprova a validação da triagem de sanção e quando a transferência é rejeitada pelo banco. Inclui o valor
VALIDATION_RESULT
no parâmetro da listaenabledEvents
.
Clique aqui para conhecer as variáveis nas notificações.
Observação
Você precisa incluir dois cabeçalhos para usar este método, consulte Configurar autenticação para obter mais informações. Além disso, você precisa saber seu ID de vendedor e conta, você pode obter essas informações no seu Módulo PayU.Chamada API
- Para criar um WebHook, use:
POST
https://{env-api}.payulatam.com/v1.0/webhooks/{merchantId}/{accountId}
- Para atualizar um WebHook, use:
PUT
https://{env-api}.payulatam.com/v1.0/webhooks/{merchantId}/{accountId}
O valor da variável {env-api}
is sandbox-transfers
para teste e transfers
para o modo de produção.
Parâmetro | Descrição | Obrigatório |
---|---|---|
merchantId | Número de identificação do comércio no sistema PayU. | Sim |
accountId | ID da conta do usuário para cada país associado ao comércio. | Sim |
Variáveis para pedido e resposta
Parâmetros de pedido
Nome do campo | Formato | Tamanho | Descrição | Obrigatório |
---|---|---|---|---|
id | Alfanumérico | Id do WebHook que você deseja atualizar. Este parâmetro é obrigatório ao atualizar um WebHook | Não | |
accountId | Numérico | ID da conta do usuário para cada país associado ao comércio. | Sim | |
callbackUrl | Alfanumérico | URL usada para receber as notificações de POST enviadas pelo PayU de acordo com os eventos selecionados. Esta URL deve ser única para cada WebHook. |
Sim | |
description | Alfanumérico | Descrição do WebHook que você deseja criar. | Sim | |
enabledEvents | Lista | Máx:3 | Lista dos eventos que gerarão uma notificação para a URL configurada quando ocorrerem. Pelo menos um evento deve ser selecionado. Os valores possíveis são: TRANSFER_UPDATE , TRANSFER_CREATION , VALIDATION_RESULT . |
Sim |
Parâmetros de resposta
Nome do campo | Formato | Tamanho | Descrição |
---|---|---|---|
id | Alfanumérico | Id do WebHook criado. | |
created | Date | Data de criação do WebHook. Formato YYYY-DD-MM hh:mm:ss . |
|
accountId | Numérico | ID da conta do usuário para cada país associado ao comércio. | |
callbackUrl | Alfanumérico | URL usada que receberá notificações de POST de acordo com os eventos selecionados. |
|
description | Alfanumérico | Descrição do WebHook criado. | |
enabledEvents | Lista | Máx:3 | Lista dos eventos selecionados. |
status | Alfanumérico | 7 | Estado do WebHook. Por padrão, o estado do novo WebHook é ENABLED . |
processingStatus | Alfanumérico | 7 | Estado de criação ou atualização do WebHook. Por padrão, este estado é SUCCESS . |
A seguir estão os exemplos de pedido e resposta para este método.
Exemplo pedido:
{
"accountId": 1,
"callbackUrl": "https://wwww.callbackurltest.com/",
"description": "Web Hook For Test Swagger",
"enabledEvents": [
"TRANSFER_UPDATE",
"TRANSFER_CREATION",
"VALIDATION_RESULT"
]
}
Exemplo resposta:
{
"processingStatus": "SUCCESS",
"id": "256dd74e-9187-4efb-8238-fa29bf8f587a",
"created": "2021-08-27T21:57:28.874+00:00",
"accountId": 1,
"callbackUrl": "https://wwww.callbackurltest.com/",
"description": "Web Hook For Test Swagger",
"enabledEvents": [
"TRANSFER_UPDATE",
"TRANSFER_CREATION",
"VALIDATION_RESULT"
],
"status": "ENABLED"
}
Excluir um WebHook
Este método permite excluir um WebHook criado anteriormente. Assim que exclui um WebHook, você para de receber notificações.
Observação
Você precisa incluir dois cabeçalhos para usar este método, consulte Configurar autenticação para obter mais informações. Além disso, você precisa saber seu ID de vendedor e conta, você pode obter essas informações no seu Módulo PayU.Chamada API
Para excluir um WebHook, use a seguinte URL:
DELETE
https://{env-api}.payulatam.com/v1.0/webhooks/{merchantId}/{accountId}/{id}
O valor da variável {env-api}
is sandbox-transfers
para teste e transfers
para o modo de produção.
Parâmetro | Descrição | Obrigatório |
---|---|---|
merchantId | Número de identificação do comércio no sistema PayU. | Sim |
accountId | ID da conta do usuário para cada país associado ao comércio. | Sim |
id | Id do WebHook que você deseja excluir. | Sim |
Exemplo resposta
Nome do campo | Formato | Tamanho | Descrição |
---|---|---|---|
processingStatus | Alfanumérico | 7 | Estado de exclusão do WebHook. Por padrão, este estado é SUCCESS . |
id | Alfanumérico | Id do WebHook excluído. | |
status | Alfanumérico | 7 | Estado do WebHook. Por padrão, o estado do WebHook excluído é DELETED . |
{
"processingStatus": "SUCCESS",
"id": "054e0fc5-a025-4a00-b666-95673c11dee1",
"status": "DELETED"
}
Consultar WebHooks
Você pode consultar WebHooks relacionados à sua conta pelo id do WeHook ou pelo id da conta. Ambos os métodos são explicados a seguir.
Observação
Você precisa incluir dois cabeçalhos para usar este método, consulte Configurar autenticação para obter mais informações. Além disso, você precisa saber seu ID de vendedor e conta, você pode obter essas informações no seu Módulo PayU.Consultar WebHooks por Id
Este método permite consultar as informações de um determinado WebHook usando seu id. Para consultar um WebHook, use a seguinte URL:
GET
https://{env-api}.payulatam.com/v1.0/webhooks/{merchantId}/{accountId}/{id}
O valor da variável {env-api}
is sandbox-transfers
para teste e transfers
para o modo de produção.
Parâmetro | Descrição | Obrigatório |
---|---|---|
merchantId | Número de identificação do comércio no sistema PayU. | Sim |
accountId | ID da conta do usuário para cada país associado ao comércio. | Sim |
id | Id do WebHook que você deseja consultar. | Sim |
Exemplo resposta
Parâmetros de resposta
Nome do campo | Formato | Tamanho | Descrição |
---|---|---|---|
processingStatus | Alfanumérico | 7 | Estado da consulta. Por padrão, este estado é SUCCESS . |
id | Alfanumérico | Id do WebHook. | |
created | Date | Data de criação do WebHook. Formato YYYY-DD-MM hh:mm:ss . |
|
accountId | Numérico | ID da conta do usuário para cada país associado ao comércio. | |
callbackUrl | Alfanumérico | URL usada que receberá notificações de POST de acordo com os eventos selecionados. |
|
description | Alfanumérico | Descrição of the WebHook. | |
enabledEvents | Lista | Máx:3 | Lista dos eventos selecionados. |
status | Alfanumérico | 7 | Estado do WebHook. Por padrão, o estado do novo WebHook é ENABLED . |
{
"processingStatus": "SUCCESS",
"id": "9628b74d-e2fb-40cc-b137-b156d1401641",
"created": "2021-08-28T00:52:26.206+00:00",
"accountId": 515058,
"callbackUrl": "https://wwww.callbackurltest.com/",
"description": "Web Hook For Test Swagger",
"enabledEvents": [
"TRANSFER_UPDATE",
"TRANSFER_CREATION",
"VALIDATION_RESULT"
],
"status": "ENABLED"
}
Consultar webhooks por conta
Este método permite que você consulte as informações de todos os WebHooks criados em sua conta. Para consultar a lista de WebHooks, use a seguinte URL:
GET
https://{env-api}.payulatam.com/v1.0/webhooks/account/{merchantId}/{accountId}
O valor da variável {env-api}
is sandbox-transfers
para teste e transfers
para o modo de produção.
Parâmetro | Descrição | Obrigatório |
---|---|---|
merchantId | Número de identificação do comércio no sistema PayU. | Sim |
accountId | ID da conta do usuário para cada país associado ao comércio. | Sim |
Exemplo resposta
Parâmetros de resposta
Nome do campo | Formato | Tamanho | Descrição |
---|---|---|---|
processingStatus | Alfanumérico | 7 | Estado da consulta. Por padrão, este estado é SUCCESS . |
id | Alfanumérico | Id do WebHook. | |
created | Date | Data de criação do WebHook. Formato YYYY-DD-MM hh:mm:ss . |
|
accountId | Numérico | ID da conta do usuário para cada país associado ao comércio. | |
callbackUrl | Alfanumérico | URL usada que receberá notificações de POST de acordo com os eventos selecionados. |
|
description | Alfanumérico | Descrição of the WebHook. | |
enabledEvents | Lista | Máx:3 | Lista dos eventos selecionados. |
status | Alfanumérico | 7 | Estado do WebHook. Por padrão, o estado do novo WebHook é ENABLED . |
[
{
"processingStatus": "SUCCESS",
"id": "9628b74d-e2fb-40cc-b137-b156d1401641",
"created": "2021-08-28T00:52:26.206+00:00",
"accountId": 515058,
"callbackUrl": "https://wwww.callbackurltest.com.co/",
"description": "Web Hook For Test Swagger",
"enabledEvents": [
"TRANSFER_UPDATE",
"TRANSFER_CREATION",
"VALIDATION_RESULT"
],
"status": "ENABLED"
},
{
"processingStatus": "SUCCESS",
"id": "672497c2-00f8-4787-a396-4024042eaa20",
"created": "2021-09-15T16:04:49.131+00:00",
"accountId": 515058,
"callbackUrl": "https://wwww.callbackurltest.com.co/",
"description": "Web Hook For Test Swagger",
"enabledEvents": [
"TRANSFER_UPDATE",
"VALIDATION_RESULT"
],
"status": "ENABLED"
}
]