Uruguay

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 Uruguay

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

Array () [

*Key required

Headers

Name	Type	Description
Content-Type*	String	Default: application/json Content Type
Authorization*	String	Authorization
customer_id*	String	string <= 12 Customer id
countryCode*	String	Value: "URY"

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_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}$
beneficiary_document_type*	String	[ 2 .. 3 ] charactersEnum: "RUT" "CI" You can see the type of document
beneficiary_document_id*	String	[ 8 .. 12 ] characters
bank_account_type*	String	1 charactersEnum: "C" "A" Only mandatory if Uruguay bank_code is BROU C: for Checking accounts S: for Savings accounts
bank_code*	String	Check the Bank Codes
beneficiary_account_number*	String	[ 4 .. 20 ] characters
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
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: "UYU"
payout_date	String	format - yyyymmdd - UTC Timezone
amount*	integer <int64> >= 100	The last 2 digits represent the decimals (cents) (cents). This is the amount to be received by the beneficiary in the local currency
authenticate	boolean	If set as true, the transaction will be created in status OnHold and will expire after a week unless 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 Receivedd
sender_name	String	[a-zA-ZáéíóúÁÉÍÓÚ\s]{1,60}$ This field is required when the sender is a customer (C2C or C2B)

200: OK

[
    {
        "beneficiary_document_type": "RUT",
        "beneficiary_document_id": "xxxxxxxx",
        "bank_code": "1001",
        "authenticate": false,
        "transaction_id": 308059,
        "payout_id": 51634,
        "status": "Received",
        "Ticket": "16401887120000",
        "submerchant_code": "a31321",
        "sender_taxid": null,
        "sender_name": "testsender",
        "sender_address": "Mumbai",
        "sender_state": "Maharashtra",
        "sender_country": "India",
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "testbene",
        "bank_account_type": "C",
        "beneficiary_account_number": "xxxxxxxxxxxxxx",
        "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": "1a2311111",
        "concept_code": "0001",
        "currency": "UYU",
        "payout_date": "20211222",
        "amount": 1000,
        "exchange_rate": 43911523,
        "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: URY' \
--header 'Content-Type: application/json' \
--data-raw '[ 

       {
        "amount": 5000,
        "bank_account_type": "A",
        "bank_code": "1137",
        "beneficiary_account_number": "000001156543",
        "beneficiary_document_id": "6.075.936-0",
        "beneficiary_document_type": "RUT",
        "beneficiary_name": "Beneficiary Name",
        "concept_code": "0001",
        "currency": "UYU",
        "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: URY' \
--header 'Content-Type: application/json' \
--data-raw '[ 
    {
        "amount": 5000,
        "bank_account_type": "A",
        "bank_code": "1137",
        "beneficiary_account_number": "000001156543",
        "beneficiary_address": "Beneficiary Address",
        "beneficiary_birth_date": "19800101",
        "beneficiary_country": "Beneficiary Country",
        "beneficiary_document_id": "6.075.936-0",
        "beneficiary_document_type": "RUT",
        "beneficiary_email": "[e-mail]",
        "beneficiary_name": "Beneficiary Name",
        "beneficiary_phone_number": "123456789",
        "beneficiary_state": "Beneficiary State",
        "concept_code": "0001",
        "currency": "UYU",
        "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": "6.075.936-0",
        "bank_code": "1137",
        "authenticate": false,
        "transaction_id": 318622,
        "payout_id": 62004,
        "status": "Received",
        "Ticket": "16680015870385",
        "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": "Beneficiary Name",
        "bank_account_type": "A",
        "beneficiary_account_number": "000001156543",
        "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": "1669689164",
        "concept_code": "0001",
        "currency": "UYU",
        "payout_date": "20221129",
        "amount": 5000,
        "exchange_rate": 39632172,
        "ErrorRow": {
            "Errors": [],
            "HasError": false
        }
    }
]

Bad Request

[
    {
        "beneficiary_document_type": "RUT",
        "beneficiary_document_id": "6.075.936-0",
        "bank_code": "010",
        "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": "Beneficiary Name",
        "bank_account_type": "A",
        "beneficiary_account_number": "14567890123456",
        "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": "1669688983",
        "concept_code": "0001",
        "currency": "UYU",
        "payout_date": "20221129",
        "amount": 5000,
        "exchange_rate": 0,
        "ErrorRow": {
            "Errors": [
                {
                    "Key": "bank_code",
                    "Messages": [
                        "Parameter :: bank_code :: not valid, visit https://docs.v2.localpayment.com/api-reference-guide/bank-codes/uruguay  ."
                    ],
                    "CodeTypeError": [
                        "INVALID"
                    ]
                },
                {
                    "Key": "beneficiary_account_number",
                    "Messages": [
                        "Parameter :: beneficiary_account_number :: invalid bank account length."
                    ],
                    "CodeTypeError": [
                        "INVALID"
                    ]
                }
            ],
            "HasError": true
        }
    }
]