Bolivia

Example PayOut Request and Response

Create payout Bolivia

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.	BOL
currency	String	Required	Payout currency. If account currency differs, FX may apply per account settings.	BOB
amount	Number	Required	Payout amount. For BOB, 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.	0020
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.	CI
beneficiary.document.id	String	Required	ID number (digits or alphanumerics as issued).	7794986
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.	BOL
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.	Bolivia
beneficiary.address.state	String	Optional	Province/State.	Bolivia
beneficiary.address.country	String	Optional	Country name or ISO code.	Bolivia
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.	990 (Yape)
beneficiary.bank.account	Object	Required	Destination account data.	—
beneficiary.bank.account.type	String	Required	Account type, according to Localpayment typification. Do not send for Yape payments (bank.code: 990).	C
beneficiary.bank.account.number	String	Required	Account number. Do not send for Yape payments (bank.code: 990).	—
beneficiary.bank.account.alias	String	Optional	Alias identifier of the beneficiary’s account. Required when bank.code is 990. Must contain the beneficiary’s phone number in the Bolivian format: +591XXXXXXXX.	[phone]
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).	CI
sender.document.id	String	Optional	Sender ID number.	7663435BE
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.	591
sender.phone.area	String	Optional	Area code.	11
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.	La Paz
sender.address.state	String	Optional	Province/State.	Murillo
sender.address.zipCode	String	Optional	Postal code.	0201
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.	NIT
merchant.document.id	String	Optional	Document number.	419326025
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.	591
merchant.phone.area	String	Optional	Area code.	11
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.	La Paz
merchant.address.state	String	Optional	Province/State.	Murillo
merchant.address.country	String	Optional	Country.	BOL
merchant.address.zipCode	String	Optional	Postal code.	0201
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

SCP

{
    "externalId": "bb35c9f3-2685-44af-afe0-5c55f5d4577a",
    "country": "BOL",
    "currency": "BOB",
    "amount": 1000.0,
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "0020",
        "flow": "direct"
    },
    "beneficiary": {
        "name": "John",
        "lastName": "Doe",
        "type": "INDIVIDUAL",
        "document": {
            "type": "CI",
            "id": "7794986"
        },
        "bank": {
            "name": "Banco",
            "code": "025",
            "account": {
                "number": "1234567",
                "type": "S"
            }
        }
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Alicia",
        "lastName": "Doe",
        "document": {
            "type": "CI",
            "id": "4812012-1B"
        }
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Company X"
    },
    "accountNumber": "068.068.00000019",
    "conceptCode": "0001"
}

YAPE

{
    "externalId": "ffe37292-252e-4569-beb6-cbdd39d565fd",
    "country": "BOL",
    "currency": "BOB",
    "amount": 1000.0,
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "0021",
        "flow": "direct"
    },
    "beneficiary": {
        "name": "John",
        "lastName": "Doe",
        "type": "INDIVIDUAL",
        "document": {
            "type": "CI",
            "id": "7794986"
        },
        "bank": {
            "name": "Yape",
            "code": "990",
            "account": {
                "alias": "[phone]"
            }
        }
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Alicia",
        "lastName": "Doe",
        "document": {
            "type": "CI",
            "id": "4812012-1B"
        }
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Company X"
    },
    "accountNumber": "068.068.00000019",
    "conceptCode": "0001"
}

Response example

201: SCP

{
    "externalId": "bb35c9f3-2685-44af-afe0-5c55f5d4577a",
    "internalId": "d19812eb-ed97-4dcf-ace1-468fd271a9a4",
    "paymentMethod": {
        "code": "0020",
        "name": "SCP",
        "description": "SCP",
        "paymentMethodType": "BankTransfer"
    },
    "country": "BOL",
    "currency": "BOB",
    "amount": 1000.0,
    "accountNumber": "068.068.00000019",
    "clientCode": "0001",
    "clientName": "Acme",
    "status": {
        "code": "100",
        "description": "Received",
        "detail": "The payout was received"
    },
    "beneficiary": {
        "bank": {
            "name": "Banco",
            "code": "025",
            "countryISOCode3": null,
            "branch": null,
            "account": {
                "number": "1234567",
                "type": "S",
                "alias": null,
                "pixKey": null,
                "phone": null
            }
        },
        "type": "INDIVIDUAL",
        "name": "John",
        "lastname": "Doe",
        "document": {
            "type": "CI",
            "id": "7794986"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Company X",
        "lastname": null,
        "document": null,
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Alicia",
        "lastname": "Doe",
        "document": {
            "type": "CI",
            "id": "4812012-1B"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "comment": null,
    "exchangeRateToken": null,
    "date": {
        "creationDate": "2025-09-04T18:24:24.0719749+00:00",
        "processedDate": "2025-09-04T18:24:24.0721494+00:00"
    },
    "errors": null,
    "internalLoteID": "136624"
}

201: YAPE

{
    "externalId": "ffe37292-252e-4569-beb6-cbdd39d565fd",
    "internalId": "7c01c17f-5c8b-ce0c-a4ae-84c63f6d9624",
    "paymentMethod": {
        "code": "0021",
        "name": "BCP",
        "description": "Yape",
        "paymentMethodType": "BankTransfer"
    },
    "country": "BOL",
    "currency": "BOB",
    "amount": 1000.0,
    "accountNumber": "068.068.00000019",
    "clientCode": "0001",
    "clientName": "Acme",
    "status": {
        "code": "100",
        "description": "Received",
        "detail": "The payout was received"
    },
    "beneficiary": {
        "bank": {
            "name": "Yape",
            "code": "990",
            "countryISOCode3": null,
            "branch": null,
            "account": {
                "number": null,
                "type": null,
                "alias": "[phone]",
                "pixKey": null,
                "phone": null
            }
        },
        "type": "INDIVIDUAL",
        "name": "John",
        "lastname": "Doe",
        "document": {
            "type": "CI",
            "id": "7794986"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Company X",
        "lastname": null,
        "document": null,
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Alicia",
        "lastname": "Doe",
        "document": {
            "type": "CI",
            "id": "4812012-1B"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "comment": null,
    "exchangeRateToken": null,
    "date": {
        "creationDate": "2025-09-04T18:34:16.1455114+00:00",
        "processedDate": "2025-09-04T18:34:16.1457128+00:00"
    },
    "errors": null,
    "internalLoteID": "136654"
}

400: Bad Request

{
    "externalId": "ffe37292-252e-4569-beb6-cbdd39d565fd",
    "internalId": "7c01c17f-5c8b-ce0c-a4ae-84c63f6d9624",
    "status": null,
    "errors": [
        {
            "code": "719",
            "description": "Amount must not be empty and more tan 0"
        }
    ]
}