Guatemala

Example PayOut Request and Response

Create payout Guatemala

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

Create a payout order

Headers

Parameter

Type

Required

Description

Authorization

String

Required

Bearer token for authentication.

Request Body

Parameter

Type

Required

Description

Example

externalId

String

Required

A unique reference for this payout. Must be unique in your system. We recommend using UUID4 to ensure uniqueness.

bc38457c-b711-48e3-9bf2-05e07967f9b1

country

String

Required

Processing country. Use ISO 3166-1 alpha-3. Please refer to Country Codes for a full list of supported countries.

GTM

currency

String

Required

Payout currency. If account currency differs, FX may apply per account settings.

GTQ

amount

Number

Required

Payout amount. For GTQ, specify 2 decimals using a dot.

17156.00

conceptCode

String

Required

Business purpose of the payout. Choose a valid concept from the Concept Code List (e.g., 0039 Remittances, 0040 Freelancer payment).

0039

accountNumber

String

Required

Your Localpayment account number to be debited for the payout.

152.152.00000150

paymentMethod

Object

Required

Payment method object.

—

paymentMethod.type

String

Required

Must be BankTransfer.

BankTransfer

paymentMethod.code

String

Required

Bank transfer method code (per country list). Code selection can affect currency behavior in bi-monetary markets.

0110

paymentMethod.flow

String

Required

Flow type. DIRECTor REDIRECT.

DIRECT

beneficiary

Object

Required

Final recipient of funds.

—

beneficiary.type

String

Required

INDIVIDUAL or COMPANY.

INDIVIDUAL

beneficiary.name

String

Required

First name (individual) or legal name (company).

Beneficiary Name

beneficiary.lastName

String

Conditional

Required for INDIVIDUAL. Ignored for COMPANY.

Beneficiary LastName

beneficiary.document

Object

Required

Beneficiary identification.

—

beneficiary.document.type

String

Required

ID type.

CUI

beneficiary.document.id

String

Required

ID number (digits or alphanumerics as issued).

3463426000101

beneficiary.userReference

String

Optional

Optional reference/username in your platform.

additional information

beneficiary.email

String

Optional

Beneficiary email for notifications/records.

[email protected]

beneficiary.phone

Object

Optional

Beneficiary phone.

—

beneficiary.phone.countryCode

String

Optional

Country calling code.

—

beneficiary.phone.areaCode

String

Optional

Area code (sin leading 0).

—

beneficiary.phone.number

String

Optional

Local phone number.

—

beneficiary.birthdate

String

Optional

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

1980-01-01

beneficiary.nationality

String

Optional

Beneficiary nationality.

GTM

beneficiary.address

Object

Optional

Beneficiary address.

—

beneficiary.address.street

String

Optional

Street name.

Av. Centro

beneficiary.address.number

String

Optional

Street/building number.

1234

beneficiary.address.city

String

Optional

City.

Guatemala

beneficiary.address.state

String

Optional

Province/State.

Guatemala

beneficiary.address.country

String

Optional

Country name or ISO code.

Guatemala

beneficiary.address.zipCode

String

Optional

Postal code.

01010

beneficiary.address.comment

String

Optional

Additional address info (floor, apt., etc.).

Piso 5, Depto B

beneficiary.bank

Object

Required

Destination bank details.

—

beneficiary.bank.name

String

Required

Account holder full name (as registered at bank).

Beneficiary Name

beneficiary.bank.code

String

Required

Bank code, according to Localpayment bank codes list.

040

beneficiary.bank.account

Object

Required

Destination account data.

—

beneficiary.bank.account.type

String

Required

Account type, according to Localpayment typification

C

beneficiary.bank.account.number

String

Required

Account number.

—

sender

Object

Required

Payer entity.

—

sender.type

String

Required

INDIVIDUAL or COMPANY.

INDIVIDUAL

sender.name

String

Required

First name (individual) or legal name (company).

Sender Name

sender.lastName

String

Conditional

Required for INDIVIDUAL. Ignored for COMPANY.

Sender LastName

sender.document

Object

Optional

Sender identification (type & id).

—

sender.document.type

String

Optional

Sender document type (can be international document issued by sender’s country).

DNI

sender.document.id

String

Optional

Sender ID number.

12345678

sender.userReference

String

Optional

Optional reference/username in your platform.

additional information

sender.email

String

Optional

Sender email.

[email protected]

sender.phone

Object

Optional

Sender phone.

—

sender.phone.country

String

Optional

Country calling code.

sender.phone.area

String

Optional

Area code.

sender.phone.number

String

Optional

Phone number.

55559876

sender.birthdate

String

Optional

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

1990-05-20

sender.nationality

String

Optional

Sender nationality.

—

sender.address

Object

Optional

Sender address.

—

sender.address.street

String

Optional

Street name.

Av Sender Address

sender.address.number

String

