Documentation V3
  • Localpayment documentation V3
  • INTRODUCTION TO OUR SOLUTION
    • Intro to our Documentation
    • Intro to Payment Methods in Emerging Markets
    • Merchant Dashboard
      • Dashboard Navigation
      • Login
      • User Roles
      • Roles
      • Users
      • Whitelist your IPs
      • Whitelist your BINs
      • Setup your Webhooks
      • Reports
        • Balance
        • Projected Balance
        • Activity
        • Transaction Detail
        • FIDES Report
      • Virtual accounts
      • Refunds
        • Refund Bank Transfer
        • Refund Card Capture
        • Refund Cash
      • Chargeback
      • Internal Domestic Transfer
      • Internal Foreign Transfer
      • Currency Exchange
        • Create
      • Wire In
      • Wire Out
    • Intro to FX operations
    • Business definitions
      • Payins
      • Payouts
    • Onboarding & Integration
    • Postman Collection
  • ENVIRONMENTS
    • Environments
  • BEFORE A PAYMENT
    • Access Token
    • Validations
      • Document Validation
      • Bank Account Validation
      • Validate BIN
    • Holidays
    • Search Payment Method
    • Search Bank Codes
    • Cash Agents Geolocalization
    • Installments Plan Quote
    • Currency Exchange Quote
    • Billing Service
      • Create
        • Mexico
      • Check Billing status
      • Download Billing
  • REQUEST A PAYMENT
    • Payins
      • Bank Transfer
        • Direct debit
          • DEBIN (Argentina)
          • Transfiya (Colombia)
          • Wallet Fri (Guatemala)
        • Virtual Account
          • Mexico
            • Request Individual
            • Request Batch
            • Check Virtual account
            • Delete Virtual account
            • Enable or Disable Virtual Account
          • Brazil
            • Request Individual
            • Check Virtual account
            • Alias ​​configuration
          • Argentina
            • Request Individual
            • Request Batch
            • Check virtual account
            • Delete Virtual account
          • Refund Virtual Account
        • Online Reference Code Payments
          • Mexico
        • Refund Bank Transfer
        • Cancel
        • APMs
          • CODI (Mexico)
          • ETPAY (Chile)
          • Fintoc (Chile)
          • Boleto (Brazil)
          • PIX (Brazil)
            • Refund Pix
          • PSE (Colombia)
          • QR (Bolivia)
          • QR (Guatemala)
          • QR (Argentina)
          • QR (Perú)
      • Cash
        • Cash
          • APMs
            • Boleto (Brazil)
        • Cancel
        • Refund Cash
      • Debit Card
        • Capture
        • Refund Capture
      • Credit Card
        • Capture
        • Create Authorization
        • Capture Authorization
        • Cancel Authorization
        • Refund Capture
        • Installments
        • Save Cards
          • Save Card
          • Get Card
          • Delete Card
        • 3D-Secure
        • Validate card
        • Chargebacks
          • Notification
          • Send documentation
          • Close Chargeback
    • Payin Subscriptions
      • Create a subscription
      • Update subscription
      • Cancel
    • Payin Subscriptions Plan
      • Create subscription plan
      • Update subscription plan
      • Get subscription plan
    • Payouts
      • Search available banks
      • Create
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
          • Colombia ACH
          • Colombia Transfiya
        • Costa Rica
        • Dominic Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panama
        • Peru
        • Kenya
      • Manual Upload
        • Create Batch Upload
        • Batch Pending Authorization
        • Cancel Batch Pending Authorization
        • Batch Activity
      • Proof of Payment (POP)
      • Cancel
      • Commit payout
      • Attach documents
      • Ripplenet getway
    • Payouts Double Signature
      • Authorize
    • Checkout
      • Webcheckout
        • Credit Card
        • Debit Card
        • Cash
        • Bank Transfer
      • Link Payment
      • Frequent Items
      • Iframe
      • Smart Checkout/ iframe
      • Virtual Pos
      • Plugins
        • Magento
        • Shopify
        • Google Pay
        • WooCommerce
  • AFTER A PAYMENT
    • Check Status
    • Check Payment
    • Check Payment list
    • Check Subscription
    • Account Balance
      • Balance Reconciliation
      • Current Balance Amount
    • Withholding Certificates
    • Proof of Payment
    • RFI - Documentation
  • SETTLEMENT & EXCHANGE
    • Wire In
    • Wire Out
    • Currency Exchange Bulk
      • Quote
      • Bulk
      • Currency exchange - Front end
    • Internal Transfers
      • Internal Domestic Transfer
      • Internal Foreign Transfer
  • NOTIFICATIONS
    • Callbacks - Webhooks
      • Configurations
      • Payins
        • Payin Bank Transfer
        • PSE Colombia
        • Payin Virtual Account
        • Payin Cash
        • Payin Credit Card
        • Payin Debit Card
      • Payouts
    • SFTP- Email Reports
  • API REFERENCE GUIDE
    • Validation Error Codes
    • Transaction Type & Status
      • Payin
      • Subscriptions
      • Payout
      • Chargeback
      • Credit
      • Currency Exchange
      • Debit
      • Expenses
      • Internal Transfer
      • Recall
      • Refund
      • Return
      • Recurring Fee
      • Wire in
      • Wire out
    • Payout Methods + SLA
      • Latam
    • Payin Methods + SLA
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Mexico
      • Panama
      • Peru
    • Currency Codes
      • Latam
    • Country Codes
      • Latam
    • Bank codes
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Honduras
        • Mexico
        • Panamá
        • Peru
    • Bank account validations
      • Latam
        • Argentina
        • Bolivia
        • Brazil
        • Chile
        • Colombia
        • Costa Rica
        • Dominican Republic
        • Guatemala
        • Mexico
        • Panama
        • Peru
    • Document Validations
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Costa Rica
      • Dominican Republic
      • El Salvador
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
    • Concept Codes
  • FLOWS AND CHARACTERISTICS
    • Account Currencies
    • Involved Parties
    • Payin Status Flow
      • Payins
        • Payin Status Flow - Card
        • Payin Status Flow - Bank
        • Payin Status Flow -Cash
      • Refund - Card
      • Refund - Cash & Bank
      • Chargeback
    • Payout Status Flow
      • Payout - Bank
      • Return
      • Recall
    • Payin Subscription Flow
      • Payins Subscription Status Flow - Card
    • Virtual Account Status Flow
    • Settlement Status Flow
      • Wire In
      • Wire Out
    • Payin Methods Flow
      • Argentina
      • Bolivia
      • Brazil
      • Chile
      • Colombia
      • Dominican Republic
      • Guatemala
      • Honduras
      • Mexico
      • Panama
      • Peru
  • HOLIDAYS
    • 2021
    • 2022
    • 2023
    • 2024
    • 2025
  • COMPLIANCE
    • Values
    • Prohibited Countries
    • Prohibited Business
    • Compliance Program Docs
    • Licenses
    • Terms & Conditions
  • GLOSSARY
    • Payments Explained
    • FAQ
  • PLUGINS
    • Magento
    • Shopify
    • Google Pay
    • WooCommerce
    • Ripplenet
