Mexico

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 Mexico

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

Array () [

*Key required

Headers

NameTypeDescription

Content-Type*

String

Default: application/json Content Type

Authorization*

String

Authorization

customer_id*

String

string <= 12 Customer id

countryCode*

String

Request Body

NameTypeDescription

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 character

Check the Mexico

bank_code

String

3 characters

Check the Mexico

IF bank_account_type = "A/C" is Optional.

IF bank_account_type = "D/P" is Mandatory

beneficiary_account_number*

String

Check in Mexico

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

Check document_id validation Mexico

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: "MXN"

payout_date

String

format - yyyymmdd - UTC Timezone

amount*

integer <int64>

The last 2 digits represent the decimals (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 is aproved using the endpoint payouts/authenticate. As default this parameter is false and will be created with the status Received

[
    {
        "beneficiary_document_id": "",
        "bank_code": "156",
        "authenticate": false,
        "transaction_id": 308058,
        "payout_id": 51633,
        "status": "Received",
        "Ticket": "16401883590000",
        "submerchant_code": "PRUEBA BBVA",
        "sender_taxid": null,
        "sender_name": "SENDER",
        "sender_address": "ADDRESS",
        "sender_state": "STATE",
        "sender_country": "ARGENTINA",
        "sender_birthdate": null,
        "sender_email": null,
        "sender_phone_number": null,
        "sender_zip_code": null,
        "beneficiary_name": "BENEFICIARY",
        "bank_account_type": "C",
        "beneficiary_account_number": "XXXXXXXXXXXXXXXXXX",
        "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": "1a231",
        "concept_code": "0001",
        "currency": "MXN",
        "payout_date": "20211222",
        "amount": 1000,
        "exchange_rate": 20568557,
        "ErrorRow": {
            "Errors": [],
            "HasError": false
        }
    }
]

Example: PayOut request

curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'customer_id: {{Your_CustomerID}}' \
--header 'countryCode: MEX' \
--header 'Content-Type: application/json' \
--data-raw '[
     {
        "amount": 5000,
        "bank_account_type": "A",
        "beneficiary_account_number": "002180700070799802",
        "beneficiary_document_id": "MAMA831224NA1",
        "beneficiary_name": "Beneficiary Name",
        "concept_code": "0001",
        "currency": "MXN",
        "merchant_id": {{$timestamp}},
        "submerchant_code": "Submerchant code"
    }   
]
PreviousEcuadorNextParaguay

Last updated