Optional

Street/building number.

1234

sender.address.city

String

Optional

City.

Buenos Aires

sender.address.state

String

Optional

Province/State.

CABA

sender.address.zipCode

String

Optional

Postal code.

C1001

sender.address.comment

String

Optional

Additional address info.

Piso 3

merchant

Object

Required

Your merchant (corporate) profile as registered with Localpayment.

—

merchant.type

String

Required

INDIVIDUAL or COMPANY.

COMPANY

merchant.name

String

Required

Legal/registered name.

Merchant Name

merchant.lastName

String

Conditional

Required only if INDIVIDUAL. Ignored for COMPANY.

Merchant LastName

merchant.document

Object

Optional

Merchant identification (type & id).

—

merchant.document.type

String

Optional

Document type.

CUIT

merchant.document.id

String

Optional

Document number.

23456789123

merchant.userReference

String

Optional

Optional internal reference/ID.

additional information

merchant.email

String

Optional

Merchant email.

[email protected]

merchant.phone

Object

Optional

Merchant phone.

—

merchant.phone.country

String

Optional

Country calling code.

merchant.phone.area

String

Optional

Area code.

merchant.phone.number

String

Optional

Phone number.

55550123

merchant.birthdate

String

Optional

Incorporation date (company) or birthdate (individual), ISO-8601 YYYY-MM-DD.

2001-01-01

merchant.nationality

String

Optional

Merchant nationality.

—

merchant.address

Object

Optional

Merchant address.

—

merchant.address.street

String

Optional

Street name.

Av Merchant Address

merchant.address.number

String

Optional

Street/building number.

1234

merchant.address.city

String

Optional

City.

Buenos Aires

merchant.address.state

String

Optional

Province/State.

CABA

merchant.address.country

String

Optional

Country.

Argentina

merchant.address.zipCode

String

Optional

Postal code.

C1002

merchant.address.comment

String

Optional

Additional address info.

Oficina 12

comment

String

Optional

Free-text note for your internal tracking or reconciliation.

Payroll batch 08/15

Request example

{
    "externalId": "a46c98a0-dbee-41c2-b568-490f9dc0f52f",
    "country": "GTM",
    "currency": "GTQ",
    "amount": 500.0,
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "0110",
        "flow": "direct"
    },
    "beneficiary": {
        "name": "John",
        "lastName": "Doe",
        "type": "INDIVIDUAL",
        "document": {
            "type": "NIT",
            "id": "36029785"
        },
        "bank": {
            "name": "John Doe",
            "code": "040",
            "account": {
                "number": "12695000000062",
                "type": "C"
            }
        }
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Alicia",
        "lastName": "Doe",
        "document": {
            "type": "DNI",
            "id": "40754127"
        }
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Company X"
    },
    "accountNumber": "320.320.00000002",
    "conceptCode": "0001"
}

Response example

{
    "externalId": "a46c98a0-dbee-41c2-b568-490f9dc0f52f",
    "internalId": "57525dd6-644e-4edf-b811-97974fd22c22",
    "paymentMethod": {
        "code": "0110",
        "name": "ACH",
        "description": "ACH",
        "paymentMethodType": "BankTransfer"
    },
    "country": "GTM",
    "currency": "GTQ",
    "amount": 500.0,
    "accountNumber": "320.320.00000002",
    "clientCode": "0001",
    "clientName": "Acme",
    "status": {
        "code": "100",
        "description": "Received",
        "detail": "The payout was received"
    },
    "beneficiary": {
        "bank": {
            "name": "John Doe",
            "code": "040",
            "branch": null,
            "account": {
                "number": "12695000000062",
                "type": "C",
                "alias": null,
                "pixKey": null,
                "phone": null
            }
        },
        "type": "INDIVIDUAL",
        "name": "John",
        "lastname": "Doe",
        "document": {
            "type": "NIT",
            "id": "36029785"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": null,
        "nationality": null,
        "address": null
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Company X",
        "lastname": null,
        "document": null,
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": null,
        "nationality": null,
        "address": null
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Alicia",
        "lastname": "DOE",
        "document": {
            "type": "DNI",
            "id": "40754127"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": null,
        "nationality": null,
        "address": null
    },
    "comment": null,
    "exchangeRateToken": null,
    "date": {
        "creationDate": "2025-07-24T15:11:05.3593261+00:00",
        "processedDate": "2025-07-24T15:11:05.4582163+00:00"
    },
    "errors": null
}

{
    "externalId": "02bcf467-7da5-4733-ad70-8f48d8fc98ba",
    "internalId": "269743a5-f58e-49bd-b70d-8f58d422593f",
    "status": null,
    "errors": [
        {
            "code": "719",
            "description": "Amount must not be empty and more tan 0"
        }
    ]
}

PreviousDominic Republic NextHonduras

Last updated 8 days ago

Was this helpful?