Callbacks - Webhooks

Get updates on transaction status

The following transactions notify status changes in the configured URLs according to the following detail:

PAYINS CASH

{
    "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": []
    }
}

PAYINS BANK TRANSFER MASTER ACCOUNT

{
  "transactionType": "PayIn",
  "transactionFlow": null,
  "data": {
    "transactionType": "PayIn",
    "externalId": "XXXXX",
    "internalId": "XXXXX",
    "paymentMethod": {
      "type": "BankTransfer",
      "code": "1027",
      "flow": "direct"
    },
    "country": "ARG",
    "currency": "ARS",
    "amount": 7000,
    "accountNumber": "XXXXX",
    "confirmed": {
      "currency": "ARS",
      "fxQuote": 1,
      "amount": 7000
    },
    "payment": {
      "currency": "ARS",
      "fxQuote": 1,
      "financingFee": 0,
      "amount": 7000
    },
    "localTaxes": [
      {
        "code": "0001",
        "percentage": 1.2,
        "description": "IDC",
        "currency": "ARS",
        "fxSource": 221.515899,
        "fxQuote": 0,
        "amount": 84,
        "account": "XXXXX"
      }
    ],
    "withHoldings": [],
    "fees": {
      "description": "Fee",
      "currency": "ARS",
      "fxSource": 221.515899,
      "fxQuote": 1,
      "amount": 200,
      "account": "XXXXX"
    },
    "status": {
      "code": "200",
      "description": "COMPLETED",
      "detail": "The payin was credited"
    },
    "merchant": {
      "type": "COMPANY",
      "name": "Merchant name",
      "lastname": "Merchant lastname",
      "document": {
        "type": "XXXXX",
        "id": "XXXXX"
      },
      "email": "[email protected]"
    },
    "payer": {
      "type": "INDIVIDUAL",
      "name": "Payer name",
      "lastname": "Payer lastname",
      "document": {
        "type": "XXXXX",
        "id": "XXXXX"
      },
      "email": "[email protected]",
      "bank": {
        "name": "Payer fullname",
        "code": "007",
        "account": {
          "type": "C",
          "number": "XXXXX"
        }
      }
    },
    "intermediaries": [],
    "wireInstructions": {
      "beneficiary": {
        "name": "LOCALPAYMENT SRL",
        "document": {
          "type": "CUIT",
          "id": "30716132028"
        },
        "bank": {
          "name": "BANCO BICA",
          "code": "0055",
          "branch": {},
          "account": {
            "type": "C",
            "number": "4260004000100091408087"
          }
        }
      },
      "referenceCode": "ZSS9-S6W5-S6N5"
    },
    "date": {
      "creationDate": "2023-05-01T00:47:05Z",
      "processedDate": "2023-05-01T00:47:06Z",
      "expirationDate": "2023-05-08T00:47:06Z"
    },
    "errors": []
  }
}
 {
    "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",
  "transactionType": "PayIn",
  "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"
    }
  }
}

REQUEST VIRTUAL ACCOUNTS (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": "100",
      "description": "INPROGRESS",
      "detail": "Virtual account in progress"
    },
    "errors": []
  }
}

PAYINS BANK TRANSFER 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": []
}

PAYINS CARDS:

DEBIT CARD

{
    "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": []
    }
}

CREDIT CARD

{
    "transactionType": "PayIn",
    "transactionFlow": null,
    "data": {
        "transactionType": "PayIn",
        "externalId": "1685975447",
        "internalId": "1XX6X8X3-XXX6-4XX6-X822-X8X2X112840X",
        "paymentMethod": {
            "type": "CreditCard",
            "code": "1000",
            "flow": "DIRECT"
        },
        "country": "ARG",
        "currency": "ARS",
        "amount": 0.0,
        "accountNumber": "032.032.00000000",
        "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": 0.2,
                "description": "IDC",
                "currency": "ARS",
                "fxSource": 0.00,
                "fxQuote": 0.0,
                "amount": 0.0,
                "account": "032.032.00000000"
            }
        ],
        "withHoldings": [],
        "fees": {
            "description": "Fee",
            "currency": "ARS",
            "fxSource": 0.0,
            "fxQuote": 0.0,
            "amount": 0.0,
            "account": "032.032.00000000"
        },
        "status": {
            "code": "103",
            "description": "APPROVED",
            "detail": "The payin was confirmed but not credited yet"
        },
        "merchant": {
            "type": "INDIVIDUAL",
            "name": "Netflix Argentina",
            "lastname": "Solo si es type INDIVIDUAL",
            "document": {
                "type": "CUIT",
                "id": "30558251405"
            },
            "email": "[email protected]",
            "phone": {
                "countryCode": "1",
                "areaCode": "11",
                "number": "98999632"
            },
            "address": {
                "street": "Charruas",
                "number": "938",
                "city": "Hurlingham",
                "state": "state",
                "country": "Argentina",
                "zipCode": "1688",
                "comment": "porte 801"
            },
            "birthdate": "1994-02-20",
            "nationality": "Argentino"
        },
        "payer": {
            "type": "INDIVIDUAL",
            "name": "Fernanda",
            "lastname": "Gomez",
            "document": {
                "type": "DNI",
                "id": "39993831"
            },
            "email": "[email protected]",
            "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": []
    }
}

SUSCRIPTIONS

{
  "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": 0,
    "accountNumber": "111.111.00000011",
    "confirmed": {
      "currency": "ARS",
      "fxQuote": 0,
      "amount": 00
    },
    "payment": {
      "currency": "ARS",
      "fxQuote": 0,
      "financingFee": 0,
      "amount": 00
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
      "description": "Fee",
      "currency": "USD",
      "fxSource": 0,
      "fxQuote": 0,
      "amount": 0.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": []
  }
}

CHARGEBACKS

REFUNDS CARDS

REFUND CASH & BANK

PAYOUTS

{
    "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 "
        }
    }
}

INTERNAL TRANSFER

RECURRING FEE

CURRENCY EXCHANGE

{
    "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 "
    }
}

WIRE IN

WIRE OUT

PreviousInternal Foreign TransferNextConfigurations

Last updated

Was this helpful?