Guatemala

Example PayOut Request and Response

Create payout Guatemala

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
externalId*	String	An ID that is meaningful to you and your system. Must be unique.
country*	String	Your end user's country (i.e. country in which the payment will be processed), in ISO format. Please refer to Country Codes for a full list of supported countries.
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)
amount*	Number	The amount of the transaction must be complete with integers and decimals, separated by dot
paymentMethod*	Object	Party Object
paymentMethod.type*	String	Value "BankTransfer"
paymentMethod.code*	String	Select among the codes available in each country for a payout BankTransfer payment type. NOTE: payment method code might affect the collection currency in bimonetary countries. For more info, see the side note on currency field.
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.
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.type*	String	Document type (related to the beneficiary's residence). **Only optional for Mexico and Bolivia countries
beneficiary.document.id*	String	Identity document id. Usually numbers or combination of numbers and letters (related to the beneficiary's residence).
beneficiary.userReference	String	Username or id in your platform.
beneficiary.email	String	Beneficiary's email address.
beneficiary.phone	Object	Party Object
beneficiary.phone.countryCode	String	Country code of the beneficiary's telephone number.
beneficiary.phone.areaCo	String	Area code of the beneficiary's telephone number
beneficiary.phone.number	String	Beneficiary's phone number
beneficiary.birthdate	String	Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
beneficiary.nationality	String	Beneficiary's nationality
beneficiary.address	Object	Party Object
beneficiary.address.street	String	Beneficiary's street address
beneficiary.address.number	String	Beneficiary's number address
beneficiary.address.city	String	Beneficiary's city of residence
beneficiary.address.state	String	Beneficiary's state of residence
beneficiary.address.country	String	Beneficiary's country of residence
beneficiary.address.zipCode	String	Beneficiary's Zip code / Postal code of residence.
beneficiary.address.comment	String	Additional info, such as floor or apartment number.
beneficiary.bank*	Object	Party Object
beneficiary.bank.name*	String	Account holder full name
beneficiary.bank.code*	String	Bank code, according to Localpayment bank codes list.
beneficiary.bank.account*	Object	Party Object
sender.birthdate	String	Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
sender.phone.number	String	Sender's phone number
sender.phone.area	String	Area code of the sender's telephone number
sender.phone.country	String	Country code of the sender's telephone number.
sender.phone	Object	Party Object.
sender.email	String	Sender's email address
sender.userReference	String	Username or id in your platform.
sender.document.id	String	Identity document Id. Usually numbers or combination of numbers and letters.
sender.document.type	String	Document types. Can be an international document issued by the the sender's country.
sender.document	Object	Party Object.
sender.lastName	String	Mandatory for individuals / Ignored for companies.
sender.name	String	Individual first name / company name
sender.type	String	Possible values: "COMPANY" or "INDIVIDUAL"
sender	Object	Party Object
beneficiary.bank.account.type*	String	account type, according to Localpayment typification
beneficiary.bank.account.number*	String	Beneficiary's account number
merchant.phone.area	String	Area code of the merchant's telephone number
merchant.phone.country	String	Country code of the sender's telephone number.
merchant.phone	Object	Party Object.
merchant.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.type	String	Document type (related to the merchant's residence)
merchant.document	Object	Party Object.
merchant.lastName	String	Mandatory only for INDIVIDUAL type / Ignored for COMPANY.
merchant.name*	String	Individual first name / company name
merchant.type*	String	Possible values: "COMPANY" or "INDIVIDUAL"
merchant*	Object	Party Object.
sender.address.comment	String	Additional info, such as floor or apartment number.
sender.address.zipcode	String	Sender's zip code of residence
sender.address.city	String	Sender's city of residence
sender.address.number	String	Sender's number address
sender.address.street	String	Sender's street address
sender.address	Object	Party Object.
sender.nationality	string	Sender's nationality
merchant.email	String	Merchant's email address
merchant.address.comment	String	Additional info, such as floor or apartment number.
merchant.phone.number	String	Merchant's phone number
merchant.address.zipcode	String	Merchant's zip code of residence
merchant.address.street	String	Merchant's street address
merchant.address	Object	Party Object.
merchant.nationality	String	Merchant's nationality
merchant.birthdate	String	Individual birthdate / company incorporation date. ISO 8601 format (YYYY-MM-DD).
beneficiary.document.type	String	Type of beneficiary document
comment	String	Add any relevant informaction
conceptCode*	String	Choose the suitable concept code from our Concept Code List. Based on our experience, the most usual are 0039 (remittances) and 0040 (corporate payments).
accountNumber*	String	Your Localpayment account number in which the amount will be debited.
merchant.address.country	String	Merchant's country of residence
merchant.address.state	String	Merchant's state of residence
merchant.address.city	String	Merchant's city of residence
merchant.address.number	String	Merchant's number address

201: Created A Bank transfer payment order has been successfully created and the payment is pending

{
    "externalId": "111111111",
    "internalId": "1x1x11x1-1xx1-1f11-1c41b-111111a1111c",
    "paymentMethod": {
        "code": "0130",
        "name": "SPEI",
        "description": "SPEI",
        "paymentMethodType": "BankTransfer"
    },
    "country": "MEX",
    "currency": "MXN",
    "amount": 10.3,
    "accountNumber": "{{YourAccount}}",
    "clientCode": "0001",
    "clientName": "ClientName",
    "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": "BeneficiaryName",
        "lastname": "BeneficiaryLastName",
        "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": " SenderLastName",
        "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-06-27T15:25:36.5878589+00:00",
        "processedDate": "2023-06-27T15:25:36.6810076+00:00"
    },
    "errors": null
}

400: Bad Request Wrong parameters (syntactic or semantic errors). The status.code might give more information about the error (see Payin status code table)

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

Request

curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'Content-Type: application/json' \
--data '[
    {
        "externalId": "{{$timestamp}}",
        "country": "GTM",
        "currency": "GTQ",
        "amount": 50.0,
        "paymentMethod": {
            "type": "BankTransfer",
            "code": "0110",
            "flow": "direct"
        },
        "beneficiary": {
            "name": "Beneficiary Name",
            "lastName": "Beneficiary LastName ",
            "type": "INDIVIDUAL",
            "document": {
                "type": "NIT",
                "id": "36029785"
            },
            "bank": {
                "name": "Banco",
                "code": "013",
                "account": {
                    "number": "18012003456",
                    "type": "S"
                }
            }
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "Sender INPAY COL",
            "lastName": "Sender LastName",
            "document": {
                "type": "DNI",
                "id": "40754127"
            }
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name"
        },
        "accountNumber": "320.320.00000002",
        "conceptCode": "0001"

    }
]

Status OK

  [  {
        "externalId": "1690211466",
        "internalId": "771f0287-f3eb-4605-9582-f900f045302d",
        "paymentMethod": {
            "code": "0110",
            "name": "ACH",
            "description": "ACH",
            "paymentMethodType": "BankTransfer"
        },
        "country": "GTM",
        "currency": "GTQ",
        "amount": 50.0,
        "accountNumber": "320.320.00000002",
        "clientCode": "0001",
        "clientName": "Acme",
        "status": {
            "code": "100",
            "description": "Received",
            "detail": "The payout was received"
        },
        "beneficiary": {
            "bank": {
                "name": "Banco",
                "code": "013",
                "branch": null,
                "account": {
                    "number": "18012003456",
                    "type": "S",
                    "alias": null,
                    "pixKey": null,
                    "phone": null
                }
            },
            "type": "INDIVIDUAL",
            "name": "Beneficiary Name",
            "lastname": "Beneficiary LastName ",
            "document": {
                "type": "NIT",
                "id": "36029785"
            },
            "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": "Sender INPAY COL",
            "lastname": "Sender LastName",
            "document": {
                "type": "DNI",
                "id": "40754127"
            },
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "comment": null,
        "exchangeRateToken": null,
        "date": {
            "creationDate": "2023-07-24T15:11:05.3593261+00:00",
            "processedDate": "2023-07-24T15:11:05.4582163+00:00"
        },
        "errors": null
    }
]

Bad Request

[
    {
        "externalId": "1690211886",
        "internalId": "7a5f2a00-fe38-425a-aabe-34833f55f4a0",
        "status": {
            "code": "300",
            "description": "Rejected",
            "detail": "Invalid param + [param name] + [reason]"
        },
        "errors": [
            {
                "code": "300",
                "description": "Invalid param + document.id + verification failed"
            }
        ],
        "comment": null
    }
]