Chile

Localpayment's API works 24/7/365, the payments are processed during business hours from 9am to 15pm GMT -3 when we have our cut-off. Requests done after the cut-off will be executed next business day

Create Payout Chile

POST https://sandbox.localpayment.com/api/v2/payouts/payout

Array () [

*Key required

Headers

Name	Type	Description
Content-Type*	String	Content-Type
Authorization*	String	Authorization
customer_id*	String	string <= 12 customer_id
countryCode*	String	Value: "CHL"
	String

Request Body

Name	Type	Description
submerchant_code*	String	[ 3 .. 60 ] characters ^[a-zA-Z0-9\s\- _]{3,60}$ The name of the merchant sending the payment
sender_taxid	String	^[a-zA-Z0-9\\s]{1,50}$ This field is required when the sender is a customer (C2C or C2B)
sender_name	String	^[a-zA-ZáéíóúÁÉÍÓÚ\\s]{1,60}$ This field is required when the sender is a customer (C2C or C2B)
sender_address	String	"^[a-zA-ZáéíóúÁÉÍÓÚ0-9\s]{1,300}$" accepts numbers, letters, and spaces, and the length is between 1 and 300 characters This field is required when the sender is a customer (C2C or C2B)
sender_state	String	^[a-zA-ZáéíóúÁÉÍÓÚ\\s]{1,20}$ This field is required when the sender is a customer (C2C or C2B)
sender_country	String	^[a-zA-ZáéíóúÁÉÍÓÚ\\s]{1,20}$ This field is required when the sender is a customer (C2C or C2B)
sender_birthdate	String	([12]\\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01])) format - yyyymmdd
sender_email	String
beneficiary_name*	String	[ 1 .. 60 ] characters ^[a-zA-Z0-9\s]{1,60}$
bank_account_type*	String	1 characters Enum: "C" "A" "V" "R" Available: 'C' – checking account / 'A' – savings account / 'R' – RUT account / 'V' – Vista account
bank_code*	String	Check the Bank Codes
beneficiary_account_number*	String	Check account number validation Chile
beneficiary_address	String	^[a-zA-ZáéíóúÁÉÍÓÚ0-9\s]{1,150}$
beneficiary_state	String	^[a-zA-ZáéíóúÁÉÍÓÚ\s]{1,60}$
beneficiary_country	String	^[a-zA-ZáéíóúÁÉÍÓÚ\s]{1,60}$
beneficiary_birth_date	String	([12]\\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01])) format - yyyymmdd
beneficiary_email	String
beneficiary_phone_number	String
sender_phone_number	String
beneficiary_document_id*	String	Show pattern Check document_id validation Chile
merchant_id*	String	[ 0 .. 60 ] characters Your internal transaction/tracking ID
concept_code*	String	You can see the concept code Concept Codes
currency*	String	Value: "CLP"
payout_date	String	format - yyyymmdd - UTC Timezone
amount*	integer <int64>	This is the amount to be received by the beneficiary in the local currency. The amount is a whole number with no decimal places. CLP currency does NOT ALLOW DECIMALS
authenticate	boolean	If set as true, the transaction will be created in status OnHold and will expire after a week unless is aproved using the endpoint payouts/authenticate. As default this parameter is false and will be created with the status Received
beneficiary_document_type*	String	Value: "RUT"

200: OK

[
    {
        "beneficiary_document_type": "RUT",
        "beneficiary_document_id": "0-32852742",
        "bank_code": "009",
        "authenticate": false,
        "transaction_id": 318608,
        "payout_id": 61990,
        "status": "Received",
        "Ticket": "16680015870371",
        "submerchant_code": "Submerchant Code",
        "sender_taxid": null,
        "sender_name": null,
        "sender_address": "",
        "sender_state": null,
        "sender_country": null,
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "testbene",
        "bank_account_type": "C",
        "beneficiary_account_number": "123456789012345",
        "beneficiary_address": "",
        "beneficiary_state": null,
        "beneficiary_country": null,
        "beneficiary_birth_date": null,
        "beneficiary_email": null,
        "beneficiary_phone_number": "0",
        "beneficiary_zip_code": null,
        "merchant_id": "1669677728",
        "concept_code": "0001",
        "currency": "CLP",
        "payout_date": "20221128",
        "amount": 1000,
        "exchange_rate": 924570763,
        "ErrorRow": {
            "Errors": [],
            "HasError": false
        }
    }
]

