Create

Localpayment's API works 24/7/365, to review our payment execution times and notification times please review our SLA page:

Payout Methods + SLA

LogoDocument ValidationsDocumentation V3

Create Payout

POST https://api.stage.localpayment.com /api/payout

Create a payout order

Headers

NameTypeDescription

Authorization*

string

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

Request Body

NameTypeDescription

paymentMethod*

OBJECT

Party Object

paymentMethod.type*

string

Value "BankTransfer"

paymentMethod.code*

string

Select among the codes available in each country for a payin BankTransfer payment type. NOTE: payment method code might affect the collection currency in bimonetary countries. For more info, see the side note on currency field.

paymentMethod.flow*

string

The payment method data could be embeded in the API request (DIRECT)or collected via an aditional form or plugin (REDIRECT). Currently, only DIRECT flow is allowed.

externalId*

string

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

country*

string

Your end user's country (i.e. country in which the payment will be processed), in ISO format. Please refer to Country Codes for a full list of supported countries.

amount*

number

The amount of the transaction must be complete with integers and decimals, separated by dot.

currency*

string

The currency in which the amount is expressed. It could be A) the local currency of the selected country or B) the account's currency. If A), the amount will be charged to the customer's cash payment method. If B) and it differs from the local currency, the amount specified will be credited to your account and Localpayment will perform a Foreign Exchange operation to collect the amount expressed in local currency. In bimonetary countries, paymentMethod.code resolves possible ambiguity: the payment will be executed in the currency of that specific payment method network. e.i.: SPID (USD); SPEI (MXN)

accountNumber*

string

Your Localpayment account number in which the amount will be debited.

conceptCode*

string

Choose the suitable concept code from our Concept Code List. Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).

sender

OBJECT

Party Object.

sender.type

string

Possible values: "COMPANY" or "INDIVIDUAL"

sender.name

string

Individual first name / company name

sender.lastName

string

Mandatory for individuals / Ignored for companies.

sender.document

OBJECT

Party Object.

sender.document.type

string

Document types. Can be an international document issued by the the sender's country

sender.document.id

string

Identity document Id. Usually numbers or combination of numbers and letters.

merchant.lastName

string

Mandatory only for INDIVIDUAL type / Ignored for COMPANY.

merchant.name*

string

Individual first name / company name

merchant*

OBJECT

Party Object.

merchant.type*

string

Possible values: "COMPANY" or "INDIVIDUAL"

merchant.document.type

string

Document type (related to the merchant's residence)

beneficiary.phone.countryCode

string

Country code of the beneficiary's telephone number.

beneficiary.phone

OBJECT

Party Object.

merchant.email

string

Merchant's email address

beneficiary.userReference

string

Username or id in your platform.

merchant.document.id

string

Optional. Identity document id. Usually numbers or combination of numbers and letters.

merchant.document

OBJECT

Party Object.

beneficiary.address

OBJECT

Party Object.

beneficiary.nationality

string

Beneficiary's nationality

beneficiary.birthdate

string

Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).

beneficiary.phone.number

string

Beneficiary's phone number

beneficiary.phone.areaCode

string

Area code of the beneficiary's telephone number

beneficiary.address.comment

string

Additional info, such as floor or apartment number.

beneficiary.address.city

string

Beneficiary's city of residence

beneficiary.address.number

string

Beneficiary's number address

beneficiary.address.street

string

Beneficiary's street address

beneficiary.address.zipCode

string

Beneficiary's Zip code / Postal code of residence.

beneficiary.address.country

string

Beneficiary's country of residence

beneficiary.address.state

string

Beneficiary's state of residence

beneficiary.bank*

OBJECT

Party Object

beneficiary.bank.name

string

Account holder full name.

beneficiary.bank.branch.code*

string

Branch code. Only Brazil.

beneficiary.bank.branch*

OBJECT

Only mandatory for Brazilian bank accounts. Branch information. Party Object.

beneficiary.bank.code*

string

Bank code, according to Localpayment bank codes list.

beneficiary.bank.account*

OBJECT

Party Object.

beneficiary.bank.branch.name*

string

Branch name. Only Brazil.

beneficiary.bank.account.type*

string

account type, according to Localpayment typification

beneficiary.bank.account.number*

string

Beneficiary's account number

beneficiary*

OBJECT

Party Object

beneficiary.type*

string

Possible values: "COMPANY" or "INDIVIDUAL"

beneficiary.name*

string

Individual / company name

beneficiary.lastName*

string

Only for INDIVIDUAL type / Ignored for COMPANY.

beneficiary.document *

OBJECT

Party Object.

beneficiary.document.id*

string

Identity document id. Usually numbers or combination of numbers and letters (related to the beneficiary's residence).

beneficiary.document.type*

string

Document type (related to the beneficiary's residence).

**Only optional for Mexico and Bolivia countries

beneficiary.email

string

Beneficiary's email address.

comment

string

Add any relevant informaction

sender.email

string

Sender's email address

sender.phone

OBJECT

Party Object.

sender.phone.country

string

Country code of the sender's telephone number.

sender.phone.area

string

Area code of the sender's telephone number

sender.phone.number

string

Sender's phone number

sender.address.street

string

Sender's street address

merchant.phone.country

string

Country code of the sender's telephone number.

merchant.phone

OBJECT

Party Object.

merchant.phone.area

string

Area code of the merchant's telephone number

merchant.phone.number

string

Merchant's phone number

sender.birthdate

string

Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).

merchant.birthdate

string

Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).