Powered by GitBook
On this page

Was this helpful?

  1. NOTIFICATIONS
  2. Callbacks - Webhooks
  3. Payins

Payin Cash

Examples of callbacks for Payin Cash transactions

{
        "accountNumber": "111.111.1111111",
        "amount": 3630,
        "confirmed": {
            "amount": 3630,
            "currency": "MXN",
            "fxQuote": 1
        },
        "country": "MEX",
        "currency": "MXN",
        "date": {
            "creationDate": "2023-03-22T00:33:40.969+00:00",
            "expirationDate": "2023-03-29T00:33:41.992723",
            "processedDate": "2023-03-22T00:33:43.708599"
        },
        "errors": [
        ],
        "externalId": "11111",
        "fees": {
            "account": "111.111.11111111",
            "amount": 163.35,
            "currency": "MXN",
            "description": "Fee",
            "fxQuote": 19.45852386,
            "fxSource": 18.620597
        },
        "intermediaries": [
        ],
        "internalId": "111X1XX1-11X1-1XXX-1X11-1XX11X111X1X",
        "localTaxes": [
        ],
        "merchant": {
            "birthdate": "",
            "email": "",
            "lastname": "",
            "name": "Minipagos",
            "nationality": "",
            "type": "COMPANY"
        },
        "payer": {
            "birthdate": "",
            "document": {
                "id": "XXXX111111XX1",
                "type": "RFC"
            },
            "email": "alicia@ramirez.com.mx",
            "lastname": "RAMIREZ",
            "name": "ALICIA",
            "nationality": "",
            "type": "INDIVIDUAL"
        },
        "payment": {
            "amount": 3630,
            "currency": "MXN",
            "financingFee": 0,
            "fxQuote": 1
        },
        "paymentMethod": {
            "code": "1111",
            "flow": "DIRECT",
            "type": "Cash"
        },
        "status": {
            "code": "000",
            "description": "COMPLETED",
            "detail": "The payin was credited"
        },
        "ticket": {
            "barcode": "1111111111111111111111111111111",
            "expirationDate": "2023-03-29T00:33:41.992723",
            "id": "XXXXXX1XX1X1X111XXXXXXX",
            "image": "https://api.v3.localpayment.com/api/images/1602/46140050210916220230328036300059"
        },
        "transactionType": "PayIn",
        "withHoldings": [
        ]
    },
    "status": "COMPLETED",
    "transactionFlow": "payInCash",
    "transactionType": "PayIn"
}
{
  "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": 5308,
    "accountNumber": "111.111.11111111",
    "confirmed": {
      "currency": "ARS",
      "fxQuote": 1,
      "amount": 5308
    },
    "payment": {
      "currency": "ARS",
      "fxQuote": 1,
      "financingFee": 0,
      "amount": 5308
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
      "description": "Fee",
      "currency": "ARS",
      "fxSource": 205.406971,
      "fxQuote": 1,
      "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": "mail@mail.com",
      "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": "payer@email.com",
      "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": "1111111111",
    "internalId": "111X1111-111X-1111-X11X-X11XX1X1111X",
    "paymentMethod": {
      "type": "Cash",
      "code": "1002",
      "flow": "DIRECT"
    },
    "country": "ARG",
    "currency": "ARS",
    "amount": 5308,
    "accountNumber": "111.111.11111111",
    "confirmed": {
      "currency": "ARS",
      "fxQuote": 1,
      "amount": 5308
    },
    "payment": {
      "currency": "ARS",
      "fxQuote": 1,
      "financingFee": 0,
      "amount": 5308
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
      "description": "Fee",
      "currency": "ARS",
      "fxSource": 205.406971,
      "fxQuote": 1,
      "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": "mail@mail.com",
      "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": "payer@email.com",
      "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",
  "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": 2503,
    "accountNumber": "111.111.11111111",
    "confirmed": {
      "currency": "ARS",
      "fxQuote": 1,
      "amount": 2503
    },
    "payment": {
      "currency": "ARS",
      "fxQuote": 1,
      "financingFee": 0,
      "amount": 2503
    },
    "localTaxes": [],
    "withHoldings": [],
    "fees": {
      "description": "Fee",
      "currency": "ARS",
      "fxSource": 205.406971,
      "fxQuote": 1,
      "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": "mail@mail.com",
      "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": "payer@email.com",
      "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": []
  }
}
PreviousPayin Virtual AccountNextPayin Credit Card

Last updated 1 year ago

Was this helpful?