Example: PayOut request

Request

curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'customer_id: {{Your_CustomerID}}' \
--header 'countryCode: CHL' \
--header 'Content-Type: application/json' \
--data-raw '[

    {
        "amount": 1010,
        "bank_account_type": "C",
        "bank_code": "009",
        "beneficiary_account_number": "123456789012345",
        "beneficiary_document_id": "8900960-k",
        "beneficiary_document_type": "RUT",
        "beneficiary_name": "testbene",
        "concept_code": "0001",
        "currency": "CLP",
        "merchant_id": {{$timestamp}},
        "submerchant_code": "Submerchant Code"
    }
]

Request (complete)

curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'customer_id: {{Your_CustomerID}}' \
--header 'countryCode: CHL' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "amount": 1010,
        "bank_account_type": "C",
        "bank_code": "009",
        "beneficiary_account_number": "123456789012345",
        "beneficiary_address": "Beneficiary Address",
        "beneficiary_birth_date": "19800101",
        "beneficiary_country": "Beneficiary Country",
        "beneficiary_document_id": "8900960-k",
        "beneficiary_document_type": "RUT",
        "beneficiary_email": "[e-mail]",
        "beneficiary_name": "Beneficiary Name",
        "beneficiary_phone_number": "123456789",
        "beneficiary_state": "Beneficiary State",
        "concept_code": "0001",
        "currency": "CLP",
        "merchant_id": {{$timestamp}},
        "sender_address": "Sender Address",
        "sender_birthdate": "19800101",
        "sender_country": "Sender Country",
        "sender_email": "[e-mail]",
        "sender_name": "Sender Name",
        "sender_phone_number": "987654321",
        "sender_state": "Sender State",
        "sender_taxid": "Sender Tax",
        "submerchant_code": "Submerchant Code"
    }
]

Status OK

[
    {
        "beneficiary_document_type": "RUT",
        "beneficiary_document_id": "8900960-k",
        "bank_code": "009",
        "authenticate": false,
        "transaction_id": 318608,
        "payout_id": 61990,
        "status": "Received",
        "Ticket": "16680015870371",
        "submerchant_code": "Submerchant Code",
        "sender_taxid": null,
        "sender_name": null,
        "sender_address": "",
        "sender_state": null,
        "sender_country": null,
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "testbene",
        "bank_account_type": "C",
        "beneficiary_account_number": "123456789012345",
        "beneficiary_address": "",
        "beneficiary_state": null,
        "beneficiary_country": null,
        "beneficiary_birth_date": null,
        "beneficiary_email": null,
        "beneficiary_phone_number": "0",
        "beneficiary_zip_code": null,
        "merchant_id": "1669677728",
        "concept_code": "0001",
        "currency": "CLP",
        "payout_date": "20221128",
        "amount": 1000,
        "exchange_rate": 924570763,
        "ErrorRow": {
            "Errors": [],
            "HasError": false
        }
    }
]

Bad Request

[
    {
        "beneficiary_document_type": "RUP",
        "beneficiary_document_id": "8900960-k",
        "bank_code": "009",
        "authenticate": false,
        "transaction_id": 0,
        "payout_id": 0,
        "status": null,
        "Ticket": null,
        "submerchant_code": "Submerchant Code",
        "sender_taxid": null,
        "sender_name": null,
        "sender_address": null,
        "sender_state": null,
        "sender_country": null,
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "testbene",
        "bank_account_type": "C",
        "beneficiary_account_number": "123456789012345",
        "beneficiary_address": null,
        "beneficiary_state": null,
        "beneficiary_country": null,
        "beneficiary_birth_date": null,
        "beneficiary_email": null,
        "beneficiary_phone_number": null,
        "beneficiary_zip_code": null,
        "merchant_id": "1669681205",
        "concept_code": "0001",
        "currency": "CLP",
        "payout_date": "20221129",
        "amount": 1000,
        "exchange_rate": 0,
        "ErrorRow": {
            "Errors": [
                {
                    "Key": "beneficiary_document_type",
                    "Messages": [
                        "Parameter :: beneficiary_document_type :: invalid format, only allow codes: 'RUT' ."
                    ],
                    "CodeTypeError": [
                        "INVALID"
                    ]
                }
            ],
            "HasError": true
        }
    }
]