merchant.nationality

string

Merchant's nationality

sender.nationality

string

Sender's nationality

sender.address

OBJECT

Party Object.

merchant.address

OBJECT

Party Object.

merchant.address.street

string

Merchant's street address

merchant.address.number

sring

Merchant's number address

sender.address.number

string

Sender's number address

sender.address.city

string

Sender's city of residence

merchant.address.city

string

Merchant's city of residence

merchant.address.state

string

Merchant's state of residence

merchant.address.country

string

Merchant's country of residence

merchant.address.zipcode

string

Merchant's zip code of residence

sender.userReference

string

Username or id in your platform.

merchant.userReference

string

Username or id in your platform.

sender.address.comment

string

Additional info, such as floor or apartment number.

sender.address.zipcode

string

Sender's zip code of residence

merchant.address.comment

string

Additional info, such as floor or apartment number.

beneficiary.document.type

String

**

requireAuth

Boolean

Value is always false or must not be sent to maintain current functionality.

[
    "transactionType": "PayOut",
    "externalId": "1669662742",
    "internalId": "9e62700a-875d-430e-8239-c9be1ef81e75",
    "loteOut": null,
    "paymentMethod": {
        "code": "0031",
        "name": "PIX",
        "description": "PIX",
        "paymentMethodType": "BankTransfer"
    },
    "country": "BRA",
    "currency": "BRL",
    "amount": 500.0,
    "accountNumber": "076.986.00000039",
    "clientCode": "0001",
    "clientName": "Acme",
    "confirmed": {
        "description": null,
        "currency": "BRL",
        "fxQuote": 1.0,
        "amount": 500.0
    },
    "payment": {
        "description": null,
        "currency": "BRL",
        "fxQuote": 1.0,
        "amount": 500.0
    },
    "fees": {
        "description": "Fee",
        "currency": "BRL",
        "fxQuote": 5.63398605,
        "amount": 14.08
    },
    "localTaxes": [
        {
            "description": "IOF",
            "currency": "BRL",
            "fxQuote": 0.0,
            "amount": 1.9
        }
    ],
    "withHoldings": [],
    "status": {
        "code": "101",
        "description": "Locked",
        "detail": "The payout has been confirmed and passed AML validations"
    },
    "beneficiary": {
        "bank": {
            "name": "Banco do Brasil S.A.",
            "code": "001",
            "branch": {
                "name": "Branch Name",
                "code": "69361"
            },
            "account": {
                "number": "269018",
                "type": "S",
                "alias": null,
                "pixKey": null,
                "phone": null
            }
        },
        "type": "INDIVIDUAL",
        "name": "Beneficiary Name",
        "lastName": "Beneficiary LastName",
        "document": {
            "type": "CPF",
            "id": "46302653843"
        },
        "userReference": "Additional information",
        "email": "beneficiary_email@gmail.com",
        "phone": {
            "countryCode": "55",
            "areaCode": "55",
            "number": "5555555"
        },
        "birthDate": "1990-01-01T00:00:00",
        "nationality": "Beneficiary Nationality",
        "address": {
            "street": "Av Beneficiary Address",
            "number": "1234",
            "city": "City Name",
            "state": "State Name",
            "country": "Country Name",
            "zipCode": "Zip Code",
            "comment": "Additional address information"
        }
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Merchant Name",
        "lastName": "Merchant LastName",
        "document": {
            "type": "CNPJ",
            "id": "34669130330133"
        },
        "userReference": null,
        "email": "Merchant email address",
        "phone": null,
        "birthDate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "sender": {
        "type": "COMPANY",
        "name": "Sender Name",
        "lastName": "Sender LastName",
        "document": {
            "type": "CNPJ",
            "id": "34669130000133"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthDate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "exchangeRateToken": null,
    "date": {
        "creationDate": "2022-11-28T19:12:21.3660748+00:00",
        "processedDate": "2022-11-28T19:12:21.5408595+00:00"
    },
    "errors": null
]
curl --location --request POST {{Api_URL}}
--header 'Authorization: {{Token_Generated}}
--header 'Content-Type: application/json'
--data-raw ' [
{
    "externalId": "{{$timestamp}}",
    "country": "ARG",
    "currency": "ARS",
    "amount": 500.10,
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "0031",
        "flow": "DIRECT"
    },
    "beneficiary": {
        "name": "Beneficiary Name ",
        "lastName": "Beneficiary LastName",
        "type": "INDIVIDUAL",
        "bank": {
            "name": "Banco Name",
            "code": "007",
            "account": {
                "number": "0070145330004020870169",
                "type": "S"
            }
        }
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Sender Name",
        "lastName": "Sender LastName"
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Merchant Name"
    },
    "accountNumber": {{Your Account}},
    "conceptCode": "0001"
}

PreviousSearch available banksNextArgentina

Last updated