Create Wire Out

Initiate a Wire Out to settle funds from your Localpayment account to your own external bank account.

Wire Out vs. Payout

  • A Wire Out is a settlement / withdrawal: funds move from your Localpayment account to your own external bank account. The beneficiary defined in the to object must be you, the same account holder as the source account, never a third party.
  • A Payout is a disbursement to an end recipient (typically your customer). If you need to send funds to a third party, use the Create Payout endpoint instead.

To initiate a Wire Out, provide:

  • Destination bank details (your own external bank account): bank name, swift, bank address, accountName, accountNumber, and beneficiaryAddress. The account holder must match you as the source account owner.
  • Source Localpayment account: the accountNumber of the Localpayment account from which the funds will be debited.
  • Transfer details: amount, currency, country, transactionType set to "WireOut", your externalId, and an optional comment.

On success, Localpayment returns an internalId you can use to track the wire transfer. You can monitor its status from RECEIVED through Completed (funds credited to your destination bank account) or Rejected.

Body Params
to
object
required

Destination bank account for the Wire Out. The beneficiary must be you, the same account holder as the source account. Wire Out is a settlement to your own external bank account, not a payout to a third party. Use Create Payout if the recipient is your customer.

number
required

Transaction amount.

string

A comment or note associated with the transaction.

string
required

Document country. ISO 3166-1 alpha-3.

string
required
string
required

A unique identifier generated by your system to track the transaction (alphanumeric and hyphens). We recommend using UUID4 to ensure uniqueness.

string
required

Localpayment account number.

string
required

Type of transaction being processed.

Headers
string
required

Bearer access token for authentication. This token is obtained from the Get Access Token or Refresh Access Token endpoints.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json