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. REQUEST A PAYMENT
  2. Payouts

Create

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

PreviousSearch available banksNextArgentina

Last updated 8 months ago

Was this helpful?

Create Payout

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

Create a payout order

Headers

Name
Type
Description

Authorization*

string

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

Request Body

Name
Type
Description

paymentMethod*

OBJECT

Party Object

paymentMethod.type*

string

Value "BankTransfer"

paymentMethod.code*

string

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

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

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

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

beneficiary.bank.code*

string

beneficiary.bank.account*

OBJECT

Party Object.

beneficiary.bank.branch.name*

string

Branch name. Only Brazil.

beneficiary.bank.account.type*

string

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
]
{
    "externalId": "1669663393",
    "internalId": "00000000-0000-0000-0000-000000000000",
    "status": null,
    "errors": [
        {
            "code": "719",
            "description": "Amount must not be empty and more tan 0"
        }
    ]
}
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"
}

  {
  "externalId": "{{$timestamp}}",
  "country": "ARG",
  "currency": "USD",
  "amount": 10,
  "exchangeRateToken": "76b54005-01a4-4b0c-8cd8-c51d31828b43"
   "paymentMethod": {
    "type": "BankTransfer",
    "code": "0010",
    "flow": "direct"
  },
  "beneficiary": {
    "type": "INDIVIDUAL",
    "name": "BACEN",
    "lastName": "Villanueva",
    "document": {
      "type": "dni",
      "id": "11111111"
    },
    "userReference": "Lorem",
    "email": "aldana@mail.com",
    "phone": {
      "countryCode": "54",
      "areaCode": "11",
      "number": "33871784"
    },
    "birthDate": "2021-11-08T17:50:01.196Z",
    "nationality": "beneficiary nationality",
    "address": {
      "street": "Beneficiary adress",
      "number": "234",
      "city": "City",
      "state":"Villa Rosa",
      "country": "Country",
      "zipCode": "1411",
      "comment": "Add any relevant information"
    },
    "bank": {
    "name": "Account holder full name",
    "code": "007",
    "account": {
      "number": "0070175030004038500000",
      "type": "C"
    }
  }
  },
  "sender": {
    "type": "COMPANY",
    "name": "BACEN",
    "lastName": "A",
    "document": {
      "type": "CPF",
      "id": "11111111111"
    }
  },
  "merchant": {
    "type": "INDIVIDUAL",
    "name": "Brenda Aldana",
    "lastName": "Villanueva",
    "document": {
      "type": "DNI",
      "id": "38111222"
    },
    "email": "string"
  },
  "accountNumber": "032.840.00000005",
  "conceptCode": "0003",
  "comment": "Add any relevant informaction",
 }
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,
"paymentMethod": {
    "type": "BankTransfer",
    "code": "0010",
    "flow": "direct"
},
"beneficiary": {
    "type": "INDIVIDUAL",
    "name": "Beneficiary Name",
    "lastName": "Beneficiary LastName",
    "document": {
        "type": "CUIL",
        "id": "20045893651"
    },
    "userReference": "Additional information",
    "email": "beneficiary_email@gmail.com",
    "phone": {
        "countryCode": "55",
        "areaCode": "55",
        "number": "5555555"
    },
    "birthDate": "1990-01-01",
    "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"
    },
    "bank": {
        "name": "Banco Galicia",
        "code": "007",
        "branch": {
            "name": "Branch Name",
            "code": "69361"
        },
        "account": {
            "number": "0070145330004020870169",
            "type": "S"
        }
    }
},
"sender": {
    "type": "INDIVIDUAL",
    "name": "Sender Name",
    "lastName": "Sender LastName",
    "document": {
        "type": "CUIL",
        "id": "23045893669"
    },
    "userReference": "additional information",
    "email": "email@Sender.address",
    "phone": {
        "countryCode": "55",
        "areaCode": "57",
        "number": "7777777"
    },
    "birthDate": "2001-01-01",
    "nationality": "Sender Nacionality",
    "address": {
        "street": "Av Sender 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": "CUIT",
        "id": "30500056734"
    },
    "userReference": "additional information",
    "email": "email@Merchant.address",
    "phone": {
        "countryCode": "55",
        "areaCode": "55",
        "number": "66666666"
    },
    "birthDate": "2001-01-01",
    "nationality": "Merchant Nacionality",
    "address": {
        "street": "Av Merchant Address",
        "number": "1234",
        "city": "City Name",
        "state": "State Name",
        "country": "Country Name",
        "zipCode": "Zip Code",
        "comment": "Additional address information"
    }
},
"accountNumber": {{Your Account}},,
"conceptCode": "0001",
"comment": "Addicional informetion"
}

{
    "externalId": "1690384130",
    "internalId": "a437f20c-f88a-41bd-8a0a-e9f086c66afd",
    "paymentMethod": {
        "code": "0130",
        "name": "SPEI",
        "description": "SPEI",
        "paymentMethodType": "BankTransfer"
    },
    "country": "MEX",
    "currency": "MXN",
    "amount": 10.3,
    "accountNumber": "484.484.00000011",
    "clientCode": "0001",
    "clientName": "Acme",
    "status": {
        "code": "100",
        "description": "Received",
        "detail": "The payout was received"
    },
    "beneficiary": {
        "bank": {
            "name": "BankName",
            "code": "646",
            "branch": null,
            "account": {
                "number": "1234567890",
                "type": "P",
                "alias": null,
                "pixKey": null,
                "phone": null
            }
        },
        "type": "INDIVIDUAL",
        "name": "Name Test",
        "lastname": "LastName Test",
        "document": {
            "type": "RFC",
            "id": "MAL180222MS6"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Merchant Name",
        "lastname": null,
        "document": null,
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "SenderName",
        "lastname": " LastName",
        "document": {
            "type": "RFC",
            "id": "MAMA831224NA1"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "comment": null,
    "exchangeRateToken": null,
    "date": {
        "creationDate": "2023-07-26T15:08:50.499478+00:00",
        "processedDate": "2023-07-26T15:08:50.5975421+00:00"
    },
    "errors": null
}
  {
    "externalId": "1669696323",
    "internalId": "00000000-0000-0000-0000-000000000000",
    "status": {
        "code": "300",
        "description": "Rejected",
        "detail": "Invalid param + [param name] + [reason]"
    },
    "errors": [
        {
            "code": "300",
            "description": "Invalid param + Beneficiary.Bank.branch.[code] + must not be null"
        },
        {
            "code": "300",
            "description": "Invalid param + Beneficiary.Bank.branch.code + must not be null"
        }
    ]
}js

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

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

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

Party Object.

Branch information. Party Object.

Country Codes
Concept Code List
Only mandatory for Brazilian bank accounts.
Bank code, according to Localpayment bank codes list.
account type, according to Localpayment typification
payin BankTransfer payment type
Payout Methods + SLA
Document ValidationsDocumentation V3
Logo