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
  • API Flow
  • Wire In API
  • Wire In API
  • Example API
  • Wire In instruction by V3 Front

Was this helpful?

  1. SETTLEMENT & EXCHANGE

Wire In

A Wire In is the process of electronically transferring funds from an external bank account to the payment processor's account

PreviousRFI - DocumentationNextWire Out

Last updated 1 year ago

Was this helpful?

It is an operation that impacts the balance of the suppliers' accounts. The information is reflected in the account balance and in reports.

There are two ways to process a Wire In: API flow and V3 Front.

The flow begins with the request for a Wire In via API or Front, The transaction remains in Pending Credit status. (at the time of creation you can attach the transfer receipt)

The Wire In remains pending waiting for the operations team to validate the transaction as correct, it becomes approved (Completed) otherwise it is rejected, if 2 weeks pass without news, the instruction automatically expires (Expired)

API Flow

Wire In API

In your postman you must configure the request in Body-form-data.

Key: request; text

Value: paste the request

Key:filecontent;File

Value: Attach receipt (optional)

Example receipt

The file format can be in .png .jpg .jpeg .pdf or .txt

Wire In API

POST {{api_environment_url}/api/account/wire-in

Headers

Name
Type
Description

Content-Type*

String

application/json

Authorization*

String

Mandatory. Bearer JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

fileContent

String

Optional. Transfer receipt

Request Body

Name
Type
Description

transactiontype*

String

Mandatory. Add the transaction type:"WireIn

currency*

String

Mandatory. The currency in which the amount is expressed.

amount*

String

Mandatory. Amount to charge to your end user

comment

String

Optional. A comment related to the transaction. It should be something meaningful to your business.

externalId*

String

Mandatory. An ID that is meaningful to you and your system. Must be unique.

accountNumber*

String

Mandatory. Your Localpayment account number in which the amount will be credited.

To*

Object

Beneficiary data

name*

String

Mandatory. Beneficiary name.

swift*

String

Mandatory. Bank identification code most used to make international money transfers.

address*

String

Mandatory. Bank´s Address

accountNumber*

String

Mandatory. Beneficiary account number

accountName*

String

Mandatory. Beneficiary owner name

beneficiaryAddress*

String

Mandatory. Address of the account holder

From

Object

Mandatory. Details of the ordering bank

name

String

Mandatory. It is the name of the ordering Bank.

swift*

String

Mandatory. Ordering bank identification code to make international money transfers.

address*

String

Mandatory. Address of the ordering bank,

accountNumber*

String

Mandatory. Account number of de holder of the ordering bank

routingNumber

String

Transaction identifier code, that is, to indicate the banking entities of origin and destination of the transfers in the United States

accountName*

String

Mandatory. Name of the holder of the ordering bank account

beneficiaryAddress*

String

Mandatory. Address of the account holder of the ordering bank

intermediaryBankName

String

intermediaryBankSwift

String

intermediaryAccountNume

String

intermediaryAccountNumber

String

Optional

intermediaryBankSwift

String

Optional

intermediaryBankName

String

Optional

{
    "transactionType": "WireIn",
    "externalId": "External15",
    "internalId": "0f1d47dc-e9c6-4fdf-8ba1-c9b29916574d",
    "country": "ARG",
    "currency": "ARS",
    "clientCode": "0001",
    "creationDate": "2024-02-28T13:47:58.808+00:00",
    "errors": [],
    "status": {
        "code": "100",
        "description": "PENDING_CREDIT",
        "detail": "WIRE IN"
    },
    "accountNumber": "032.032.00000082",
    "amount": 49500.0,
    "fees": {
        "description": "Fee",
        "currency": "ARS",
        "amount": 500.0,
        "account": "032.032.00000082"
    },
    "localTaxes": [],
    "withHoldings": [],
    "comment": "Ducupublica"
}
{
    "detail": "Given token not valid for any token type",
    "code": "token_not_valid",
    "messages": [
        {
            "token_class": "AccessToken",
            "token_type": "access",
            "message": "Token is invalid or expired"
        }
    ]
}

Example API

{
    "transactionType": "WireIn",
    "currency": "ARS",
    "country": "ARG",
    "amount": 50000,
    "comment": "Comment",
    "externalId": "{{externalId}}",
    "accountNumber": "accountNumber",
    "to": {
        "name": "Bankname",
        "swift": "BCBHDOSD",
        "address": "BankAddress",
        "accountNumber": "BankAccountNumber",
        "accountName": "BeneficiaryBankName",
        "beneficiaryAddress": "BeneficiaryAddress"
    },
     "from": {
        "name": "OrderingBankName",
        "swift": "BICAARBS",
        "address": "OrderingBankAddress",
        "accountNumber": "BankAccountNumber",
        "routingNumber": null,
        "accountName": "accountName",
        "beneficiaryAddress": "BeneficiaryAddress",
        "intermediaryBankName": null,
        "intermediaryBankSwift": null,
        "intermediaryAccountNumer": null
    }
}
{
    "transactionType": "WireIn",
    "externalId": "External16",
    "internalId": "23f42463-f673-4de5-b537-dee016a954f3",
    "country": "ARG",
    "currency": "ARS",
    "clientCode": "0001",
    "creationDate": "2024-02-28T14:27:01.253+00:00",
    "errors": [],
    "status": {
        "code": "100",
        "description": "PENDING_CREDIT",
        "detail": "WIRE IN"
    },
    "accountNumber": "032.032.00000082",
    "amount": 49500.0,
    "fees": {
        "description": "Fee",
        "currency": "ARS",
        "amount": 500.0,
        "account": "032.032.00000082"
    },
    "localTaxes": [],
    "withHoldings": [],
    "comment": "Ducupublica"
}
{
    "externalId": "External18",
    "internalId": "c7748610-6b33-4aa4-9a9b-8d6ad2bb5312",
    "errors": [
        {
            "code": "300",
            "detail": "This account doesn't have a WireIn configuration"
        }
    ],
    "status": {
        "code": "300",
        "description": "REJECTED",
        "detail": "This account doesn't have a WireIn configuration"
    }
}

Wire In instruction by V3 Front

Next, review the guide to generate a Wire In instruction in dashboard of V3

149KB
Example Receipt.jpg
image
Wire In Flow