Visão geral
Os webhooks fornecem notificações em tempo real sobre alterações no status das transações e outros eventos importantes em sua conta Localpayment. Em vez de consultar nossa API para obter atualizações de status, você pode configurar endpoints de webhook para receber notificações instantâneas quando os eventos ocorrerem.Atualizações em tempo real
Receba notificações instantâneas quando o status de uma transação mudar
Múltiplos eventos
Suporte para Payins, Payouts, Virtual Accounts, assinaturas e muito mais
Entrega segura
A verificação da assinatura HMAC garante a autenticidade do webhook
Como funcionam os webhooks
- Ocorreu um evento: O status de uma transação foi alterado no sistema da Localpayment.
- Enviar Webhook: O Localpayment envia uma carga útil JSON para o seu endpoint de webhook.
- Verificação de assinatura: Seu endpoint verifica a solicitação usando o cabeçalho x-Signature.
- Retorno 200 OK: Seu endpoint retornou uma resposta 200 OK.
- Evento de Processo: Seu aplicativo lida com os dados do webhook de forma assíncrona.
O cabeçalho
Content-Type nas requisições de webhook enviadas é text/plain; charset=utf-8, e não application/json. O corpo da requisição continua sendo um payload JSON válido. Faça o parse como JSON independentemente do valor do cabeçalho Content-Type.Pré-requisitos
Antes de configurar os webhooks, certifique-se de ter:Configuração da conta
Configuração adequada da conta para o país de destino e verificação da empresa.
Chave Secreta
Sua chave secreta de webhook do Business Portal Localpayment.
Configuração
Configuração do Business Portal
- Acesse Configurações → Clientes no seu Business Portal Localpayment.
- Selecione o cliente que deseja configurar.
- Clique na aba Notificações e escolha o tipo de webhook que deseja configurar.
- Clique no botão Adicionar e insira as seguintes informações:
| Configuração | Descrição | Obrigatório |
|---|---|---|
| URL | URL do seu endpoint de webhook (deve ser HTTPS) | ✅ |
| País | Selecione um país específico ou escolha “Todos” para cobertura global. | ✅ |
| Conta | Conta Localpayment associada ao webhook | ✅ |
| Adicionar cabeçalho | Adicionar cabeçalhos personalizados enviados com o webhook (pares chave-valor) | ❌ |
Segurança e Autenticação
A Localpayment assina todas as solicitações de webhook com uma assinatura HMAC para verificar sua autenticidade.Verificação de assinatura
Cada solicitação de webhook inclui um cabeçalhox-Signature. O valor é formatado como o nome do algoritmo seguido de um espaço e a assinatura HMAC-SHA256 codificada em hexadecimal:
x-Signature: HMAC-SHA256 <hex-signature>
HMAC-SHA256 .
Remova o prefixo
HMAC-SHA256 do valor do cabeçalho antes de comparar. Comparar a string completa do cabeçalho com o hash calculado sempre resultará em falha.Exemplo de implementação
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;
namespace Localpayment.API.Helpers
{
public static class HmacHelper
{
// This function receives the parameters secret, payload, signature and validates the signature.
// If it is the correct signature, it returns true, otherwise it returns false.
public static bool IsValid(string secret, string payload, string signature)
{
if (string.IsNullOrEmpty(signature))
{
return false;
}
// If the signature includes the algorithm prefix, remove it
string cleanSignature = signature;
string prefix = "HMAC-SHA256 ";
if (cleanSignature.StartsWith(prefix, StringComparison.OrdinalIgnoreCase))
{
cleanSignature = cleanSignature.Substring(prefix.Length).Trim();
}
// calculate the signature
var verifiedHash = ComputeHash(secret, payload);
// Validate the signature
if (!string.IsNullOrEmpty(verifiedHash) && cleanSignature.Equals(verifiedHash, StringComparison.OrdinalIgnoreCase))
{
return true;
}
return false;
}
// function used to generate the hmac
public static string ComputeHash(string secret, string payload)
{
byte[] key = Encoding.UTF8.GetBytes(secret);
HMACSHA256 myhmacsha256 = new HMACSHA256(key);
byte[] byteArray = Encoding.UTF8.GetBytes(payload);
MemoryStream stream = new MemoryStream(byteArray);
string result = myhmacsha256.ComputeHash(stream).Aggregate("", (s, e) => s + String.Format("{0:x2}", e), s => s);
return result;
}
}
}
import java.util.Objects;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
public class HmacHelper {
// algorithm used for hmac
public static final String ALGORITHM = "HmacSHA256";
// function used to generate the hmac
public static String calculateHMAC(String key, String data) throws Exception {
Mac sha256_HMAC = Mac.getInstance(ALGORITHM);
SecretKeySpec secret_key = new SecretKeySpec(key.getBytes("UTF-8"), ALGORITHM);
sha256_HMAC.init(secret_key);
byte[] MAC = sha256_HMAC.doFinal(data.getBytes("UTF-8"));
return byteArrayToHex(MAC);
}
// This function receives the parameters secret, payload, signature and validates the signature.
// If it is the correct signature, it returns true, otherwise it returns false.
public static boolean IsValid(String secret, String payload, String signature) throws Exception {
if (signature == null) {
return false;
}
// we remove the algorithm prefix
String cleanSignature = signature;
if (cleanSignature.toUpperCase().startsWith("HMAC-SHA256 ")) {
cleanSignature = cleanSignature.substring("HMAC-SHA256 ".length()).trim();
}
// calculate the expected hash
String expectedHash = calculateHMAC(secret, payload);
// Validate the signature
return Objects.nonNull(expectedHash) &&
cleanSignature.equalsIgnoreCase(expectedHash);
}
// this function convert byte Array To Hexadecimal String
public static String byteArrayToHex(byte[] a) {
StringBuilder sb = new StringBuilder(a.length * 2);
for (byte b : a) {
sb.append(String.format("%02x", b));
}
return sb.toString();
}
}
Cargas úteis de webhook
Todas as cargas úteis de webhook compartilham uma estrutura comum, com dados específicos do evento no objetodata. Esse formato consistente facilita o parsing e o tratamento de webhooks em diferentes tipos de evento.
Estrutura comum de webhook
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
// ... event-specific data
}
}
| Campo | Tipo | Descrição | Valores possíveis |
|---|---|---|---|
| transactionType | string | Categoria de alto nível da transação | PayIn, VirtualAccount, Subscription, PayOut, CurrencyExchange |
| transactionFlow | string | null | Tipo de fluxo ou processamento específico | CurrencyExchange, payInBankTransfer, null (quando não aplicável) |
| data | object | Carga útil específica do evento contendo detalhes da transação | Varia conforme o tipo de transação (veja exemplos abaixo). |
transactionType aparece duas vezes por design. O campo no nível raiz funciona como chave de roteamento para o seu handler de webhook. O campo é repetido dentro do objeto data para tornar cada payload autocontido — útil ao armazenar ou encaminhar eventos individualmente. Ambos os valores serão sempre idênticos.Tipo de
fxSource. O campo fxSource é sempre um float. Ele representa a taxa de câmbio usada no cálculo da tarifa ou do imposto. Quando nenhuma conversão cambial se aplica (transações na mesma moeda), o valor é 0 ou 0.0.Eventos de Payin
Pagamentos com cartão (crédito/débito)
- Cartão de débito
- Cartão de crédito
Approved
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "bbdf3242-98a7-4234-8059-673aa7261f69",
"internalId": "1e7dcdf3-43e4-4896-8838-2eab86818e51",
"paymentMethod": {
"type": "DebitCard",
"code": "1007",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 125.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0.0,
"amount": 125.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 125.0
},
"localTaxes": [
{
"code": "0001",
"percentage": 1.2,
"description": "IDC",
"currency": "ARS",
"fxSource": 24,
"fxQuote": 0.0,
"amount": 1.0,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0.0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "103",
"description": "APPROVED",
"detail": "The payin was confirmed but not credited yet"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "merchant123@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer@mail.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98779632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina"
},
"intermediaries": [],
"date": {
"creationDate": "2023-06-06T19:46:17Z",
"processedDate": "2023-06-06T19:46:20Z"
},
"card": {
"token": "zJqphXmfJH0rwmaAQerHTB/ri1OUUP5m46scEPDBPmM=",
"bin": "451766",
"brand": "VISA",
"country": "AR",
"name": "Card name",
"last4": "2542",
"expirationYear": 2025,
"expirationMonth": 11,
"installments": 1
},
"errors": []
}
}
Chargeback
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "01da1897-43bf-47e9-b466-8b7b8e618e8d",
"internalId": "15e63cf5-4c36-4a0a-8b7e-040127d66bbf",
"paymentMethod": {
"type": "DebitCard",
"code": "1005",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 1500.5
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 1500.5
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "906",
"description": "CHARGEBACK",
"detail": "The payin has a chargeback"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "merchant@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer123@mail.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina"
},
"intermediaries": [],
"date": {
"creationDate": "2023-03-22T18:29:49Z",
"processedDate": "2023-03-22T18:29:52Z"
},
"card": {
"token": "wf6q35MjZNsX1CH7tgeNoFUYYD1iN41ozLX73PiuG0I=",
"bin": "451766",
"brand": "VISA",
"country": "AR{
Completed
{"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "67419547-9c3c-4f86-8fff-a85a0850843b",
"internalId": "136758b8-5e36-4c3f-94fb-914b81382205",
"paymentMethod": {
"type": "DebitCard",
"code": "1603",
"flow": "DIRECT"
},
"country": "MEX",
"currency": "MXN",
"amount": 125.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "MXN",
"fxQuote": 0.0,
"amount": 125.0
},
"payment": {
"currency": "MXN",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 125.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "MXN",
"fxSource": 0,
"fxQuote": 0.0,
"amount": 7.50,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A.",
"lastname": "",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"email": "jane.doe@example.com"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Juan",
"lastname": "Hernández",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"email": "jane.doe@example.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": ""
},
"address": {
"street": "Av. Insurgentes Sur 450",
"number": "450",
"city": "CDMX",
"state": "Ciudad de México",
"country": "MEX",
"zipCode": "06700"
}
},
"intermediaries": [],
"date": {
"creationDate": "2023-02-19T00:01:55Z",
"processedDate": "2023-02-19T00:01:59Z"
},
"card": {
"token": "NFh5nfWpXxHb0XeboXdVZvUIFFHF2SGbfNAf+8ijSSM=",
"bin": "481216",
"brand": "VISA",
"country": "MX",
"name": "Karla M",
"last4": "7782",
"expirationYear": 2024,
"expirationMonth": 12,
"installments": 1
}
}
}
Refunded
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "632e94a1-975e-4818-8978-d729068f93cb",
"internalId": "7d9e52f3-6740-4bfa-9c4d-daf18163aba5",
"paymentMethod": {
"type": "DebitCard",
"code": "1005",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 1500.5
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 1500.5
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 45.02,
"account": "111.111.0000002"
},
"status": {
"code": "902",
"description": "REFUNDED",
"detail": "The payin was refunded"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "merchant@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer@mail.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98799632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina"
},
"intermediaries": [],
"date": {
"creationDate": "2023-03-22T18:39:49Z",
"processedDate": "2023-03-22T18:39:52Z"
},
"card": {
"token": "0h/9W0S3DafImFyw56Pz0XXR4NCdcqHtQz2urO4zvwo=",
"bin": "451766",
"brand": "VISA",
"country": "AR",
"name": "Card holder name",
"last4": "2542",
"expirationYear": 2025,
"expirationMonth": 11,
"installments": 1
},
"errors": []
}
}
Rejected
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"externalId": "c2a77de4-d2b3-4cdd-9e33-e98f452db1ea",
"internalId": "d8ed7e1e-a08a-47e3-b82a-3be439ca051d",
"status": {
"code": "802",
"description": "REJECTED",
"detail": "Rejected by provider"
},
"errors": [
{
"code": "802",
"detail": "Rejected by provider"
}
],
"providerResponse": {
"providerName": "stripe",
"status": {
"code": "802",
"description": "REJECTED",
"detail": "Your card was declined. Your request was in test mode, but used a non test (live) card. For a list of valid test cards, visit: https://stripe.com/docs/testing."
},
"providerResponse": {
"error": {
"charge": "ch_3MlvNSX2XX6I7x0117sg0gus",
"code": "card_declined",
"decline_code": "test_mode_live_card",
"doc_url": "https://stripe.com/docs/error-codes/card-declined",
"message": "Your card was declined. Your request was in test mode, but used a non test (live) card. For a list of valid test cards, visit: https://stripe.com/docs/testing.",
"payment_intent": {
"id": "pi_3XlvNSG2II6I7x011xXiy98p",
"object": "payment_intent",
"amount": 10,
"amount_capturable": 0,
"amount_details": {
"tip": {}
},
"amount_received": 0,
"application": null,
"application_fee_amount": null,
"automatic_payment_methods": null,
"canceled_at": null,
"cancellation_reason": null,
"capture_method": "automatic",
"charges": {
"object": "list",
"data": [
{
"id": "ch_3MlvXXX2II6I7x0117xx0gus",
"object": "charge",
"amount": 45.990,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": null,
"billing_details": {
"address": {
"CDMX": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"Ciudad de México": null
},
"email": "jane.doe@example.com",
"name": "John, Jairo",
"phone": "+1 1111111"
},
"statement_descriptor": "LOCALPAYMENT",
"captured": false,
"created": 1678890750,
"currency": "mxn",
"customer": null,
"description": null,
"destination": null,
"dispute": null,
"disputed": false,
"failure_balance_transaction": null,
"failure_code": "card_declined",
"failure_message": "Your card was declined. Your request was in test mode, but used a non test (live) card. For a list of valid test cards, visit: https://stripe.com/docs/testing.",
"fraud_details": {},
"invoice": null,
"livemode": false,
"metadata": {},
"on_behalf_of": null,
"order": null,
"outcome": {
"network_status": "not_sent_to_network",
"reason": "test_mode_live_card",
"risk_level": "normal",
"risk_score": 46,
"seller_message": "This charge request was in test mode, but did not use a Stripe test card number. For the list of these numbers, see stripe.com/docs/testing",
"type": "invalid"
},
"paid": false,
"payment_intent": "pi_3MlxNSG2II6I7x011fEix98x",
"payment_method": "pm_1MlxNRG2II6X7x01P11CoHxG",
"payment_method_details": {
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "unchecked"
},
"country": "MX",
"exp_month": 8,
"exp_year": 2025,
"fingerprint": "HOdKnzYFcoDVMtOV",
"funding": "debit",
"installments": null,
"last4": "1701",
"mandate": null,
"network": "visa",
"three_d_secure": null,
"wallet": null
},
"type": "card"
},
"receipt_email": "jane.doe@example.com",
"receipt_number": null,
"receipt_url": null,
"refunded": false,
"refunds": {
"object": "list",
"data": [],
"has_more": false,
"total_count": 0,
"url": "/v1/charges/ch_3MlvNSG2II6I7x0117sg0gus/refunds"
},
"review": null,
"shipping": null,
"source": null,
"source_transfer": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "failed",
"transfer_data": null,
"transfer_group": null
}
],
"has_more": false,
"total_count": 1,
"url": "/v1/charges?payment_intent=pi_3MlvNSG2II6I7x011fEiy1234p"
},
"client_secret": "pi_1MlvNSG1II6I7x011fEiy11p_secret_aTBuTt0fKEpKIryQwurRlavsd",
"confirmation_method": "automatic",
"created": 167790750,
"currency": "mxn",
"customer": null,
"description": null,
"invoice": null,
"last_payment_error": {
"charge": "ch_3MlvNSG2II6I7x0117sg0gus",
"code": "card_declined",
"decline_code": "test_mode_live_card",
"doc_url": "https://stripe.com/docs/error-codes/card-declined",
"message": "Your card was declined. Your request was in test mode, but used a non test (live) card. For a list of valid test cards, visit: https://stripe.com/docs/testing.",
"payment_method": {
"id": "pm_1MlvXXG2II6I7x01P11CoHxG",
"object": "payment_method",
"billing_details": {
"address": {
"CDMX": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"Ciudad de México": null
},
"email": "john@gail.com",
"name": "John",
"phone": "+1 112233"
},
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "unchecked"
},
"country": "MX",
"exp_month": 8,
"exp_year": 2025,
"fingerprint": "HOdKnzYFxxDVMtOV",
"funding": "debit",
"generated_from": null,
"last4": "1701",
"networks": {
"available": [
"visa"
],
"preferred": null
},
"three_d_secure_usage": {
"supported": true
},
"wallet": null
},
"created": 1679650749,
"customer": null,
"livemode": false,
"metadata": {},
"type": "card"
},
"type": "card_error"
},
"latest_charge": "ch_3MlxNSG2XX6I7x0117sg0gus",
"livemode": false,
"metadata": {},
"next_action": null,
"on_behalf_of": null,
"payment_method": null,
"payment_method_options": {
"card": {
"installments": null,
"mandate_options": null,
"network": null,
"request_three_d_secure": "automatic"
}
},
"payment_method_types": [
"card"
],
"processing": null,
"receipt_email": "jane.doe@example.com",
"review": null,
"setup_future_usage": null,
"shipping": null,
"source": null,
"statement_descriptor": null,
"statement_descriptor_suffix": null,
"status": "requires_payment_method",
"transfer_data": null,
"transfer_group": null
},
"payment_method": {
"id": "pm_1MlvXXX2II6I7x01P11CoHxG",
"object": "payment_method",
"billing_details": {
"address": {
"CDMX": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"Ciudad de México": null
},
"email": "jane.doe@example.com",
"name": "John, Joseph",
"phone": "+1 1122"
},
"card": {
"brand": "visa",
"checks": {
"address_line1_check": null,
"address_postal_code_check": null,
"cvc_check": "unchecked"
},
"country": "MX",
"exp_month": 8,
"exp_year": 2025,
"fingerprint": "HOdKxxYFcoXXXtOV",
"funding": "debit",
"generated_from": null,
"last4": "1701",
"networks": {
"available": [
"visa"
],
"preferred": null
},
"three_d_secure_usage": {
"supported": true
},
"wallet": null
},
"created": 1678890749,
"customer": null,
"livemode": false,
"metadata": {},
"type": "card"
},
"request_log_url": "https://dashboard.XXX.com/test/logs/req_UAGrgV1gma0X6h?t=1611110750",
"type": "card_error"
}
}
}
}
}
Approved
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "e7e12c68-56bf-41cb-b615-0b9463956245",
"internalId": "d170b7a5-143b-4107-b827-9824340f12a4",
"paymentMethod": {
"type": "CreditCard",
"code": "1000",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 125.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0.0,
"amount": 125.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 125.0
},
"localTaxes": [
{
"code": "0001",
"percentage": 0.2,
"description": "IDC",
"currency": "ARS",
"fxSource": 0.00,
"fxQuote": 0.0,
"amount": 125.0,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0.0,
"fxQuote": 0.0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "103",
"description": "APPROVED",
"detail": "The payin was confirmed but not credited yet"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "company@example.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "porte 801"
},
"birthdate": "1994-02-20",
"nationality": "Argentino"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "jane.doe@example.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "99789632"
}
},
"intermediaries": [],
"date": {
"creationDate": "2023-06-05T14:30:45Z",
"processedDate": "2023-06-05T14:30:48Z"
},
"card": {
"token": "D4xxL4/P2dxxxxxJBB6ASL2qHRpN+QzO8VYnqcaDBys=",
"bin": "497010",
"brand": "",
"country": "",
"name": "APPRO",
"last4": "0055",
"expirationYear": 2025,
"expirationMonth": 11,
"installments": 1
},
"errors": []
}
}
Chargeback
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "9ee47632-5259-4767-9edc-4ff3a1879d44",
"internalId": "de090ddb-6441-4ec6-801e-ff46bd4aca71",
"paymentMethod": {
"type": "CreditCard",
"code": "1001",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 1500.5
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0,
"amount": 1500.5
},
"localTaxes": [
{
"code": "0001",
"percentage": 0.2,
"description": "IDC",
"currency": "ARS",
"fxSource": 0.0,
"fxQuote": 0,
"amount": 1500.5,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "906",
"description": "CHARGEBACK",
"detail": "The payin has a chargeback"
},
"merchant": {
"type": "COMPANY",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "company@mail.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98809632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer@mail.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98780632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina"
},
"intermediaries": [],
"date": {
"creationDate": "2023-06-06T15:16:07Z",
"processedDate": "2023-06-06T15:16:11Z"
},
"card": {
"token": "MDxWnB6uLRDxxSNslPK64bT5sdELabQELzoXVz1Lmps=",
"bin": "555034",
"brand": "MASTERCARD",
"country": "AR",
"name": "Cardholder name",
"last4": "5950",
"expirationYear": 2027,
"expirationMonth": 11,
"installments": 1
},
"errors": []
}
}
Completed
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "1ccc6250-496a-4795-95a9-edd719907340",
"internalId": "5dae7a3c-e19a-4382-be84-ece8f8205d89",
"paymentMethod": {
"type": "CreditCard",
"code": "1001",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 125.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0.0,
"amount": 125.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0,
"amount": 125.0
},
"localTaxes": [
{
"code": "0001",
"percentage": 0.1,
"description": "IDC",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 125.0,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0.0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "COMPANY",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "company@mail.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98799632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer123@mail.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "97789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina"
},
"intermediaries": [],
"date": {
"creationDate": "2023-06-06T15:16:07Z",
"processedDate": "2023-06-06T15:16:11Z"
},
"card": {
"token": "MDjWnBRDdlSNslPK64bT5sdELabQELzoXVz1Lmps=",
"bin": "555034",
"brand": "MASTERCARD",
"country": "AR",
"name": "Cardholder name",
"last4": "5950",
"expirationYear": 2027,
"expirationMonth": 11,
"installments": 1
},
"errors": []
}
}
Refunded
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "2e7f4bc9-6b53-4ea8-b440-5f34bef183f3",
"internalId": "2e719fd7-e115-4e47-8d08-69c2a961a97e",
"paymentMethod": {
"type": "CreditCard",
"code": "1001",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0.0,
"amount": 1500.5
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0,
"amount": 1500.5
},
"localTaxes": [
{
"code": "0001",
"percentage": 0.0,
"description": "IDC",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 1500.5,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "902",
"description": "REFUNDED",
"detail": "The payin was refunded"
},
"merchant": {
"type": "COMPANY",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "company@mail.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98809632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer123@mail.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98709632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina"
},
"intermediaries": [],
"date": {
"creationDate": "2023-06-06T15:38:14Z",
"processedDate": "2023-06-06T15:38:17Z"
},
"card": {
"token": "xxAUuzPhxxjtxUPhsUvx9UynyICDnWkj4KSmcm6fKys=",
"bin": "555034",
"brand": "MASTERCARD",
"country": "AR",
"name": "Cardholder name",
"last4": "5950",
"expirationYear": 2027,
"expirationMonth": 11,
"installments": 1
},
"errors": []
}
}
Rejected
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"externalId": "a02bd978-d14b-4ba6-a4a7-f6df7ecfb9db",
"internalId": "0309373a-736d-491d-9f25-79219ebb5df2",
"status": {
"code": "300",
"description": "REJECTED",
"detail": "Invalid param + [param name] + [reason]"
},
"errors": [
{
"code": "300",
"detail": "Invalid param + document.id + verification failed"
}
]
}
}
Conta Master para Transferências Bancárias
{
"transactionType": "PayIn",
"transactionFlow": "payInBankTransfer",
"data": {
"transactionType": "PayIn",
"externalId": "98f143c9-46ec-4e81-b8b3-1b8a3e516a09",
"internalId": "893bb017-8f3a-4417-96d9-59fe3a7e4ba2",
"paymentMethod": {
"type": "BankTransfer",
"code": "1025",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 125.00,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 125.00
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 125.00
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "COMPANY",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "merchant@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina",
"bank": {
"name": "Account holder name",
"code": "007",
"account": {
"type": "C",
"number": "0070055930004044938502"
}
}
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"name": "LOCALPAYMENT S.R.L.",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"bank": {
"name": "BANCO DE LA NACION ARGENTINA",
"code": "011",
"branch": {},
"account": {
"type": "C",
"number": "0110599520000012345678"
}
}
},
"referenceCode": "WKKU-E34J-VTBI"
},
"date": {
"creationDate": "2023-03-14T20:04:25.197+00:00",
"processedDate": "2023-03-14T20:04:26.108653",
"expirationDate": "2023-03-21T20:04:26.082434"
},
"errors": [],
"createdOn": "2023-03-14T20:04:25.197+00:00",
"createdBy": "email@example.com",
"executionData": {
"paymentMethodProvider": {
"country": "ARG",
"currency": "ARS",
"accountType": "C",
"providerCode": "011",
"providerName": "BANCO DE LA NACION ARGENTINA",
"accountNumber": "0110599520000012345678",
"accountOwnerCode": "0001",
"accountOwnerName": "LOCALPAYMENT S.R.L.",
"paymentMethodCode": "1025"
}
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": "payInBankTransfer",
"data": {
"transactionType": "PayIn",
"externalId": "ddba6248-9e1e-4e37-9804-41915c659f8e",
"internalId": "414aab17-abd1-47d7-ab71-d36f62956b28",
"paymentMethod": {
"type": "BankTransfer",
"code": "1025",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 1500.5
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 1500.5
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "901",
"description": "EXPIRED",
"detail": "The payin has expired"
},
"merchant": {
"type": "COMPANY",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "merchant@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina",
"bank": {
"name": "Account holder name",
"code": "007",
"account": {
"type": "C",
"number": "0070055930004044938502"
}
}
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"name": "LOCALPAYMENT S.R.L.",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"bank": {
"name": "BANCO DE LA NACION ARGENTINA",
"code": "011",
"branch": {},
"account": {
"type": "C",
"number": "0110599520000012345678"
}
}
},
"referenceCode": "UIKY-KAIK-2BK2"
},
"date": {
"creationDate": "2023-03-14T21:41:35.568+00:00",
"processedDate": "2023-03-14T21:41:36.484751",
"expirationDate": "2023-03-21T21:41:36.461370"
},
"errors": [],
"createdOn": "2023-03-14T21:41:35.568+00:00",
"createdBy": "email@example.com",
"executionData": {
"paymentMethodProvider": {
"country": "ARG",
"currency": "ARS",
"accountType": "C",
"providerCode": "011",
"providerName": "BANCO DE LA NACION ARGENTINA",
"accountNumber": "0110599520000012345678",
"accountOwnerCode": "0001",
"accountOwnerName": "LOCALPAYMENT S.R.L.",
"paymentMethodCode": "1025"
}
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": "payInBankTransfer",
"data": {
"transactionType": "PayIn",
"externalId": "33932a36-4901-4adf-bc64-300a85e2de54",
"internalId": "f8589dfb-4a78-44da-9b35-04fecfbeea59",
"paymentMethod": {
"type": "BankTransfer",
"code": "1025",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"amount": 1500.5,
"fxQuote": 0.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 1500.5
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0.0,
"fxQuote": 0.0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "100",
"description": "INPROGRESS",
"detail": "The payin is pending the confirmation"
},
"merchant": {
"type": "COMPANY",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "merchant@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina",
"bank": {
"name": "Account holder name",
"code": "007",
"account": {
"type": "C",
"number": "0070055930004044938502"
}
}
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"type": "INDIVIDUAL",
"name": "LOCALPAYMENT S.R.L.",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"bank": {
"name": "BANCO DE LA NACION ARGENTINA",
"code": "011",
"branch": {},
"account": {
"type": "C",
"number": "0110599520000012345678"
}
}
},
"referenceCode": "XXXX-E34J-VTBI"
},
"date": {
"creationDate": "2023-03-14T20:04:25.197+00:00",
"processedDate": "2023-03-14T20:04:26.108653",
"expirationDate": "2023-03-21T20:04:26.082434"
},
"errors": []
}
}
{
"transactionType": "PayIn",
"transactionFlow": "payInBankTransfer",
"data": {
"transactionType": "PayIn",
"externalId": "bf9f3d3f-2c0c-40bb-a081-7c5b8870a8f3",
"internalId": "6874b919-2d53-4523-96b1-0c6d0f6c4a06",
"paymentMethod": {
"type": "BankTransfer",
"code": "1025",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 1500.5
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 1500.5
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0.0,
"fxQuote": 0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "902",
"description": "REFUNDED",
"detail": "The payin was refunded"
},
"merchant": {
"type": "COMPANY",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "merchant@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any useful information"
},
"birthdate": "2000-01-01",
"nationality": "Argentina"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "payer@email.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "Argentina",
"bank": {
"name": "Account holder name",
"code": "007",
"account": {
"type": "C",
"number": "0070055930004044938502"
}
}
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"name": "LOCALPAYMENT S.R.L.",
"document": {
"type": "DNI",
"id": "20-12345678-9"
}
},
"referenceCode": "XXXXX"
},
"date": {
"creationDate": "2022-08-02T15:35:58.091+00:00",
"processedDate": "2022-08-02T15:36:02.317705",
"expirationDate": "2022-08-09T15:36:02.317705"
},
"errors": [],
"createdOn": "2022-08-02T15:35:58.091+00:00",
"createdBy": "email@example.com",
"executionData": {
"paymentMethodProvider": {
"country": "ARG",
"currency": "ARS",
"accountType": "Checking",
"providerCode": "0002",
"providerName": "ICBC",
"accountNumber": "3333",
"referenceCode": "XXXXXX",
"accountOwnerCode": "0001",
"accountOwnerName": "LOCALPAYMENT S.R.L.",
"paymentMethodCode": "1025"
}
}
}
}
{
"transactionType": "PayIn",
"data": {
"externalId": "cfbafe12-c6aa-41cf-a0e7-84e6f4ae2258",
"internalId": "ee73a6ff-d360-46e4-b337-b2a5091a7da5",
"status": {
"code": "701",
"description": "REJECTED",
"detail": "IncorrectAccountNumber"
},
"errors": [
{
"code": "701",
"detail": "Invalid bank account type for the country"
}
]
}
}
Assinaturas
{
"transactionType": "Subscription",
"data": {
"internalId": "dce7e9c0-067f-403c-bac0-96af1aa485d1",
"externalId": "d23aba9c-72ad-4dac-9c3a-3575fed29dc8",
"country": "ARG",
"currency": "ARS",
"clientCode": "0000",
"accountNumber": "{{accountNumber}}",
"status": {
"code": "903",
"description": "CANCELLED",
"detail": "The subscription was canceled - merchant request"
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "5a9c1fa6-b687-4489-8771-defb98fb05a6",
"internalId": "2e84aabc-e68a-4be5-a908-cd6ce86eada2",
"paymentMethod": {
"type": "CreditCard",
"code": "0000",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1500.5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 1500.5
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 1500.5
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxSource": 0,
"fxQuote": 0,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "000",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Comercio Austral S.R.L.",
"lastname": "",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "obiwankenobi@starwars.com",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "portero 801"
},
"birthdate": "2000-01-01",
"nationality": "Argentinian"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastname": "García",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "jane.doe@example.com",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Av. Corrientes",
"number": "1200",
"city": "CABA",
"state": "Buenos Aires",
"country": "ARG",
"zipCode": "C1043AAZ",
"comment": "May the force be with you, always!"
},
"birthdate": "01/01/1990",
"nationality": "American"
},
"intermediaries": [],
"date": {
"creationDate": "2023-06-09T16:43:30Z",
"processedDate": "2023-06-09T16:43:34Z"
},
"card": {
"token": "bGSWLnkPpjZ2wXX94zLnXXXXw3T205IcKKJMuMea/9s=",
"bin": "497010",
"brand": "",
"country": "",
"name": "APRO",
"last4": "0055",
"expirationYear": 2025,
"expirationMonth": 11,
"installments": 1
},
"errors": []
}
}
{
"transactionType": "Subscription",
"data": {
"internalId": "e6abf7b9-d19f-4915-9068-82bc013bf594",
"externalId": "94fa0a8f-7850-4f14-872a-c39fb05fb237",
"country": "ARG",
"currency": "ARS",
"clientCode": "0001",
"accountNumber": "{{accountNumber}}",
"status": {
"code": "105",
"description": "INPROGRESS",
"detail": "The subscription is in progress"
}
}
}
{
"transactionType": "Subscription",
"data": {
"internalId": "1e921446-c280-483b-a926-f6fb42e041c2",
"externalId": "ab8c8d0d-c96e-4c5b-819c-9ecb7d843f36",
"country": "ARG",
"currency": "ARS",
"clientCode": "0000",
"accountNumber": "{{accountNumber}}",
"status": {
"code": "300",
"description": "REJECTED",
"detail": "Invalid param + [autoRecurring.type] + should be [month,day]"
},
"date": {
"creationDate": "2023-06-09T19:22:40.169158",
"nextPaymentDate": null
},
"payments": []
}
}
Eventos de Payout
{
"transactionType": "PayOut",
"transactionFlow": null,
"data": {
"transactionType": "payOut",
"externalId": "432f1190-3899-4565-b58d-4ecee4312a97",
"internalId": "805c7edb-4bd5-4d1e-b683-f970272858a7",
"paymentMethod": {
"code": "0050"
},
"country": "Country",
"currency": "Currency",
"amount": 1.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "Currency",
"fxQuote": 1.0,
"amount": 1.0
},
"payment": {
"currency": "Currency",
"fxQuote": 1.0,
"amount": 1.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "Currency",
"fxQuote": 1.0,
"amount": 1.38
},
"status": {
"code": "900",
"description": "CANCELLED",
"detail": "The payout was cancelled"
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastname": "Sender LastName",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Beneficiary Name",
"lastname": "Beneficiary LastName",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Banco",
"code": "049",
"account": {
"type": "C",
"number": "Account Number"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A.",
"birthdate": "0001-01-01T00:00:00Z"
},
"date": {
"creationDate": "2023-10-23T20:13:12Z",
"processedDate": "2023-10-23T20:14:22Z"
}
}
}
{
"transactionType": "PayOut",
"transactionFlow": null,
"data": {
"transactionType": "payOut",
"externalId": "386aef46-3f14-4e53-8f17-966a90bc1b03",
"internalId": "2fb76472-7aee-477b-8653-0c3dc619db21",
"paymentMethod": {
"code": "0050"
},
"country": "Country",
"currency": "Currency",
"amount": 50.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "Currency",
"fxQuote": 0.0,
"amount": 1.0
},
"payment": {
"currency": "Currency",
"fxQuote": 0.0,
"amount": 1.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "Currency",
"fxQuote": 0.0,
"amount": 1.38
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payout was debited"
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastname": "Sender LastName",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Beneficiary Name",
"lastname": "Beneficiary LastName",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Banco",
"code": "001",
"account": {
"type": "C",
"number": "Account Number"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A.",
"birthdate": "0001-01-01T00:00:00Z"
},
"date": {
"creationDate": "2023-10-23T19:13:41Z",
"processedDate": "2023-10-23T19:14:50Z"
}
}
}
{
"transactionType": "PayOut",
"transactionFlow": null,
"country": "COL",
"data": {
"externalId": "ac1a0eb1-eedf-4fde-ae67-14efb9dd2c56",
"internalId": "d49fa613-7e05-48dc-b170-29f27b2645ef",
"paymentMethod": {
"code": "0060"
},
"country": "Country",
"currency": "Currency",
"amount": 45.99,
"accountNumber": "yourAccount",
"confirmed": {
"currency": "Country",
"fxQuote": 0.0,
"amount": 45.99
},
"payment": {
"currency": "Currency",
"fxQuote": 0.0,
"amount": 45.99
},
"localTaxes": [
{
"description": "ROUTERTEST",
"currency": "currency",
"fxSource": 0,
"fxQuote": 0.0,
"amount": 45.99,
"account": "{{yourAccount}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "currency",
"fxSource": 0,
"fxQuote": 0,
"amount": 1.38,
"account": "{{yourAccount}}"
},
"status": {
"code": "101",
"description": "LOCKED",
"detail": "The payout has been confirmed and passed AML validations"
},
"sender": {
"type": "INDIVIDUAL",
"name": "John",
"lastName": " LastName",
"document": {
"type": "NIT",
"id": "900.123.456-7"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Name Test",
"lastName": "LastName Test",
"document": {
"type": "NIT",
"id": "900.123.456-7"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Bank",
"code": "1062",
"account": {
"type": "S",
"number": "accountNumber"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Pagos Digitales Colombia SAS",
"birthdate": "0001-01-01T00:00:00Z"
},
"date": {
"creationDate": "2024-07-31T14:45:28Z",
"processedDate": "2024-07-31T14:45:30Z"
}
}
}
{
"transactionType": "PayOut",
"transactionFlow": null,
"data": {
"transactionType": "payOut",
"externalId": "0d17fdaf-6bbc-4047-b9c7-d4d7139c036c",
"internalId": "b0bb1509-dd93-48d9-a2b7-66a320a0611c",
"paymentMethod": {
"code": "0050"
},
"country": "Country",
"currency": "Currency",
"amount": 50.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "Currency",
"fxQuote": 1.0,
"amount": 1.0
},
"payment": {
"currency": "Currency",
"fxQuote": 1.0,
"amount": 1.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "Currency",
"fxQuote": 1.0,
"amount": 1.38
},
"status": {
"code": "302",
"description": "REJECTED",
"detail": "Invalid control string characters"
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender",
"lastname": "Sender LastName",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Beneficiary Name",
"lastname": "Beneficiary LastName",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Banco",
"code": "049",
"account": {
"type": "Type",
"number": "AccountNumber"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A.",
"birthdate": "0001-01-01T00:00:00Z"
},
"date": {
"creationDate": "2023-10-23T19:54:41Z",
"processedDate": "2023-10-23T19:55:51Z"
}
}
}
{
"transactionType": "PayOut",
"transactionFlow": null,
"country": "COL",
"data": {
"externalId": "974325f7-e2e1-46ce-aa39-be471dc6fa17",
"internalId": "9416a1be-295d-45d2-9dc0-58957e887218",
"paymentMethod": {
"code": "0061"
},
"country": "COL",
"currency": "COP",
"amount": 301,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "COP",
"fxQuote": 1,
"amount": 301
},
"payment": {
"currency": "COP",
"fxQuote": 1,
"amount": 301
},
"localTaxes": [
{
"description": "GMF",
"currency": "COP",
"fxSource": 4142.16,
"fxQuote": 0,
"amount": 1.2,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "COP",
"fxSource": 4128.7835662,
"fxQuote": 1,
"amount": 1500.00,
"account": "{{accountNumber}}"
},
"status": {
"code": "902",
"description": "RECALLED",
"detail": "The payout was recalled"
},
"sender": {
"type": "COMPANY",
"name": "Yakira",
"lastName": "Castano",
"document": {
"type": "NIT",
"id": "900.123.456-7"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Sally",
"lastName": "Perneth",
"document": {
"type": "NIT",
"id": "900.123.456-7"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Banco BOgotá",
"code": "1001",
"branch": {
"name": ""
},
"account": {
"type": "S",
"number": "221036882"
}
}
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Pagos Digitales Colombia SAS",
"lastName": "Villanueva",
"birthdate": "0001-01-01T00:00:00Z"
},
"date": {
"creationDate": "2025-03-05T14:49:10Z",
"processedDate": "2025-03-05T16:24:38Z"
},
"comment": "Prueba con cuenta exitosa stg"
}
}
{
"transactionType": "PayOut",
"transactionFlow": null,
"country": "ECU",
"data": {
"transactionType": "payOut",
"externalId": "c276afd4-082e-4844-8169-b985f829a99b",
"internalId": "35b79667-f6d7-4d76-9b94-93915a81b199",
"paymentMethod": {
"code": "0090"
},
"country": "ECU",
"currency": "USD",
"amount": 7.33,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "USD",
"fxQuote": 1.0,
"amount": 7.33
},
"payment": {
"currency": "USD",
"fxQuote": 1.0,
"amount": 7.33
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxQuote": 1.0,
"amount": 1.38
},
"status": {
"code": "901",
"description": "RETURNED",
"detail": "The payout was returned"
},
"sender": {
"type": "INDIVIDUAL",
"name": "Zinli John",
"lastname": "Zinli LastName",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Name Test Zinli",
"lastname": "LastName Test",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Guayaquil",
"code": "0017",
"account": {
"type": "S",
"number": "1234567890"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A.",
"birthdate": "0001-01-01T00:00:00Z"
},
"date": {
"creationDate": "2023-11-14T14:20:43Z",
"processedDate": "2023-11-14T14:27:49Z"
}
}
}
Eventos de Virtual Account
Criação de Virtual Account
Após a criação bem-sucedida de uma Virtual Account, o Localpayment enviará uma solicitação POST para o URL de retorno de chamada configurado. Essa notificação confirma que os detalhes da conta estão ativos e prontos para receber pagamentos.{
"transactionType": "VirtualAccount",
"data": {
"externalId": "88408f46-249d-4e3e-87e5-30548e679b14",
"internalId": "befd97b0-8dbc-4cfe-8117-a88533aa6961",
"accountNumber": "{{accountNumber}}",
"country": "MEX",
"currency": "USD",
"beneficiary": {
"type": "INDIVIDUAL",
"name": "John",
"lastname": "Doe",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"bank": {
"account": {
"number": "{{accountNumber}}"
}
}
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Virtual account has been created"
},
"errors": []
}
}
{
"transactionType": "VirtualAccount",
"data": {
"externalId": "3ad0f4d8-e559-4192-bda0-cbb0cda61a71",
"internalId": "8215eff4-94c0-45ab-9997-6190b560235b",
"accountNumber": "{{accountNumber}}",
"country": "MEX",
"currency": "USD",
"beneficiary": {
"type": "INDIVIDUAL",
"name": "John",
"lastname": "Doe",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"bank": {
"account": {
"number": "{{accountNumber}}"
}
}
},
"status": {
"code": "100",
"description": "INPROGRESS",
"detail": "Virtual account in progress"
},
"errors": []
}
}
Pagamento recebido (Payin)
Sempre que um cliente conclui um pagamento para uma Virtual Account, o Localpayment envia uma notificação webhook para o seu endpoint registrado. Todas as notificações de Payin seguem a mesma estrutura e contêm as mesmas informações, independentemente do momento ou do valor do pagamento. Isso inclui campos importantes como valor, moeda, status e referência da transação, permitindo que você automatize a conciliação e atualize os sistemas internos de acordo.{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "ARG",
"data": {
"transactionType": "PayIn",
"externalId": "114d4dc4-a0b1-4332-938b-35aebbca121b",
"internalId": "2dece31d-4f3f-402d-afa6-3314b835f851",
"paymentMethod": {
"type": "BankTransfer",
"code": "1025",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 1.09,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "ARS",
"fxQuote": 1,
"amount": 1.09
},
"payment": {
"currency": "ARS",
"fxQuote": 1,
"financingFee": 0,
"amount": 1.09
},
"localTaxes": [
{
"code": "0001",
"percentage": 1.2,
"description": "IDC",
"currency": "ARS",
"fxSource": 1193.82,
"fxQuote": 0,
"amount": 125.01,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 1170.50002,
"fxQuote": 1,
"amount": 45.02,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Jorge",
"lastName": "Villagra",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"bank": {
"account": {
"number": "0000369600000000000161"
}
},
"informedName": "Unknown"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Comercio Austral S.R.L.",
"lastName": "Localpayment Test"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Santiago",
"lastName": "LUCIANO GONZALEZ",
"document": {
"type": "DNI",
"id": "20-12345678-9"
},
"email": "NA",
"bank": {
"name": "BANCO DE GALICIA Y BUENOS AIRES S.A.U.",
"code": "007",
"branch": {},
"account": {
"type": "C",
"number": "0070055930004044938502"
}
}
},
"date": {
"creationDate": "2025-04-30T17:26:37.186",
"processedDate": "2025-04-30T17:26:37.363"
},
"errors": [],
"referenceCode": "DHF2-XOHO-NE77",
"tracking": {
"id": "7L8GYKNXWJELWYGP2MPRZ5",
"reference": "7L8GYKNXWJELWYGP2MPRZ5",
"concept": "CVU TEST"
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "BRA",
"data": {
"transactionType": "PayIn",
"externalId": "f3f1d81e-ff51-4833-b70b-a1ef37ca7d22",
"internalId": "b4262a31-22c0-4fd0-879e-ec40b30e9df4",
"paymentMethod": {
"type": "BankTransfer",
"code": "1350",
"flow": "DIRECT"
},
"country": "BRA",
"currency": "BRL",
"amount": 55554.63,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "BRL",
"fxQuote": 1,
"amount": 55554.63
},
"payment": {
"currency": "BRL",
"fxQuote": 1,
"financingFee": 0,
"amount": 55554.63
},
"localTaxes": [
{
"code": "0002",
"percentage": 0.38,
"description": "IOF",
"currency": "BRL",
"fxSource": 5.5813,
"fxQuote": 0,
"amount": 211.11,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "BRL",
"fxSource": 5.80427174,
"fxQuote": 1,
"amount": 5.57,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"type": "COMPANY",
"name": "ACME",
"lastName": "",
"document": {
"type": "CPF",
"id": "123.456.789-00"
},
"bank": {
"code": "450",
"branch": {},
"account": {
"number": "52415985301",
"alias": "cf226732-139c-4ec8-b672-8aa0fc7ee6ee",
"aliases": [
{
"value": "cf406732-139c-4ec8-b672-8aa0fc7ee6ee"
}
]
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Soluções Digitais Brasil Ltda"
},
"payer": {
"type": "COMPANY",
"name": "Ricardo",
"lastName": "",
"document": {
"type": "CPF",
"id": "123.456.789-00"
},
"email": "email@example.com",
"bank": {
"code": "001",
"branch": {},
"account": {
"type": "C",
"number": "45063"
}
}
},
"date": {
"creationDate": "2025-04-17T17:01:52.850",
"processedDate": "2025-04-17T17:01:53.025"
},
"errors": [],
"referenceCode": "5XWA-MGQ0-ZKZ6",
"tracking": {
"id": "E0000000022250417170028008753346",
"reference": "",
"concept": "11778498595"
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "CHL",
"data": {
"transactionType": "PayIn",
"externalId": "745c8b26-43b6-4ab3-88f5-4512e7a01332",
"internalId": "0957fbff-2c0c-417a-94dc-f9167dc607c4",
"paymentMethod": {
"type": "BankTransfer",
"code": "2550",
"flow": "DIRECT"
},
"country": "CHL",
"currency": "CLP",
"amount": 12000.0,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "CLP",
"fxQuote": 1,
"amount": 12000.0
},
"payment": {
"currency": "CLP",
"fxQuote": 1,
"financingFee": 0,
"amount": 12000.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "CLP",
"fxSource": 967.340406,
"fxQuote": 1,
"amount": 360.00,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"type": "COMPANY",
"name": "Localpayment Test",
"document": {
"type": "RUT",
"id": "12.345.678-9"
},
"bank": {
"name": "Banco Security",
"code": "049",
"branch": {},
"account": {
"type": "C",
"number": "928630996"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Inversiones Tecnológicas Chile SpA"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Javier",
"lastName": "Lopez",
"document": {
"type": "RUT",
"id": "12.345.678-9"
},
"email": "jane.doe@example.com",
"bank": {
"name": "BANCO DE CRÉDITO E INVERSIONES (BCI)",
"code": "016",
"branch": {},
"account": {
"type": "C",
"number": "57229333"
}
},
"userReference": "Test 928630996"
},
"date": {
"creationDate": "2025-07-16T16:12:50.163",
"processedDate": "2025-07-16T16:12:50.396"
},
"errors": [],
"referenceCode": "QSR5-FE1Y-DIVT",
"tracking": {
"id": "000739531483",
"reference": "2025-07-16-12.10.09.237295",
"concept": "Test 928630996"
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "COL",
"data": {
"transactionType": "PayIn",
"externalId": "34b3dc3b-321a-446d-8ba8-613cc409fe89",
"internalId": "743483bb-dc74-4677-b288-0561a41e4e6c",
"paymentMethod": {
"type": "BankTransfer",
"code": "2006",
"flow": "DIRECT"
},
"country": "COL",
"currency": "COP",
"amount": 50000.00,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "COP",
"fxQuote": 1.0,
"amount": 50000.00.0
},
"payment": {
"currency": "COP",
"fxQuote": 1.0,
"financingFee": 0.0,
"amount": 50000.00.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "COP",
"fxSource": 3705.82,
"fxQuote": 1.0,
"amount": 1500.00,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"type": "COMPANY",
"name": "LOCALPAYMENT",
"document": {
"type": "NIT",
"id": "900.123.456-7"
},
"bank": {
"name": "Banco Central",
"code": "",
"account": {
"type": "KEY",
"number": "@XXXXXXXOXX0000"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Pagos Digitales Colombia SAS",
"lastName": ""
},
"payer": {
"type": "INDIVIDUAL",
"name": "Andrés",
"lastName": "Doe",
"document": {
"type": "NIT",
"id": "900.123.456-7"
},
"email": "NA",
"bank": {
"name": "Banco Central",
"code": "001",
"account": {
"type": "BREB",
"number": "signer:wTUTnHK5mLAQXLgVuhoANKGaKTdgRFmrx7@breb"
}
}
},
"date": {
"creationDate": "2026-02-25T18:53:25Z",
"processedDate": "2026-02-25T18:53:26Z"
},
"errors": [],
"referenceCode": "V0ZO-AIPV-NOD9",
"tracking": {
"id": "20260225900504001TFY123451234500001",
"reference": "20260225900504001TFY123451234500001",
"concept": "Transfer via BRE-B"
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "MEX",
"data": {
"transactionType": "PayIn",
"externalId": "f22e35e1-297f-4e8a-b1d7-4d09bb0ce65f",
"internalId": "c90e4681-ea4c-49c4-b055-b5fe24813cd4",
"paymentMethod": {
"type": "BankTransfer",
"code": "1630",
"flow": "DIRECT"
},
"country": "MEX",
"currency": "MXN",
"amount": 250.00,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "MXN",
"fxQuote": 1,
"amount": 250.00
},
"payment": {
"currency": "MXN",
"fxQuote": 1,
"financingFee": 0,
"amount": 250.00
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "MXN",
"fxSource": 1,
"fxQuote": 1,
"amount": 7.50,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Pedro",
"lastName": "Perez",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"bank": {
"account": {
"number": "646011319800015054"
}
},
"informedName": "LPV3_PayinVA"
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A."
},
"payer": {
"type": "INDIVIDUAL",
"name": "Juan",
"lastName": "Sandoval",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"email": "NA",
"bank": {
"name": "Sistema de Transferencias y Pagos",
"code": "646",
"branch": {},
"account": {
"type": "C",
"number": "646010319800001674"
}
}
},
"date": {
"creationDate": "2024-02-19T20:18:30.373",
"processedDate": "2024-02-19T20:18:30.601"
},
"errors": [],
"referenceCode": "C2VV-MVVN-QHFI",
"tracking": {
"id": "lpv3_1111-19feb2024-2400",
"reference": "999999",
"concept": "concepto pago LPV3_4707"
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "MEX",
"data": {
"transactionType": "PayIn",
"externalId": "257bc359-a696-49ac-aee4-361ebaac9ab6",
"internalId": "d4588fb5-14ae-4584-b1fc-e231873645fd",
"paymentMethod": {
"type": "BankTransfer",
"code": "1698",
"flow": "DIRECT"
},
"country": "MEX",
"currency": "USD",
"amount": 1,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "USD",
"fxQuote": 1,
"amount": 1
},
"payment": {
"currency": "USD",
"fxQuote": 1,
"financingFee": 0,
"amount": 1
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxSource": 1,
"fxQuote": 1,
"amount": 1.38,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A.",
"document": {}
},
"payer": {
"type": "COMPANY",
"name": "Juan",
"lastName": "",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"email": "support@localpayment.com",
"bank": {
"name": "bbva",
"code": "012",
"branch": {},
"account": {
"type": "C",
"number": "012111111111111111"
}
}
},
"wireInstructions": {
"beneficiary": {
"name": "{{companyName}}",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"bank": {
"name": "Banco Central",
"code": "001",
"branch": {},
"account": {
"type": "C",
"number": "000111111111111111"
}
}
},
"referenceCode": "XXXX-XXXX-XXXX"
},
"date": {
"creationDate": "2025-11-19T19:44:34Z",
"processedDate": "2025-11-19T19:44:34Z"
},
"errors": [],
"referenceCode": "XXXX-XXXX-XXXX"
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "MEX",
"data": {
"transactionType": "PayIn",
"externalId": "36cc9a87-3f4f-4d92-a3f2-45dd9a4ddc1b",
"internalId": "e05fc3c3-f739-4393-b275-4a12f5a1af15",
"paymentMethod": {
"type": "BankTransfer",
"code": "1680",
"flow": "DIRECT"
},
"country": "MEX",
"currency": "MXN",
"amount": 250.00.01,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "MXN",
"fxQuote": 1,
"amount": 250.00.01
},
"payment": {
"currency": "MXN",
"fxQuote": 1,
"financingFee": 0,
"amount": 250.00.01
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "MXN",
"fxSource": 18.76902,
"fxQuote": 1,
"amount": 7.50,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"type": "COMPANY",
"name": "My Company",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"bank": {
"name": "Banco Central",
"code": "001",
"account": {
"number": "000000000000000009"
}
},
"informedName": "My Company"
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Digitales México S.A.",
"lastName": "Localpayment Test"
},
"payer": {
"type": "COMPANY",
"name": "Juan",
"lastName": "Doe",
"document": {
"type": "RFC",
"id": "HEMJ900101ABC"
},
"email": "NA",
"bank": {
"name": "BANCO INBURSA",
"code": "036",
"account": {
"type": "CLABE",
"number": "00000000000000000001"
}
}
},
"date": {
"creationDate": "2025-08-21T15:15:05.113",
"processedDate": "2025-08-21T15:15:05.346"
},
"errors": [],
"referenceCode": "AHB3-2LHB-8RG1",
"tracking": {
"id": "",
"reference": "",
"concept": "TESTTEFCOMP123"
}
}
}
{
"transactionType": "PayIn",
"transactionFlow": null,
"country": "PER",
"data": {
"transactionType": "PayIn",
"externalId": "13a694bc-cebc-41f9-bf18-2b9aa0a04ee0",
"internalId": "2685413d-d039-4251-9761-6a32b6a61cea",
"paymentMethod": {
"type": "BankTransfer",
"code": "6100",
"flow": "DIRECT"
},
"country": "PER",
"currency": "PEN",
"amount": 5,
"accountNumber": "{{accountNumber}}",
"confirmed": {
"currency": "PEN",
"fxQuote": 1,
"amount": 5
},
"payment": {
"currency": "PEN",
"fxQuote": 1,
"financingFee": 0,
"amount": 5
},
"localTaxes": [
{
"code": "0006",
"percentage": 0.005,
"description": "ITF",
"currency": "PEN",
"fxSource": 3.742498,
"fxQuote": 0,
"amount": 125.0,
"account": "{{accountNumber}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "PEN",
"fxSource": 3.386033,
"fxQuote": 1,
"amount": 2.55,
"account": "{{accountNumber}}"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"bank": {
"account": {
"number": "92250610000000101234"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Servicios Web Perú SAC"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Luis",
"lastName": "DOE",
"email": "NA",
"bank": {
"name": "INTERBANK (BANCO INTERNACIONAL DEL PERÚ)",
"code": "003",
"branch": {},
"account": {
"type": "C",
"number": "00310701315123456789"
}
}
},
"date": {
"creationDate": "2025-10-20T16:07:50Z",
"processedDate": "2025-10-20T16:07:50Z"
},
"errors": [],
"referenceCode": "6WXD-CXLO-U8UN",
"tracking": {
"id": "2025102011074908084191797675",
"reference": "00100000297079044806",
"concept": ""
}
}
}
Eventos de Câmbio
Os campos a seguir são específicos para eventos de webhook de câmbio de moedas:| Campo | Tipo | Descrição |
|---|---|---|
fxquoteToken | string | O token associado à cotação cambial usada para esta conversão. Corresponde ao token retornado pelo endpoint de Conversão de Moeda da Cotação. |
methodcode | string | O código do método de pagamento que identifica a rota de conversão cambial utilizada internamente. |
Completed
{
"transactionType": "CurrencyExchange",
"transactionFlow": "CurrencyExchange",
"data": {
"externalId": "d075a9e9-2acf-44e4-a457-09fa0e1b0cdc",
"internalId": "0efa58c1-c073-4aa3-9367-b97c15363770",
"currency": "USD",
"paymentCurrency": "MXN",
"amount": 10.0,
"paymentAmount": 175.0,
"fxQuote": 17.5,
"fxquoteToken": "5c3q89a7-f1bc-4ba5-a3b5-411ba0d144ca",
"accountNumber": "{{accountNumber}}",
"transactionType": "CurrencyExchange",
"methodcode": "1005",
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "CURRENCY EXCHANGE"
},
"dateCreated": "2023-10-24T16:07:09Z",
"dateProcessed": "2023-10-24T16:07:14Z"
}
}
Eventos de Liquidação
Wire In
Completed
{
"transactionType": "WireIn",
"transactionFlow": null,
"country": "BOL",
"data": {
"externalId": "70124586-65ea-4403-8edd-27958fe14582",
"internalId": "b8db4f96-5e27-4a42-b2df-348631abd576",
"currency": "BOB",
"paymentCurrency": "BOB",
"amount": 855.0,
"accountNumber": "{{accountNumber}}",
"transactionType": "WireIn",
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Completed"
},
"dateCreated": "2025-04-07T16:48:49Z",
"dateProcessed": "2025-04-07T16:49:18Z"
}
}
Wire Out
Completed
{
"transactionType": "WireOut",
"transactionFlow": null,
"country": "BOL",
"data": {
"externalId": "5c4ffd77-0496-486b-89dd-cceb4b0cbce5",
"internalId": "c9976aa5-b8b5-447b-8893-b2cbddb4def4",
"currency": "BOB",
"paymentCurrency": "BOB",
"amount": 19,
"accountNumber": "{{accountNumber}}",
"transactionType": "WireOut",
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Completed"
},
"dateCreated": "2025-04-07T16:49:41Z",
"dateProcessed": "2025-04-07T16:49:43Z"
}
}
Wire Out (cripto)
Quando um Wire Out é pago em uma criptomoeda suportada (por exemplo, USDT ou USDC), o callback de conclusão também inclui um campohash com o hash da transação na blockchain, para que você possa verificar o pagamento de forma independente em um explorador de blocos. Esse campo não está presente nos payloads de Wire Out em moeda fiduciária.
Completed (crypto)
{
"transactionType": "WireOut",
"transactionFlow": null,
"country": "BOL",
"data": {
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"internalId": "5aced5da-40c1-4bec-85ff-c8cd1bcb4526",
"currency": "USDT",
"paymentCurrency": "USDT",
"amount": 19,
"accountNumber": "{{accountNumber}}",
"transactionType": "WireOut",
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Completed"
},
"hash": "0x4a2f8e1c9b3d7a6f5e2c1b8a9d4e3f2c1b0a9e8d7c6b5a4f3e2d1c0b9a8f7e6d",
"dateCreated": "2025-04-07T16:49:41Z",
"dateProcessed": "2025-04-07T16:49:43Z"
}
}
Referência de campo
Compreender os campos detalhados na carga útil do webhook é essencial para a reconciliação e liquidação corretas.| Campo | Categoria | Descrição |
|---|---|---|
fxSource | FX | Identificador interno da fonte da taxa de câmbio utilizada para a conversão. |
fxQuote | FX | A taxa de câmbio específica aplicada no momento da transação. |
localTaxes | Financeiro | Conjunto de objetos fiscais aplicados à transação com base nas regulamentações locais. |
fees | Financial | Detalhes das taxas de processamento aplicadas a esta transação específica. |
confirmed | Liquidação | O valor final e a moeda que serão creditados em sua conta comercial. |
hash | Liquidação | Hash da transação na blockchain para um Wire Out cripto concluído. Presente apenas quando a moeda do Wire Out é uma criptomoeda suportada. |

