Webhooks
With the Webhooks/Callbacks you get the updates on transaction status.
Localpayment uses webhooks to notify your application about events that occur in your account. Webhooks are particularly useful for asynchronous events like when a payment is confirmed, a payout is processed, or a subscription status changes.
Overview
Webhooks provide real-time notifications about transaction status changes and other important events in your Localpayment account. Instead of polling our API for status updates, you can configure webhook endpoints to receive instant notifications when events occur.
Real-time Updates
Receive instant notifications when transaction status changes
Multiple Events
Support for payins, payouts, virtual accounts, subscriptions and more
Secure Delivery
HMAC signature verification ensures webhook authenticity
How Webhooks Work
- Event Occurs: A transaction status changes in Localpayment's system
- HTTP POST Request: Localpayment sends a JSON payload to your webhook endpoint
- Signature Verification: Your endpoint verifies the request using the x-Signature header
- Acknowledge Receipt: Your endpoint returns a 200 OK response
- Process Event: Your application handles the webhook data asynchronously
Prerequisites
Before setting up webhooks, ensure you have:
Webhook Endpoint
A publicly accessible HTTPS endpoint to receive webhooks
Secret Key
Your webhook secret key from the Localpayment Dashboard
Configuration
Dashboard Setup
- Navigate to Configurations → Clients in your Localpayment Dashboard.
- Select the client you want to configure.
- Click on the Notifications tab and choose the webhook type to configure.
- Click the Add button and enter the following information:
| Setting | Description | Required |
|---|---|---|
| URL | Your webhook endpoint URL (must be HTTPS) | ✅ |
| Country | Select a specific country or choose "All" for global coverage | ✅ |
| Account | Localpayment account associated with the webhook | ✅ |
| Add Header | Add custom headers sent with the webhook (Key-Value pairs) | ❌ |
Security & Authentication
Localpayment signs all webhook requests with an HMAC signature to verify their authenticity.
Signature Verification
Each webhook request includes an x-Signature header containing an HMAC-SHA256 signature. Verify this signature using your webhook secret key.
Example Implementation
using System;
using System.Collections.Generic;
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)
{
//calculate the signature
var verifiedHash = ComputeHash(secret, payload);
//Validate the signature
if (!String.IsNullOrEmpty(verifiedHash) && !String.IsNullOrEmpty(signature) && signature.ToLower().Equals(verifiedHash.ToLower()))
{
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 {
//Returns a Mac object that implements the specified MAC algorithm.
Mac sha256_HMAC = Mac.getInstance(ALGORITHM);
//Constructs a secret key from the given byte array.
SecretKeySpec secret_key = new SecretKeySpec(key.getBytes("UTF-8"), ALGORITHM);
//Initializes this Mac object with the given key.
sha256_HMAC.init(secret_key);
//Processes the given array of bytes and finishes the MAC operation.
byte[] MAC = sha256_HMAC.doFinal(data.getBytes("UTF-8"));
//return: the MAC result .
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 {
//calculate the signature
String verifiedHash = calculateHMAC(secret, payload);
//Validate the signature
if (Objects.nonNull(verifiedHash) && Objects.nonNull(signature) && signature.toLowerCase().equals(verifiedHash.toLowerCase())) {
return true;
}
return false;
}
//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();
}
}Webhook Payloads
All webhook payloads share a common structure with event-specific data in the data object. This consistent format makes it easier to parse and handle webhooks across different event types.
Common Webhook Structure
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
// ... event-specific data
}
}The following fields are always present in every webhook payload, regardless of the event type:
| Field | Type | Description | Possible Values |
|---|---|---|---|
| transactionType | string | High-level category of the transaction | PayIn, VirtualAccount, Subscription, PayOut, CurrencyExchange |
| transactionFlow | string | null | Specific flow or processing type | CurrencyExchange, null (when not applicable) |
| data | object | Event-specific payload containing transaction details | Varies by transaction type (see examples below) |
Payin Events
Card Payments (Credit/Debit)
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "1006080000",
"internalId": "1a111111-11ab-1111-adc1-1da1caa11aad",
"paymentMethod": {
"type": "DebitCard",
"code": "1007",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0.0,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"fxQuote": 0.0,
"amount": 0.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 0.0
},
"localTaxes": [
{
"code": "0001",
"percentage": 1.2,
"description": "IDC",
"currency": "ARS",
"fxSource": 24,
"fxQuote": 0.0,
"amount": 1.0,
"account": "111.111.11111111"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0.0,
"amount": 0.0,
"account": "111.111.11111111"
},
"status": {
"code": "103",
"description": "APPROVED",
"detail": "The payin was confirmed but not credited yet"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Merchants name",
"lastname": "Merchants last name",
"document": {
"type": "PASS",
"id": "C03007592"
},
"email": "[email protected]",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98999632"
},
"address": {
"street": "Street",
"number": "938",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any usefull information"
},
"birthdate": "2000-01-01",
"nationality": "nationality"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Payers name",
"lastname": "Payers last name",
"document": {
"type": "DNI",
"id": "40236471"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98779632"
},
"address": {
"street": "Street",
"number": "1234",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "nationality"
},
"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": []
}
}{
"transactionType ": "PayIn ",
"transactionFlow ": null,
"data ": {
"transactionType ": "PayIn ",
"externalId ": "1679509790 ",
"internalId ": "11111111-1111-1e11-11ff-101df11111ae ",
"paymentMethod ": {
"type ": "DebitCard ",
"code ": "1005 ",
"flow ": "DIRECT "
},
"country ": "ARG ",
"currency ": "ARS ",
"amount ": 0,
"accountNumber ": "111.111.00000022",
"confirmed ": {
"currency ": "ARS ",
"fxQuote ": 0,
"amount ": 0
},
"payment ": {
"currency ": "ARS ",
"fxQuote ": 0,
"financingFee ": 0,
"amount ": 0
},
"localTaxes ": [],
"withHoldings ": [],
"fees ": {
"description ": "Fee ",
"currency ": "ARS ",
"fxSource ": 0,
"fxQuote ": 0,
"amount ": 0,
"account ": "111.111.00000022"
},
"status ": {
"code ": "906 ",
"description ": "CHARGEBACK",
"detail ": "The payin has a chargeback "
},
"merchant ": {
"type ": "INDIVIDUAL ",
"name ": "PRUEBA ",
"lastname ": "YURA ",
"document ": {
"type ": "PASS ",
"id ": "C03007592 "
},
"email ": "[email protected] ",
"phone ": {
"countryCode ": "54 ",
"areaCode ": "11 ",
"number ": "98789632 "
},
"address ": {
"street ": "Street ",
"number ": "938 ",
"city ": "city ",
"state ": "state ",
"country ": "country ",
"zipCode ": "zipCode ",
"comment ": "Add any usefull information "
},
"birthdate ": "2000-01-01 ",
"nationality ": "nationality "
},
"payer ": {
"type ": "INDIVIDUAL ",
"name ": "Pruebas ",
"lastname ": "cambio de estado ",
"document ": {
"type ": "DNI ",
"id ": "40238471 "
},
"email ": "[email protected] ",
"phone ": {
"countryCode ": "1 ",
"areaCode ": "11 ",
"number ": "98789632 "
},
"address ": {
"street ": "Street ",
"number ": "1234 ",
"city ": "city ",
"state ": "state ",
"country ": "country ",
"zipCode ": "zipCode ",
"comment ": "Add any relevant information related to the payer "
},
"birthdate ": "01/01/1990 ",
"nationality ": "nationality "
},
"intermediaries ": [],
"date ": {
"creationDate ": "2023-03-22T18:29:49Z ",
"processedDate ": "2023-03-22T18:29:52Z "
},
"card ": {
"token ": "wf6q35MjZNsX1CH7tgeNoFUYYD1iN41ozLX73PiuG0I= ",
"bin ": "451766 ",
"brand ": "VISA ",
"country ": "AR{
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "23737146",
"internalId": "1f11b1c1-ed11-1eb1-ad11-11f11b1f111a",
"paymentMethod": {
"type": "DebitCard",
"code": "1603",
"flow": "DIRECT"
},
"country": "MEX",
"currency": "MXN",
"amount": 0.0,
"accountNumber": "111.111.00000022",
"confirmed": {
"currency": "MXN",
"fxQuote": 0.0,
"amount": 0.0
},
"payment": {
"currency": "MXN",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 0.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "MXN",
"fxSource": 0,
"fxQuote": 0.0,
"amount": 0.0,
"account": "111.111.00000022"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "COMPANY",
"name": "XXX Lim",
"lastname": "",
"document": {
"type": "",
"id": ""
},
"email": "[email protected]"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Karla",
"lastname": "Muñoz",
"document": {
"type": "RFC",
"id": "AACK811201BT5"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": ""
},
"address": {
"street": "",
"number": "1",
"city": "",
"state": "AG",
"country": "MEX",
"zipCode": ""
}
},
"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
}
}
}{
"transactionType ": "PayIn ",
"transactionFlow ": null,
"data ": {
"transactionType ": "PayIn ",
"externalId ": "1679111111 ",
"internalId ": "11111e11-a111-1e1c-1111-11f1ab111111 ",
"paymentMethod ": {
"type ": "DebitCard ",
"code ": "1005 ",
"flow ": "DIRECT "
},
"country ": "ARG ",
"currency ": "ARS ",
"amount ": 0,
"accountNumber ": "111.111.00000022",
"confirmed ": {
"currency ": "ARS ",
"fxQuote ": 0,
"amount ": 0
},
"payment ": {
"currency ": "ARS ",
"fxQuote ": 0,
"financingFee ": 0,
"amount ": 0
},
"localTaxes ": [],
"withHoldings ": [],
"fees ": {
"description ": "Fee ",
"currency ": "ARS ",
"fxSource ": 0,
"fxQuote ": 0,
"amount ": 0,
"account ": "111.111.0000002"
},
"status ": {
"code ": "902 ",
"description ": "REFUNDED ",
"detail ": "The payin was refunded "
},
"merchant ": {
"type ": "INDIVIDUAL ",
"name ": "PRUEBA ",
"lastname ": "YURA ",
"document ": {
"type ": "PASS",
"id ": "C03007592 "
},
"email ": "[email protected] ",
"phone ": {
"countryCode ": "54",
"areaCode ": "11 ",
"number ": "98999632 "
},
"address ": {
"street ": "Street ",
"number ": "938 ",
"city ": "city ",
"state ": "state ",
"country ": "country ",
"zipCode ": "zipCode ",
"comment ": "Add any usefull information "
},
"birthdate ": "2000-01-01 ",
"nationality ": "nationality "
},
"payer ": {
"type ": "INDIVIDUAL ",
"name ": "Pruebas ",
"lastname ": "cambio de estado",
"document ": {
"type ": "DNI ",
"id ": "43236471 "
},
"email ": "[email protected] ",
"phone ": {
"countryCode ": "1 ",
"areaCode ": "11 ",
"number ": "98799632 "
},
"address ": {
"street ": "Street ",
"number ": "1234 ",
"city ": "city ",
"state ": "state ",
"country ": "country ",
"zipCode ": "zipCode ",
"comment ": "Add any relevant information related to the payer "
},
"birthdate ": "01/01/1990 ",
"nationality ": "nationality "
},
"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 ": []
}
}{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"externalId": "62280683",
"internalId": "1111ffb1-11b1-111f-bcf1-1e1111111fdd",
"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": 1000,
"amount_captured": 0,
"amount_refunded": 0,
"application": null,
"application_fee": null,
"application_fee_amount": null,
"balance_transaction": null,
"billing_details": {
"address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": "[email protected]",
"name": "John, Jairo",
"phone": "+1 1111111"
},
"calculated_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": "[email protected]",
"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": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": "[email protected]",
"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": "[email protected]",
"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": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": null,
"state": null
},
"email": "[email protected]",
"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"
}
}
}
}
}Cash Payments
{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "1111111111",
"internalId": "1X111111-11X1-1111-1111-1X1111X1X111",
"paymentMethod": {
"type": "Cash",
"code": "1111",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0.0,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 0.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0,
"fxQuote": 0,
"amount": 0,
"account": "111.111.11111111"
},
"status": {
"code": "103",
"description": "APPROVED",
"detail": "The payin was confirmed but not credited yet"
},
"ticket": {
"id": "1111111",
"image": "https://api.stage.localpayment.com/api/images/1610/99580010002149257000000000000000000000604232359000025030098",
"barcode": "99580010002149257000000000000000000000604232359000025030098",
"expirationDate": "2023-03-24T17:07:04Z"
},
"merchant": {
"type": "COMPANY",
"name": "Merchant's name",
"lastname": "",
"document": {
"type": "CUIT",
"id": "11111111111"
},
"email": "[email protected]",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "11111111"
},
"address": {
"street": "Street",
"number": "111",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any usefull information"
},
"birthdate": "2000-01-01",
"nationality": "nationality"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Yura",
"lastname": "Arias",
"document": {
"type": "CUIT",
"id": "11111111111"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "11111111"
},
"address": {
"street": "Street",
"number": "1234",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "nationality"
},
"intermediaries": [],
"date": {
"creationDate": "2023-03-22T17:07:03Z",
"processedDate": "2023-03-22T17:07:05Z",
"expirationDate": "2023-03-24T17:07:04Z"
},
"errors": []
}
}{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "1111111111",
"internalId": "X11X1XX1-X11X-111X-11X1-X11XXXXX1111",
"paymentMethod": {
"type": "Cash",
"code": "1111",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0.0,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 0.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 0.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0.0,
"fxQuote": 0,
"amount": 0,
"account": "111.111.11111111"
},
"status": {
"code": "900",
"description": "CANCELLED",
"detail": "The payin was cancelled"
},
"ticket": {
"id": "2149263",
"image": "https://api.stage.localpayment.com/api/images/1610/99580010002149263000000000000000000000604232359000053080073",
"barcode": "99580010002149263000000000000000000000604232359000053080073",
"expirationDate": "2023-03-24T17:48:57Z"
},
"merchant": {
"type": "COMPANY",
"name": "Prueba Yura",
"lastname": "",
"document": {
"type": "CUIT",
"id": "20115872045"
},
"email": "[email protected]",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "11111111"
},
"address": {
"street": "Street",
"number": "111",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any usefull information"
},
"birthdate": "2000-01-01",
"nationality": "nationality"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Yura",
"lastname": "Arias",
"document": {
"type": "CUIT",
"id": "11111111111"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "11111111"
},
"address": {
"street": "Street",
"number": "1234",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "nationality"
},
"intermediaries": [],
"date": {
"creationDate": "2023-03-22T17:48:56Z",
"processedDate": "2023-03-22T17:48:59Z",
"expirationDate": "2023-03-24T17:48:57Z"
},
"errors": []
}
}{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "11111111",
"internalId": "cfb68f11-b111-1111-1ce1-11a1xxff111b",
"paymentMethod": {
"type": "Cash",
"code": "1602",
"flow": "DIRECT"
},
"country": "MEX",
"currency": "MXN",
"amount": 500.0,
"accountNumber": "111.111.00000022",
"confirmed": {
"currency": "MXN",
"fxQuote": 0.0,
"amount": 0.0
},
"payment": {
"currency": "MXN",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 0.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "MXN",
"fxSource": 0.000,
"fxQuote": 0.0,
"amount": 0.6,
"account": "111.111.00000022"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"ticket": {
"id": "pi_0N0XGyG0II6I0x000hWbTd0k",
"image": "https://api.v3.localpayment.com/api/images/Code128C/11001113235262120230512011200011",
"barcode": "11002073231111110110111011100011",
"expirationDate": "2023-05-12T22:38:44Z"
},
"merchant": {
"type": "COMPANY",
"name": "Odreval Limited",
"lastname": "",
"document": {
"type": "",
"id": ""
},
"email": "[email protected]"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Valeria",
"lastname": "Perez",
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "+522231039010"
},
"address": {
"street": "",
"number": "1",
"city": "",
"state": "AG",
"country": "MEX",
"zipCode": ""
}
},
"intermediaries": [],
"date": {
"creationDate": "2023-05-05T22:38:41Z",
"processedDate": "2023-05-05T22:38:46Z",
"expirationDate": "2023-05-12T22:38:44Z"
},
"errors": []
}
}{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "1111111111",
"internalId": "111X1111-111X-1111-X11X-X11XX1X1111X",
"paymentMethod": {
"type": "Cash",
"code": "1002",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0.00,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 0
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 0.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "ARS",
"fxSource": 0.00,
"fxQuote": 0,
"amount": 0,
"account": "111.111.11111111"
},
"status": {
"code": "901",
"description": "EXPIRED",
"detail": "The payin has expired"
},
"ticket": {
"id": "2149258",
"image": "https://api.stage.localpayment.com/api/images/1610/99580010002149258000000000000000000000604232359000053080017",
"barcode": "99580010002149258000000000000000000000604232359000053080017",
"expirationDate": "2023-03-24T17:38:39Z"
},
"merchant": {
"type": "COMPANY",
"name": "Prueba Yura",
"lastname": "",
"document": {
"type": "CUIT",
"id": "11111111111"
},
"email": "[email protected]",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "11111111"
},
"address": {
"street": "Street",
"number": "111",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any usefull information"
},
"birthdate": "2000-01-01",
"nationality": "nationality"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Yura",
"lastname": "Arias",
"document": {
"type": "CUIT",
"id": "11111111111"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "11111111"
},
"address": {
"street": "Street",
"number": "1234",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "nationality"
},
"intermediaries": [],
"date": {
"creationDate": "2023-03-22T17:38:39Z",
"processedDate": "2023-03-22T17:38:40Z",
"expirationDate": "2023-03-24T17:38:39Z"
},
"errors": []
}
}{
"transactionType": "PayIn",
"transactionFloww": null,
"data": {
"externalId": "11111111",
"internalId": "11xx1111-x1x1-11x1-xx1x-11x1xx111xx1",
"status": {
"code": "801",
"description": "REJECTED",
"detail": "Params error"
},
"errors": [
{
"code": "300",
"detail": "Invalid param + [payer.document.id] + doesn´t match regex ^[a-zA-Z][a-zA-Z]d{11}$"
}
]
}
}Bank Transfer Master Account
{
"transactionType": "PayIn",
"externalId": "xxxxxx",
"internalId": "XXXXX",
"paymentMethod": {
"type": "BankTransfer",
"code": "XXX",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0.00,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 0.00
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 0.00
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxSource": 0,
"fxQuote": 0,
"amount": 0.0,
"account": "111.111.11111111"
},
"status": {
"code": "XXX",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "COMPANY",
"name": "Company name",
"lastname": "",
"document": {
"type": "CUIT",
"id": "XXXXX"
},
"email": "[email protected]",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "XXXX"
},
"address": {
"street": "Street",
"number": "938",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any usefull information"
},
"birthdate": "2000-01-01",
"nationality": "nationality"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Payers name",
"lastname": "Payers last name",
"document": {
"type": "CUIT",
"id": "XXXXX"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "XXXXX"
},
"address": {
"street": "Street",
"number": "1234",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "nationality",
"bank": {
"name": "Account holder name",
"code": "XXX",
"account": {
"type": "s",
"number": "XXXXXXXXX"
}
}
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"name": "LOCALPAYMENT S.R.L.",
"document": {
"type": "CUIT",
"id": "XXXXXXXXX"
},
"bank": {
"name": "XXXXXX",
"code": "XXXXX",
"branch": {},
"account": {
"type": "C",
"number": "XXXXXXXXX"
}
}
},
"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": [],
"code": "200",
"transactionFlow": "payInBankTransfer",
"createdOn": "2023-03-14T20:04:25.197+00:00",
"createdBy": "[email protected]",
"executionData": {
"paymentMethodProvider": {
"country": "ARG",
"currency": "ARS",
"accountType": "C",
"providerCode": "XXXXX",
"providerName": "XXXXXXX",
"accountNumber": "XXXXXXXXXXXXX",
"accountOwnerCode": "0001",
"accountOwnerName": "LOCALPAYMENT S.R.L.",
"paymentMethodCode": "XXXXX"
}
}
}{
"transactionType": "PayIn",
"externalId": "XXXXXXXXX",
"internalId": "XXXXXXXXXXX",
"paymentMethod": {
"type": "BankTransfer",
"code": "XXXXXX",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0.00,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 0.00
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 0.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxSource": 0,
"fxQuote": 0,
"amount": 0.0,
"account": "111.111.11111111"
},
"status": {
"code": "901",
"description": "EXPIRED",
"detail": "The payin has expired"
},
"merchant": {
"type": "COMPANY",
"name": "Company name",
"lastname": "",
"document": {
"type": "XXXX",
"id": "XXXXXXX"
},
"email": "[email protected]",
"phone": {
"countryCode": "XX",
"areaCode": "XX",
"number": "XXXXXX"
},
"address": {
"street": "Street",
"number": "XXX",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any usefull information"
},
"birthdate": "2000-01-01",
"nationality": "nationality"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Payers name",
"lastname": "Payers last name",
"document": {
"type": "CUIT",
"id": "XXXXXXXX"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "XXXXXX"
},
"address": {
"street": "Street",
"number": "XXXX",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "nationality",
"bank": {
"name": "Account holder name",
"code": "XXX",
"account": {
"type": "s",
"number": "XXXXXXXXXXXXXXX"
}
}
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"name": "LOCALPAYXXXXX.",
"document": {
"type": "CUIT",
"id": "XXXXXXXXXX"
},
"bank": {
"name": "BANCO XXXX",
"code": "XXXX",
"branch": {},
"account": {
"type": "C",
"number": "XXXXXXXXXX"
}
}
},
"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": [],
"code": "901",
"transactionFlow": "payInBankTransfer",
"createdOn": "2023-03-14T21:41:35.568+00:00",
"createdBy": "[email protected]",
"executionData": {
"paymentMethodProvider": {
"country": "ARG",
"currency": "ARS",
"accountType": "C",
"providerCode": "0051",
"providerName": "BANCO XXXXX",
"accountNumber": "XXXXXXXXXXXX",
"accountOwnerCode": "0001",
"accountOwnerName": "LOCALPAYMENT S.R.L.",
"paymentMethodCode": "XXXXX"
}
}
}{
"transactionType": "PayIn",
"externalId": "XXXX",
"internalId": "XXXXX",
"paymentMethod": {
"type": "BankTransfer",
"code": "XXXX",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0.0,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"amount": 100.0,
"fxQuote": 0.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0.0,
"financingFee": 0.0,
"amount": 100.0
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "XXX",
"currency": "USD",
"fxSource": 0.0,
"fxQuote": 0.0,
"amount": 100.00,
"account": "111.111.11111111"
},
"status": {
"code": "100",
"description": "INPROGRESS",
"detail": "The payin is pending the confirmation"
},
"merchant": {
"type": "COMPANY",
"name": "Company name",
"lastname": "",
"document": {
"type": "XXXXX",
"id": "XXXXXX"
},
"email": "[email protected]",
"phone": {
"countryCode": "XXX",
"areaCode": "XXX",
"number": "XXXXXXX"
},
"address": {
"street": "Street",
"number": "938",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any usefull information"
},
"birthdate": "2000-01-01",
"nationality": "nationality"
},
"payer": {
"bank": {
"name": "Account holder name",
"code": "XXXX",
"account": {
"type": "s",
"number": "XXXXXXXX"
}
},
"type": "INDIVIDUAL",
"name": "Payers name",
"lastname": "Payers last name",
"document": {
"type": "CUIT",
"id": "XXXXXXX"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "XXXXXXX"
},
"address": {
"street": "Street",
"number": "XXXXX",
"city": "city",
"state": "state",
"country": "country",
"zipCode": "zipCode",
"comment": "Add any relevant information related to the payer"
},
"birthdate": "01/01/1990",
"nationality": "nationality"
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"bank": {
"name": "XXXXX",
"code": "XXX",
"branch": {},
"account": {
"type": "C",
"number": "XXXXXXX"
}
},
"type": "INDIVIDUAL",
"name": "LOCALPAYMENT S.R.L.",
"document": {
"type": "CUIT",
"id": "XXXXXXXX"
}
},
"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",
"externalId": "XXXXXXXX",
"internalId": "XXXXXXXXXXXXX",
"paymentMethod": {
"type": "BankTransfer",
"code": "XXXX",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 0,
"accountNumber": "111.111.11111111",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 0.0
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 0.00
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxSource": 0.0,
"fxQuote": 0,
"amount": 0.0,
"account": "111.111.11111111"
},
"status": {
"code": "XXXX",
"description": "REFUNDED",
"detail": "The payin was refunded"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "XXXXX",
"lastname": "XXXXX",
"document": {
"type": "DNI",
"id": "XXXXXX"
},
"email": "[email protected]",
"phone": {
"countryCode": "54",
"areaCode": "XX",
"number": "XXXXX"
},
"address": {
"street": "Charruas",
"number": "938",
"city": "XXXXXX",
"state": "state",
"country": "Argentina",
"zipCode": "XXXXX",
"comment": "XXXX"
},
"birthdate": "2000-01-01",
"nationality": "Argentinian"
},
"payer": {
"type": "INDIVIDUAL",
"name": "XXXX",
"lastname": "XXXXX",
"document": {
"type": "CUIT",
"id": "20379938311"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "XXXX"
},
"address": {
"street": "XXXXX",
"number": "XXX",
"city": "XX",
"state": "XXXX",
"country": "USA",
"zipCode": "1686",
"comment": "XXXXXXXXXXXX"
},
"birthdate": "01/01/1990",
"nationality": "American"
},
"intermediaries": [],
"wireInstructions": {
"beneficiary": {
"name": "LOCALPAYMENT XXXXX",
"document": {
"type": "CUIT",
"id": "XXXXXXXX"
}
},
"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": [],
"code": "902",
"transactionFlow": "payInBankTransfer",
"createdOn": "2022-08-02T15:35:58.091+00:00",
"createdBy": "[email protected]",
"executionData": {
"paymentMethodProvider": {
"country": "ARG",
"currency": "ARS",
"accountType": "Checking",
"providerCode": "0002",
"providerName": "ICBC",
"accountNumber": "3333",
"referenceCode": "XXXXXX",
"accountOwnerCode": "0001",
"accountOwnerName": "XXXXXXXXX.",
"paymentMethodCode": "XXXXX"
}
}
}{
"transactionType": "PayIn",
"data": {
"externalId": "11111111",
"internalId": "1111e111-a111-1e11-1f1d-11111bbc1fa1",
"status": {
"code": "701",
"description": "REJECTED",
"detail": "IncorrectAccountNumber"
},
"errors": [
{
"code": "701",
"detail": "Invalid bank account type for the country"
}
]
}
}Bank Transfer to a Virtual Account
{
"transactionType": "PayIn",
"externalId": "b3ad8643-0823-4e77-8x0c-6cc465c776a4",
"internalId": "a11d345b-0c27-4xca-88ee-fdd7f187e4c1",
"paymentMethod": {
"type": "BankTransfer",
"code": "1630",
"flow": "DIRECT"
},
"country": "MEX",
"currency": "MXN",
"amount": 1754,
"accountNumber": "484.840.00000017",
"confirmed": {
"currency": "USD",
"fxQuote": 18.5562473,
"amount": 94.52
},
"payment": {
"currency": "MXN",
"fxQuote": 1,
"financingFee": 0,
"amount": 1754
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxSource": 1,
"fxQuote": 1,
"amount": 2.84,
"account": "484.840.00000017"
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Payer name",
"lastname": "Payer lastname",
"document": {
"type": "ND",
"id": "ND"
},
"bank": {
"account": {
"number": "646010319800000141"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Merchant name",
"lastname": "",
"document": {
"type": "CUIT",
"id": "20000000005"
},
"email": "NA"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Payer name",
"lastname": "Payer lastname",
"document": {
"type": "ND",
"id": "ND"
},
"email": "NA",
"bank": {
"name": "Banco Azteca",
"code": "127",
"branch": {
"code": "",
"name": ""
},
"account": {
"type": "C",
"number": "120000000006304585"
}
}
},
"wireInstructions": {
"beneficiary": {
"name": "MEXIPAGOS SA DE CV",
"document": {
"type": "RFC",
"id": "MEX2003191F4"
},
"bank": {
"name": "Sistema de Transferencias y Pagos STP",
"code": "0031",
"branch": {},
"account": {
"type": "C",
"number": "646180319800000000"
}
}
},
"referenceCode": "JILQ-SG3D-YAAM"
},
"date": {
"creationDate": "2023-01-12T17:35:32.416Z",
"processedDate": "2023-01-12T17:35:33.135Z"
},
"errors": []
}Subscriptions
{
"transactionType": "Subscription",
"data": {
"internalId": "985XX849-X075-4XX9-X1Xf-X11XX8XXX816",
"externalId": "XX633XXX-X070-4c8c-99XX-a93X90XXXX5X",
"country": "ARG",
"currency": "ARS",
"clientCode": "0000",
"accountNumber": "111.111.00000011",
"status": {
"code": "903",
"description": "CANCELLED",
"detail": "The subscription was canceled - merchant request"
}
}
}{
"transactionType": "PayIn",
"transactionFlow": null,
"data": {
"transactionType": "PayIn",
"externalId": "62768X41-0XX0-4937-XX99-21517XX84763",
"internalId": "40XX1XX2-XX6X-43XX-X581-X3650610X4X3",
"paymentMethod": {
"type": "CreditCard",
"code": "0000",
"flow": "DIRECT"
},
"country": "ARG",
"currency": "ARS",
"amount": 100,
"accountNumber": "111.111.00000011",
"confirmed": {
"currency": "ARS",
"fxQuote": 0,
"amount": 100
},
"payment": {
"currency": "ARS",
"fxQuote": 0,
"financingFee": 0,
"amount": 100
},
"localTaxes": [],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "USD",
"fxSource": 0,
"fxQuote": 0,
"amount": 100.0,
"account": "111.111.00000011"
},
"status": {
"code": "000",
"description": "COMPLETED",
"detail": "The payin was credited"
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Obi Wan",
"lastname": "Kenobi",
"document": {
"type": "DNI",
"id": "12345678"
},
"email": "[email protected]",
"phone": {
"countryCode": "54",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Charruas",
"number": "938",
"city": "Hurlingham",
"state": "state",
"country": "Argentina",
"zipCode": "1688",
"comment": "portero 801"
},
"birthdate": "2000-01-01",
"nationality": "Argentinian"
},
"payer": {
"type": "INDIVIDUAL",
"name": "Luke",
"lastname": "Skywalker",
"document": {
"type": "DNI",
"id": "37993830"
},
"email": "[email protected]",
"phone": {
"countryCode": "1",
"areaCode": "11",
"number": "98789632"
},
"address": {
"street": "Siempre viva",
"number": "1234",
"city": "Springfield",
"state": "Ohio",
"country": "USA",
"zipCode": "1686",
"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": "985de849-a075-4eb9-a1df-b11af8dbd816",
"externalId": "ab111cea-b111-1c8c-11eb-a93c90aebf5c",
"country": "ARG",
"currency": "ARS",
"clientCode": "0001",
"accountNumber": "111.111.00000015",
"status": {
"code": "105",
"description": "INPROGRESS",
"detail": "The subscription is in progress"
}
}
}{
"transactionType": "Subscription",
"data": {
"internalId": "X298X565-7XXX-443X-8X84-98X99865X276",
"externalId": "169901338560",
"country": "ARG",
"currency": "ARS",
"clientCode": "0000",
"accountNumber": "111.111.00000011",
"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": []
}
}Payout Events
{
"transactionType ": "PayOut ",
"transactionFlow ": null,
"data ": {
"transactionType ": "payOut ",
"externalId ": "XXXXXXX",
"internalId ": "XXXXXXXXX",
"paymentMethod ": {
"code ": "0050 "
},
"country ": "Country",
"currency ": "Currency",
"amount ": 1.0,
"accountNumber ": "{{Account Number}}",
"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.0
},
"status ": {
"code ": "900 ",
"description ": "CANCELLED ",
"detail ": "The payout was cancelled "
},
"sender ": {
"type ": "INDIVIDUAL ",
"name ": "Sender Name",
"lastname ": "Sender LastName ",
"document ": {
"type ": "{{Document type}}",
"id ": "Document id"
},
"birthdate ": "0001-01-01T00:00:00Z "
},
"beneficiary ": {
"type ": "INDIVIDUAL ",
"name ": "Beneficiary Name ",
"lastname ": "Beneficiary LastName ",
"document ": {
"type ": "Type",
"id ": "Document Id"
},
"birthdate ": "0001-01-01T00:00:00Z ",
"bank ": {
"name ": "Banco",
"code ": "049 ",
"account ": {
"type ": "C ",
"number ": "Account Number"
}
}
},
"merchant ": {
"type ": "COMPANY ",
"name ": "Merchant Name ",
"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 ": "XXXXX",
"internalId ": "XXXXXXXXXXXX",
"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.0
},
"status ": {
"code ": "200 ",
"description ": "COMPLETED ",
"detail ": "The payout was debited "
},
"sender ": {
"type ": "INDIVIDUAL ",
"name ": "Sender Name",
"lastname ": "Sender LastName ",
"document ": {
"type ": "{{type}}",
"id ": "Document id "
},
"birthdate ": "0001-01-01T00:00:00Z "
},
"beneficiary ": {
"type ": "INDIVIDUAL ",
"name ": "Beneficiary Name ",
"lastname ": "Beneficiary LastName ",
"document ": {
"type ": "{{type}}",
"id ": "Document id"
},
"birthdate ": "0001-01-01T00:00:00Z ",
"bank ": {
"name ": "Banco",
"code ": "001 ",
"account ": {
"type ": "C ",
"number ": "Account Number"
}
}
},
"merchant ": {
"type ": "COMPANY ",
"name ": "Merchant Name ",
"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": "{{externalId}}",
"internalId": "{{internalId}}",
"paymentMethod": {
"code": "0060"
},
"country": "Country",
"currency": "Currency",
"amount": 0.0,
"accountNumber": "yourAccount",
"confirmed": {
"currency": "Country",
"fxQuote": 0.0,
"amount": 100.0
},
"payment": {
"currency": "Currency",
"fxQuote": 0.0,
"amount": 100.0
},
"localTaxes": [
{
"description": "ROUTERTEST",
"currency": "currency",
"fxSource": 0,
"fxQuote": 0.0,
"amount": 0.0,
"account": "{{yourAccount}}"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "currency",
"fxSource": 0,
"fxQuote": 0,
"amount": 0,
"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": "CC",
"id": "111111111"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Name Test ",
"lastName": "LastName Test",
"document": {
"type": "CC",
"id": "1000000000"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Bank",
"code": "1062",
"account": {
"type": "S",
"number": "accountNumber"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name",
"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 ": "111111111",
"internalId ": "11111111111",
"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.0
},
"status ": {
"code ": "302 ",
"description ": "REJECTED ",
"detail ": "Invalid control string characters "
},
"sender ": {
"type ": "INDIVIDUAL ",
"name ": "Sender",
"lastname ": "Sender LastName ",
"document ": {
"type ": "{{type}}",
"id ": "{{DocumentId}} "
},
"birthdate ": "0001-01-01T00:00:00Z "
},
"beneficiary ": {
"type ": "INDIVIDUAL ",
"name ": "Beneficiary Name ",
"lastname ": "Beneficiary LastName ",
"document ": {
"type ": "Type",
"id ": "{{DocumentId}}"
},
"birthdate ": "0001-01-01T00:00:00Z ",
"bank ": {
"name ": "Banco",
"code ": "049 ",
"account ": {
"type ": "Type",
"number ": "AccountNumber"
}
}
},
"merchant ": {
"type ": "COMPANY ",
"name ": "Merchant Name ",
"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": "1741186150",
"internalId": "d6d08113-e295-464d-aa10-fa007abeb871",
"paymentMethod": {
"code": "0061"
},
"country": "COL",
"currency": "COP",
"amount": 301,
"accountNumber": "170.170.00000031",
"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": "170.170.00000031"
}
],
"withHoldings": [],
"fees": {
"description": "Fee",
"currency": "COP",
"fxSource": 4128.7835662,
"fxQuote": 1,
"amount": 0,
"account": "170.170.00000031"
},
"status": {
"code": "902",
"description": "RECALLED",
"detail": "The payout was recalled"
},
"sender": {
"type": "COMPANY",
"name": "Yakira",
"lastName": "Castano",
"document": {
"type": "CPF",
"id": "34669130000133"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Sally",
"lastName": "Perneth",
"document": {
"type": "CC",
"id": "27736877"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Banco BOgotá",
"code": "1001",
"branch": {
"name": ""
},
"account": {
"type": "S",
"number": "221036882"
}
}
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Brenda Aldana",
"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": "1699971645",
"internalId": "cac67c58-8058-48e2-b1bc-a0a877ecd1e9",
"paymentMethod": {
"code": "0090"
},
"country": "ECU",
"currency": "USD",
"amount": 7.33,
"accountNumber": "218.840.00000013",
"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": 2.5
},
"status": {
"code": "901",
"description": "RETURNED",
"detail": "The payout was returned"
},
"sender": {
"type": "INDIVIDUAL",
"name": "Zinli John",
"lastname": "Zinli LastName",
"document": {
"type": "CI",
"id": "1713175077"
},
"birthdate": "0001-01-01T00:00:00Z"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Name Test Zinli ",
"lastname": "LastName Test",
"document": {
"type": "PASS",
"id": "PX39582891478"
},
"birthdate": "0001-01-01T00:00:00Z",
"bank": {
"name": "Guayaquil",
"code": "0017",
"account": {
"type": "S",
"number": "1234567890"
}
}
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name",
"birthdate": "0001-01-01T00:00:00Z"
},
"date": {
"creationDate": "2023-11-14T14:20:43Z",
"processedDate": "2023-11-14T14:27:49Z"
}
}
}Virtual Account Events
Virtual Account Creation
{
"transactionType": "VirtualAccount",
"data": {
"externalId": "XXXXX",
"internalId": "XXXXX",
"accountNumber": "111.111.11111111",
"country": "ARG",
"currency": "ARS",
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Juan",
"lastname": "Perez",
"document": {
"type": "XXXXX",
"id": "XXXXX"
},
"bank": {
"account": {
"number": "111.111.11111111"
}
}
},
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Virtual account has been created"
},
"errors": []
}
}{
"transactionType": "VirtualAccount",
"data": {
"externalId": "XXXXX",
"internalId": "XXXXX",
"accountNumber": "111.111.11111111",
"country": "ARG",
"currency": "ARS",
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Juan",
"lastname": "Perez",
"document": {
"type": "XXXXX",
"id": "XXXXX"
},
"bank": {
"account": {
"number": "111.111.11111111"
}
}
},
"status": {
"code": "100",
"description": "INPROGRESS",
"detail": "Virtual account in progress"
},
"errors": []
}
}Currency Exchange Events
{
"transactionType ": "CurrencyExchange ",
"transactionFlow ": "CurrencyExchange ",
"data ": {
"externalId ": " ",
"internalId ": "111111-241f-4522-b0e5-11111111 ",
"currency ": "currecy",
"paymentCurrency ": "paymentCurrency",
"amount ": 10.0,
"paymentAmount ": 10.0,
"fxQuote ": 1.0,
"fxquoteToken ": " ",
"accountNumber ": "{{AccountNumber}}",
"transactionType ": "CurrencyExchange ",
"methodcode ": " ",
"status ": {
"code ": "200 ",
"description ": "COMPLETED ",
"detail ": "CURRENCY EXCHANGE "
},
"dateCreated ": "2023-10-24T16:07:09Z ",
"dateProcessed ": "2023-10-24T16:07:14Z "
}
}Settlement Events
Wire In
{
"transactionType": "WireIn",
"transactionFlow": null,
"country": "BOL",
"data": {
"externalId": "DFDFD",
"internalId": "8d022217-00c3-44ea-a469-58e437f2959f",
"currency": "BOB",
"paymentCurrency": "BOB",
"amount": 855.0,
"accountNumber": "068.068.00000127",
"transactionType": "WireIn",
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Completed"
},
"dateCreated": "2025-04-07T16:48:49Z",
"dateProcessed": "2025-04-07T16:49:18Z"
}
}Wire Out
{
"transactionType": "WireOut",
"transactionFlow": null,
"country": "BOL",
"data": {
"externalId": "OUOUOUO",
"internalId": "18d72c16-0473-480d-a2fb-5853840c53d5",
"currency": "BOB",
"paymentCurrency": "BOB",
"amount": 19,
"accountNumber": "068.068.00000127",
"transactionType": "WireOut",
"status": {
"code": "200",
"description": "COMPLETED",
"detail": "Completed"
},
"dateCreated": "2025-04-07T16:49:41Z",
"dateProcessed": "2025-04-07T16:49:43Z"
}
}.
Updated 4 days ago
