HomeGuidesRecipesAPI Reference
Guides
Sign in
Start typing to search…

Bank transfer

Localpayment allows you to set the bank transfer payment method for payouts, which send money from the merchant's account to the beneficiaries' bank accounts.

Bank transfer Flow

The following are the steps that a bank transfer takes:


  1. The Merchant creates a payout by API or by LP Dashboard.
  2. If an authorization is required, the payout changes to Pending Authorization status.
  3. Once it's authorized, the payout changes toReceived status.
  4. The funds in the account are validated and compliance determines if it needs extra information. In case extra information is needed, the payout changes toOn Hold status. If no extra information is needed or it's completed, the payout changes toLocked status.
  5. The money transfer starts as soon as everything is in order, and the payout changes toIn progress status.
  6. If all goes well, the beneficiary receives the funds and the payout changes toCompleted status.

Create a Bank Transfer Payout

Learn how to generate payouts in each of the available countries for bank transfers with Localpyamnet.

⚠️

Important

We recommend that you read the Overview article to have a complete understanding of the payout flow, prerequisites, availability, and other relevant information.


Argentina

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "ARG" as the value for country .
  • Enter "ARS" as the value for currency .

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "01183e79-1fc8-4357-385a-7898ab1fefbe",
  "country": "ARG",
  "currency": "ARS",
  "amount": 157156,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0010",
    "flow": "direct"
  },
  "beneficiary": {
    "type": "COMPANY",
    "name": "ITAU ARG",
    "document": {
      "type": "CUIT",
      "id": "20907920276"
    },
    "userReference": "Reference",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "phoneNumber"
    },
    "birthDate": "1995-02-24",
    "nationality": "beneficiary nationality",
    "address": {
      "street": "Beneficiary adress",
      "number": "234",
      "city": "City",
      "state": "Villa Rosa",
      "country": "Country",
      "zipCode": "1411",
      "comment": "TEST"
    },
    "bank": {
      "name": "ARG TEST",
      "code": "007",
      "account": {
        "type": "C",
        "number": "1234567891234567891234"
      }
    }
  },
  "sender": {
    "type": "COMPANY",
    "name": "BACEN",
    "lastName": "ABCDIN",
    "document": {
      "type": "CUIT",
      "id": ""
    }
  },
  "merchant": {
    "type": "INDIVIDUAL",
    "name": "John",
    "lastName": "Doe",
    "document": {
      "type": "CUIT",
      "id": "20276209079"
    },
    "email": "[email protected]"
  },
  "accountNumber": "{{yourAccountNumber}}",
  "conceptCode": "0003",
  "comment": "ARG TEST"
}
'

Successful response

{
  "externalId": "cebe19a9-e369-49ae-85a8-179b8c63f958",
  "internalId": "5a74a26b-85dc-4b43-a11c-db2bd4444212",
  "paymentMethod": {
    "code": "0010",
    "name": "INTERBANKING",
    "description": "string",
    "paymentMethodType": "BankTransfer"
  },
  "country": "ARG",
  "currency": "ARS",
  "amount": 157156,
  "accountNumber": "{{yourAccountNumber}}",
  "clientCode": "0001",
  "clientName": "{{yourCompany}}",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Bank Name",
      "code": "007",
      "countryISOCode3": null,
      "branch": null,
      "account": {
        "number": "0070175030004038509392",
        "type": "C",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "INDIVIDUAL",
    "name": "Beneficiary Name",
    "lastname": "Beneficiary LastName",
    "document": {
      "type": "CUIT",
      "id": "12345678910"
    },
    "userReference": "Additional information",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "phoneNumber"
    },
    "birthdate": "1980-01-01T00:00:00",
    "nationality": "Beneficiary Nationality",
    "address": {
      "street": "Av Beneficiary Address",
      "number": "1234",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name",
      "zipCode": "Zip Code",
      "comment": "Additional address information"
    }
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Merchant Name",
    "lastname": "Merchant LastName",
    "document": {
      "type": "CUIT",
      "id": "23456789123"
    },
    "userReference": "additional information",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "phoneNumber"
    },
    "birthdate": "2001-01-01T00:00:00",
    "nationality": "Merchant Nacionality",
    "address": {
      "street": "Av Merchant Address",
      "number": "1234",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name",
      "zipCode": "Zip Code",
      "comment": null
    }
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "Sender Name",
    "lastname": "Sender LastName",
    "document": {
      "type": "",
      "id": ""
    },
    "userReference": "additional information",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "phoneNumber"
    },
    "birthdate": "2001-01-01T00:00:00",
    "nationality": "Sender Nacionality",
    "address": {
      "street": "Av Sender Address",
      "number": "1234",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name",
      "zipCode": "Zip Code",
      "comment": null
    }
  },
  "comment": "Addicional information",
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2024-09-26T18:42:42.4120255+00:00",
    "processedDate": "2024-09-26T18:42:42.4149357+00:00"
  },
  "errors": null,
  "internalLoteID": "7222"
}

Bolivia

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "BOL" as the value for country .
  • Enter "BOB" as the value for currency .
  • The beneficiary.document.type is optional for Bolivia.

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "{{Yourexternalid}}",
  "internalId": "{{Yourinternalid}}",
  "paymentMethod": {
    "code": "0020",
    "name": "SCP",
    "description": "SCP",
    "paymentMethodType": "BankTransfer"
  },
  "country": "BOL",
  "currency": "BOB",
  "amount": 2000,
  "accountNumber": "{{Youraccountnumber}}",
  "clientCode": "0001",
  "clientName": "{{Yourcompany}}",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "BOL TEST",
      "code": "025",
      "countryISOCode3": null,
      "branch": null,
      "account": {
        "number": "1234567",
        "type": "S",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "Company",
    "name": "Tupac",
    "lastname": "Katari",
    "document": {
      "type": "NIT",
      "id": "173628025"
    },
    "userReference": "Lorem",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "phoneNumber"
    },
    "birthdate": "2001-11-08T00:00:00",
    "nationality": "beneficiary nationality",
    "address": {
      "street": "Beneficiary adress",
      "number": "234",
      "city": "City",
      "state": "Villa Rosa",
      "country": "Country",
      "zipCode": "1411",
      "comment": "TEST"
    }
  },
  "merchant": {
    "type": "INDIVIDUAL",
    "name": "Brenda Aldana",
    "lastname": "Villanueva",
    "document": null,
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "sender": {
    "type": "COMPANY",
    "name": "Bartolina Sisa",
    "lastname": "ABCDIN",
    "document": {
      "type": "NIT",
      "id": "4173628025"
    },
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "comment": "Regresion Test",
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2024-09-26T19:02:25.6445074+00:00",
    "processedDate": "2024-09-26T19:02:25.6449528+00:00"
  },
  "errors": null,
  "internalLoteID": "7224"
}
'

Successful response

{
  "externalId": "{{Yourexternalid}}",
  "internalId": "{{Yourinternalid}}",
  "paymentMethod": {
    "code": "0020",
    "name": "SCP",
    "description": "SCP",
    "paymentMethodType": "BankTransfer"
  },
  "country": "BOL",
  "currency": "BOB",
  "amount": 2000,
  "accountNumber": "{{Youraccountnumber}}",
  "clientCode": "0001",
  "clientName": "{{Yourcompany}}",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "BOL TEST",
      "code": "025",
      "countryISOCode3": null,
      "branch": null,
      "account": {
        "number": "1234567",
        "type": "S",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "Company",
    "name": "Tupac",
    "lastname": "Katari",
    "document": {
      "type": "NIT",
      "id": "173628025"
    },
    "userReference": "Lorem",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "phoneNumber"
    },
    "birthdate": "2001-11-08T00:00:00",
    "nationality": "beneficiary nationality",
    "address": {
      "street": "Beneficiary adress",
      "number": "234",
      "city": "City",
      "state": "Villa Rosa",
      "country": "Country",
      "zipCode": "1411",
      "comment": "TEST"
    }
  },
  "merchant": {
    "type": "INDIVIDUAL",
    "name": "Brenda Aldana",
    "lastname": "Villanueva",
    "document": null,
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "sender": {
    "type": "COMPANY",
    "name": "Bartolina Sisa",
    "lastname": "ABCDIN",
    "document": {
      "type": "NIT",
      "id": "4173628025"
    },
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "comment": "Regresion Test",
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2024-09-26T19:02:25.6445074+00:00",
    "processedDate": "2024-09-26T19:02:25.6449528+00:00"
  },
  "errors": null,
  "internalLoteID": "7224"
}

Brazil

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information.
  • Enter "BRA" as the value for country.
  • Enter "BRL" as the value for currency.
  • For Brazil, the beneficiary.bank.branch object must be filled up using the following information:
    • code: Enter the beneficiary's bank branch code using the appropriate format for each bank.
    • name: Enter the beneficiary's bank branch name.

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "b2d64b85-4381-4902-aca9-9455a1f70665",
  "country": "BRA",
  "currency": "BRL",
  "amount": 10000,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0030",
    "flow": "direct"
  },
  "beneficiary": {
    "type": "COMPANY",
    "name": "LP DO BRASIL SERVICOS DE PAGAMENTOS",
    "lastName": "",
    "document": {
      "type": "CNPJ",
      "id": "34669130000133"
    },
    "userReference": "Lorem",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "number"
    },
    "birthDate": "2001-11-08",
    "nationality": "beneficiary nationality",
    "address": {
      "street": "Beneficiary adress",
      "number": "234",
      "city": "City",
      "state": "Villa Rosa",
      "country": "Country",
      "zipCode": "1411",
      "comment": "TEST"
    },
    "bank": {
      "name": "Account holder full name",
      "code": "126",
      "branch": {
        "name": "Santander",
        "code": "0004"
      },
      "account": {
        "number": "1112111",
        "type": "C"
      }
    }
  },
  "sender": {
    "type": "COMPANY",
    "name": "Ronaldo de Assis",
    "lastName": "Moreira",
    "document": {
      "type": "CNPJ",
      "id": "34669130000133"
    }
  },
  "merchant": {
    "type": "INDIVIDUAL",
    "name": "John",
    "lastName": "Doe",
    "document": {
      "type": "DNI",
      "id": "38612225"
    },
    "email": "string"
  },
  "accountNumber": "076.986.00000001",
  "conceptCode": "0003",
  "comment": "Test"
}
'

Successful response

{
  "externalId": "b2d64b85-4381-4902-aca9-9455a1f70665",
  "internalId": "65425aef-08a2-4d3c-bf7e-79be493fd3e5",
  "paymentMethod": {
    "code": "0030",
    "name": "TED",
    "description": "TED",
    "paymentMethodType": "BankTransfer"
  },
  "country": "BRA",
  "currency": "BRL",
  "amount": 10000,
  "accountNumber": "076.986.00000001",
  "clientCode": "0001",
  "clientName": "Acme",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Account holder full name",
      "code": "126",
      "countryISOCode3": null,
      "branch": {
        "name": "Santander",
        "code": "0004"
      },
      "account": {
        "number": "1112111",
        "type": "C",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "COMPANY",
    "name": "LP DO BRASIL SERVICOS DE PAGAMENTOS",
    "lastname": "",
    "document": {
      "type": "CNPJ",
      "id": "34669130000133"
    },
    "userReference": "Lorem",
    "email": "[email protected]",
    "phone": {
      "countryCode": "countryCode",
      "areaCode": "areaCode",
      "number": "number"
    },
    "birthdate": "2001-11-08T00:00:00",
    "nationality": "beneficiary nationality",
    "address": {
      "street": "Beneficiary adress",
      "number": "234",
      "city": "City",
      "state": "Villa Rosa",
      "country": "Country",
      "zipCode": "1411",
      "comment": "TEST"
    }
  },
  "merchant": {
    "type": "INDIVIDUAL",
    "name": "John",
    "lastname": "Doe",
    "document": {
      "type": "DNI",
      "id": "38612225"
    },
    "userReference": null,
    "email": "string",
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "sender": {
    "type": "COMPANY",
    "name": "Ronaldo de Assis",
    "lastname": "Moreira",
    "document": {
      "type": "CNPJ",
      "id": "34669130000133"
    },
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "comment": "Test",
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2025-03-25T14:05:12.3754007+00:00",
    "processedDate": "2025-03-25T14:05:12.3757699+00:00"
  },
  "errors": null,
  "internalLoteID": "38405"
}

Chave PIX

Payouts from Brazil can be made using the complete bank account details or using a Chave PIX.

Pix is a quick payment method launched by the Central Bank of Brazil in 2020 that is progressively gaining popularity.

Pix allows you to make payments and transfers at any time of the day, including holidays and weekends.

To make payments and transfers, users must have a registered Pix key.

A Pix key can be divided into five types:

  • CPF
  • CNPJ
  • Cellphone number
  • Email
  • Random key: The random key is a unique code generated by the Central Bank, containing 32 characters with letters and symbols and linked to a single account. It is a way to receive Pix without providing any personal data.

ThePix key must be provided in the beneficiary's bank.account.aliasproperty and, as previously stated, must be a valid key.

Request example

{
    "externalId": "{{timestamp}}",
    "country": "BRA",
    "currency": "BRL",
    "amount": 11,
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "0031",
        "flow": "direct"
    },
    "beneficiary": {
        "type": "COMPANY",
        "name": "beneficiary name",
        "lastName": "",
        "document": {
            "type": "CNPJ",
            "id": "34669130000133"
        },
        "userReference": "Lorem",
        "email": "[email protected]",
        "phone": {
            "countryCode": "54",
            "areaCode": "11",
            "number": "33871784"
        },
        "birthDate": "2021-11-08T17:50:01.196Z",
        "nationality": "beneficiary nationality",
        "address": {
            "street": "Beneficiary adress",
            "number": "234",
            "city": "City",
            "state": "Villa Rosa",
            "country": "Country",
            "zipCode": "1411",
            "comment": "TEST"
        },
        "bank": {
            "account": {
                "alias": "[email protected]"
            }
        }
    },
    "sender": {
        "type": "COMPANY",
        "name": "BACEN",
        "lastName": "A",
        "document": {
            "type": "CNPJ",
            "id": "34669130000133"
        }
    },
    "merchant": {
        "type": "INDIVIDUAL",
        "name": "Brenda Aldana",
        "lastName": "Villanueva",
        "document": {
            "type": "DNI",
            "id": "38612225"
        },
        "email": "[email protected]"
    },
    "accountNumber": "076.840.00000003",
    "conceptCode": "0003",
    "comment": "TEST"
}'

Successful response

{
    "externalId": "1722007956",
    "internalId": "a5114b84-ffe2-4c44-a3ba-396dd22ca714",
    "paymentMethod": {
        "code": "0030",
        "name": "TED",
        "description": "TED",
        "paymentMethodType": "BankTransfer"
    },
    "country": "BRA",
    "currency": "BRL",
    "amount": 500.0,
    "accountNumber": "{{Youraccount}}",
    "clientCode": "0001",
    "clientName": "Acme",
    "status": {
        "code": "100",
        "description": "Received",
        "detail": "The payout was received"
    },
    "beneficiary": {
        "bank": {
            "name": "Banco do Brasil S.A.",
            "code": "001",
            "countryISOCode3": null,
            "branch": {
                "name": "Branch Name",
                "code": "69361"
            },
            "account": {
                "number": "269018",
                "type": "S",
                "alias": null,
                "pixKey": null,
                "phone": null
            }
        },
        "type": "INDIVIDUAL",
        "name": "Beneficiary Name",
        "lastname": "Beneficiary LastName",
        "document": {
            "type": "CPF",
            "id": "46302653843"
        },
        "userReference": "Additional information",
        "email": "[email protected]",
        "phone": {
            "countryCode": "55",
            "areaCode": "55",
            "number": "5555555"
        },
        "birthdate": "1990-01-01T00:00:00",
        "nationality": "Beneficiary Nationality",
        "address": {
            "street": "Av Beneficiary Address",
            "number": "1234",
            "city": "City Name",
            "state": "State Name",
            "country": "Country Name",
            "zipCode": "Zip Code",
            "comment": "Additional address information"
        }
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Merchant Name",
        "lastname": "Merchant LastName",
        "document": {
            "type": "CNPJ",
            "id": "34669130330133"
        },
        "userReference": null,
        "email": "Merchant email address",
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "sender": {
        "type": "COMPANY",
        "name": "Sender Name",
        "lastname": "Sender LastName",
        "document": {
            "type": "CNPJ",
            "id": "34669130000133"
        },
        "userReference": null,
        "email": null,
        "phone": null,
        "birthdate": "0001-01-01T00:00:00",
        "nationality": null,
        "address": null
    },
    "comment": "Addicional informetion",
    "exchangeRateToken": null,
    "date": {
        "creationDate": "2024-07-26T15:32:46.6844321+00:00",
        "processedDate": "2024-07-26T15:32:46.684686+00:00"
    },
    "errors": null,
    "internalLoteID": "3333"
}

Chile

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "CHL" as the value for country .
  • Enter "CLP" as the value for currency .
  • If the currency is "CLP", the amount must not include decimals.

Request example

curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'Content-Type: application/json' \
--data-raw '  [

    {
    "externalId": "{{externalId}}",
    "country": "CHL",
    "currency": "CLP",
    "amount": 500,
    "paymentMethod": {
        "type": "BankTransfer",
        "code": "0050",
        "flow": "direct"
    },
    "beneficiary": {
        "name": "Beneficiary Name ",
        "lastName": "Beneficiary LastName",
        "type": "INDIVIDUAL",
        "document": {
            "type": "RUT",
            "id": "08.900.960-K"
        },
        "bank": {
            "name": "Banco Name",
            "code": "009",
            "account": {
                "number": "123456789012345",
                "type": "C",
                "code": "009"
                }
         }
    },
    "sender": {
        "type": "INDIVIDUAL",
        "name": "Sender Name",
        "lastName": "Sender LastName"
    },
    "merchant": {
        "type": "COMPANY",
        "name": "Merchant Name"
    },
    "accountNumber": 152.152.00000004,
    "conceptCode": "0001"
    }
]

Successful response

[
    {
        "externalId": "1689620929",
        "internalId": "8e434bc4-f982-49ea-9a08-62f542138a74",
        "paymentMethod": {
            "code": "0050",
            "name": "TEF",
            "description": "TEF",
            "paymentMethodType": "BankTransfer"
        },
        "country": "CHL",
        "currency": "CLP",
        "amount": 500,
        "accountNumber": "152.152.00000004",
        "clientCode": "0001",
        "clientName": "Acme",
        "status": {
            "code": "100",
            "description": "Received",
            "detail": "The payout was received"
        },
        "beneficiary": {
            "bank": {
                "name": "Banco Name",
                "code": "009",
                "branch": null,
                "account": {
                    "number": "123456789012345",
                    "type": "C",
                    "alias": null,
                    "pixKey": null,
                    "phone": null
                }
            },
            "type": "INDIVIDUAL",
            "name": "Beneficiary Name ",
            "lastname": "Beneficiary LastName",
            "document": {
                "type": "RUT",
                "id": "08.900.960-K"
            },
            "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 Name",
            "lastname": "Sender LastName",
            "document": null,
            "userReference": null,
            "email": null,
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": null,
            "address": null
        },
        "comment": null,
        "exchangeRateToken": null,
        "date": {
            "creationDate": "2023-07-17T19:08:49.0542638+00:00",
            "processedDate": "2023-07-17T19:08:49.1505068+00:00"
        },
        "errors": null
    }
]

Colombia

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Available banks vary depending on the payment type used.
  • Enter "COL" as the value for country .
  • Enter "COP" as the value for currency .
  • In Colombia, only Transfiya provides the possibility of transferring payments using a cellphone number as the account number. Please take note of the following:
    • The field beneficiary.bank.account.type must have the type "P".
    • The field beneficiary.bank.account.number must have a number with a length of 12 digits and should start with +573.
    • Through the webhook, a notification is sent as a text message to the beneficiary's mobile phone. After this, they will be able to accept or reject the payment from their banking app registered with Transfiya.

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyOTExNjcwLCJqdGkiOiIzYWQyNmQ1MzM3ZDU0OTJkOGVjN2M2OGE4ZTc5ODQ0MiIsInVzZXJfaWQiOjEwMTUsInN1cGVydXNlciI6dHJ1ZSwiaXNfc3RhZmYiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.YZ2Qt7mn4l8pg9BmxzqvVmxiQJJhhIu5irMKXiglh5I' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "e8a9773a-816f-46c2-9cf4-ce19fe3c67c1",
  "country": "COL",
  "currency": "COP",
  "amount": 500,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0060",
    "flow": "direct"
  },
  "beneficiary": {
    "name": "Beneficiary Name ",
    "lastName": "Beneficiary LastName",
    "type": "INDIVIDUAL",
    "document": {
      "type": "CC",
      "id": "12345678"
    },
    "bank": {
      "name": "Banco Name",
      "code": "1507",
      "account": {
        "number": "{{bankaccountnumber}}",
        "type": "S"
      }
    }
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "Sender Name",
    "lastName": "Sender LastName"
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Merchant Name"
  },
  "accountNumber": "170.170.00000004",
  "conceptCode": "0001"
}
'

Successful response

{
  "externalId": "e8a9773a-816f-46c2-9cf4-ce19fe3c67c1",
  "internalId": "91eaf3db-2431-4dbb-bd34-220dea3eea8f",
  "paymentMethod": {
    "code": "0060",
    "name": "SINPE",
    "description": "ACH",
    "paymentMethodType": "BankTransfer"
  },
  "country": "COL",
  "currency": "COP",
  "amount": 500,
  "accountNumber": "{{YourAccount}}",
  "clientCode": "0001",
  "clientName": "{{YourName}}",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Banco Name",
      "code": "1507",
      "branch": null,
      "account": {
        "number": "3185153423",
        "type": "S",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "INDIVIDUAL",
    "name": "Beneficiary Name ",
    "lastname": "Beneficiary LastName",
    "document": {
      "type": "CC",
      "id": "412345678"
    },
    "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 Name",
    "lastname": "Sender LastName",
    "document": null,
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "comment": null,
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2024-07-17T19:14:45.8633222+00:00",
    "processedDate": "2024-07-17T19:14:45.9577679+00:00"
  },
  "errors": null
}

Costa Rica

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "CRI" as the value for country .
  • Enter "CRC" as the value for currency .

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyOTExNjcwLCJqdGkiOiIzYWQyNmQ1MzM3ZDU0OTJkOGVjN2M2OGE4ZTc5ODQ0MiIsInVzZXJfaWQiOjEwMTUsInN1cGVydXNlciI6dHJ1ZSwiaXNfc3RhZmYiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.YZ2Qt7mn4l8pg9BmxzqvVmxiQJJhhIu5irMKXiglh5I' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "4643d794-225e-460c-af37-29210ab46cc1",
  "country": "CRI",
  "currency": "CRC",
  "amount": 10,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0070",
    "flow": "direct"
  },
  "beneficiary": {
    "name": "Empresa ",
    "type": "COMPANY",
    "document": {
      "type": "RUT",
      "id": "12345678-111"
    },
    "bank": {
      "name": "Banco Bac San José",
      "code": "0102",
      "account": {
        "number": "{{YourAccountNumber}}",
        "type": "C"
      }
    }
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "Sender Name",
    "lastName": "Sender LastName"
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Merchant Name"
  },
  "accountNumber": "{{accountNumber}}",
  "conceptCode": "0001"
}
'

Successful response

{
  "externalId": "800a1d3c-818d-4982-bbc9-70fd6eb71e82",
  "internalId": "93974957-69f0-4f26-9513-f670c8ac58c6",
  "paymentMethod": {
    "code": "0070",
    "name": "SINPE",
    "description": "SINPE",
    "paymentMethodType": "BankTransfer"
  },
  "country": "CRI",
  "currency": "CRC",
  "amount": 1030.63,
  "accountNumber": "{{YourAccountNumber}}",
  "clientCode": "0001",
  "clientName": "Acme",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Banco Bac San José",
      "code": "0102",
      "countryISOCode3": null,
      "branch": null,
      "account": {
        "number": "{{AccountNumber}}",
        "type": "C",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "COMPANY",
    "name": "Empresa ",
    "lastname": null,
    "document": {
      "type": "RUT",
      "id": "12345678-000"
    },
    "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 Name",
    "lastname": "Sender LastName",
    "document": null,
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "comment": null,
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2024-12-14T15:55:00.6462479+00:00",
    "processedDate": "2024-12-14T15:55:00.7365273+00:00"
  },
  "errors": null
}

Dominic Republic

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "DOM" as the value for country .
  • Enter "DOP" as the value for currency .

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyOTExNjcwLCJqdGkiOiIzYWQyNmQ1MzM3ZDU0OTJkOGVjN2M2OGE4ZTc5ODQ0MiIsInVzZXJfaWQiOjEwMTUsInN1cGVydXNlciI6dHJ1ZSwiaXNfc3RhZmYiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.YZ2Qt7mn4l8pg9BmxzqvVmxiQJJhhIu5irMKXiglh5I' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "a0c81b15-9cb3-447e-bb89-a1bd41eb2fb9",
  "country": "DOM",
  "currency": "DOP",
  "amount": 50,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0080",
    "flow": "direct"
  },
  "beneficiary": {
    "name": "Beneficiary Name",
    "lastName": "Beneficiary LastName ",
    "type": "INDIVIDUAL",
    "document": {
      "type": "RNC",
      "id": "401-50625-4"
    },
    "bank": {
      "name": "Banco",
      "code": "434911008",
      "account": {
        "number": "08019997377947",
        "type": "S"
      }
    }
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "Sender Name",
    "lastName": "Sender LastName",
    "document": {
      "type": "RNC",
      "id": "401-50625-4"
    }
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Merchant Name"
  },
  "accountNumber": "214.214.00000001",
  "conceptCode": "0001"
}
'

Successful response

{
  "externalId": "a0c81b15-9cb3-447e-bb89-a1bd41eb2fb9",
  "internalId": "f45b380e-116c-4b39-a520-59bd7d250b24",
  "paymentMethod": {
    "code": "0080",
    "name": "CC",
    "description": "ACH",
    "paymentMethodType": "BankTransfer"
  },
  "country": "DOM",
  "currency": "DOP",
  "amount": 50,
  "accountNumber": "214.214.00000001",
  "clientCode": "0001",
  "clientName": "Acme",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Banco",
      "code": "434911008",
      "countryISOCode3": null,
      "branch": null,
      "account": {
        "number": "08019997377947",
        "type": "S",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "INDIVIDUAL",
    "name": "Beneficiary Name",
    "lastname": "Beneficiary LastName ",
    "document": {
      "type": "RNC",
      "id": "401-50625-4"
    },
    "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 Name",
    "lastname": "Sender LastName",
    "document": {
      "type": "RNC",
      "id": "401-50625-4"
    },
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "comment": null,
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2025-03-25T16:17:32.4330882+00:00",
    "processedDate": "2025-03-25T16:17:32.4334671+00:00"
  },
  "errors": null,
  "internalLoteID": "38423"
}

Guatemala

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "GTM" as the value for country .
  • Enter "GTQ" as the value for currency .

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyOTExNjcwLCJqdGkiOiIzYWQyNmQ1MzM3ZDU0OTJkOGVjN2M2OGE4ZTc5ODQ0MiIsInVzZXJfaWQiOjEwMTUsInN1cGVydXNlciI6dHJ1ZSwiaXNfc3RhZmYiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.YZ2Qt7mn4l8pg9BmxzqvVmxiQJJhhIu5irMKXiglh5I' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "b886d084-7e55-4f8b-8c45-dbc86a7e2547",
  "country": "GTM",
  "currency": "GTQ",
  "amount": 50,
  "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"
}
'

Successful response

{
  "externalId": "79d43196-41ee-4dc4-bea5-3ba23afb4db5",
  "internalId": "771f2287-f3eb-4605-9532-f900f045302d",
  "paymentMethod": {
    "code": "0110",
    "name": "ACH",
    "description": "ACH",
    "paymentMethodType": "BankTransfer"
  },
  "country": "GTM",
  "currency": "GTQ",
  "amount": 50,
  "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": "2024-07-24T15:11:05.3593261+00:00",
    "processedDate": "2024-07-24T15:11:05.4582163+00:00"
  },
  "errors": null
}

Mexico

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "MEX" as the value for country .
  • Enter "MXN" as the value for currency .
  • The beneficiary.document.type is optional for Mexico.
  • In Mexico, we offer the option to send payments using the mobile number as the account number. Please note the following:
    • The field beneficiary.bank.account.type must contain the type "P".
    • The field beneficiary.bank.account.number must contain a number with a length of 10 digits.

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyOTExNjcwLCJqdGkiOiIzYWQyNmQ1MzM3ZDU0OTJkOGVjN2M2OGE4ZTc5ODQ0MiIsInVzZXJfaWQiOjEwMTUsInN1cGVydXNlciI6dHJ1ZSwiaXNfc3RhZmYiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.YZ2Qt7mn4l8pg9BmxzqvVmxiQJJhhIu5irMKXiglh5I' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "5e7a75fe-623d-4260-b93d-97e187389109",
  "country": "MEX",
  "currency": "MXN",
  "requiereAuth": "TRUE",
  "amount": 63,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0130",
    "flow": "direct"
  },
  "beneficiary": {
    "type": "COMPANY",
    "name": "BeneficiaryName",
    "document": {
      "type": "RFC",
      "id": "MAMA831224NA1"
    },
    "userReference": "user",
    "email": "[email protected]",
    "phone": {
      "countryCode": "54",
      "areaCode": "11",
      "number": "33871784"
    },
    "birthDate": "2021-11-08T17:50:01.196Z",
    "nationality": "beneficiary nationality",
    "address": {
      "street": "Beneficiary adress",
      "number": "234",
      "city": "City",
      "state": "Villa",
      "country": "Country",
      "zipCode": "1411",
      "comment": "TEST"
    },
    "bank": {
      "name": "BankName",
      "code": "002",
      "branch": {
        "name": "Branch Name",
        "code": "69361"
      },
      "account": {
        "type": "S",
        "number": "002180700070799802"
      }
    }
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "SenderName",
    "lastname": "SenderLastName",
    "document": {
      "type": "CUIT",
      "id": "20276209079"
    }
  },
  "merchant": {
    "type": "INDIVIDUAL",
    "name": "MerchanFirstName",
    "lastname": "MerchantLastName",
    "document": {
      "type": "CUIT",
      "id": "20276209079"
    },
    "email": "[email protected]"
  },
  "accountNumber": "484.484.00000011",
  "conceptCode": "0003",
  "comment": "TEST"
}
'

Successful response

{
  "externalId": "b4b58387-4a02-4a05-a6b4-9722ea73c48a",
  "internalId": "a023a7dc-7549-485f-abdb-6459ebc95550",
  "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": "2024-06-27T15:25:36.5878589+00:00",
    "processedDate": "2024-06-27T15:25:36.6810076+00:00"
  },
  "errors": null
}

Panama

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "PAN" as the value for country .
  • Enter "USD" as the value for currency .

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyOTExNjcwLCJqdGkiOiIzYWQyNmQ1MzM3ZDU0OTJkOGVjN2M2OGE4ZTc5ODQ0MiIsInVzZXJfaWQiOjEwMTUsInN1cGVydXNlciI6dHJ1ZSwiaXNfc3RhZmYiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.YZ2Qt7mn4l8pg9BmxzqvVmxiQJJhhIu5irMKXiglh5I' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "17e46e12-0d64-4046-bfc6-d9e9ebc8ed4f",
  "country": "PAN",
  "currency": "USD",
  "amount": 50,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0150",
    "flow": "direct"
  },
  "beneficiary": {
    "name": "Beneficiary Name",
    "lastName": "Beneficiary LastName ",
    "type": "INDIVIDUAL",
    "document": {
      "type": "RUC",
      "id": "22063889875"
    },
    "bank": {
      "name": "Banco",
      "code": "1384",
      "account": {
        "number": "356874213500",
        "type": "C"
      }
    }
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "Sender Name",
    "lastName": "Sender LastName",
    "document": {
      "type": "DNI",
      "id": "40754127"
    }
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Merchant Name"
  },
  "accountNumber": "591.840.00000005",
  "conceptCode": "0001"
}
'

Successful response

{
  "externalId": "28accbf1-a396-4535-b9c7-1533d9d3ec79",
  "internalId": "1f3f68c4-86a5-40f0-b60a-09c56a57a989",
  "paymentMethod": {
    "code": "0150",
    "name": "ACH",
    "description": "ACH",
    "paymentMethodType": "BankTransfer"
  },
  "country": "PAN",
  "currency": "USD",
  "amount": 50,
  "accountNumber": "591.840.00000005",
  "clientCode": "0001",
  "clientName": "Acme",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Banco",
      "code": "1384",
      "branch": null,
      "account": {
        "number": "356874213500",
        "type": "C",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "INDIVIDUAL",
    "name": "Beneficiary Name",
    "lastname": "Beneficiary LastName ",
    "document": {
      "type": "RUC",
      "id": "22063889875"
    },
    "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": "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": "2024-07-10T19:14:19.2917762+00:00",
    "processedDate": "2024-07-10T19:14:19.3935598+00:00"
  },
  "errors": null
}


Peru

To create a bank transfer payout, send a POST request to the Create a Payout endpoint:

  • For Bank Transfer in the paymentMethod.type set "BankTransfer"; the remainder of the object's properties take into account country information .
  • Enter "PER" as the value for country .
  • Enter "PEN" as the value for currency .
  • To validate the CCI it is recommended to use: https://www.transferenciasinterbancarias.pe/.

Request example

curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyOTExNjcwLCJqdGkiOiIzYWQyNmQ1MzM3ZDU0OTJkOGVjN2M2OGE4ZTc5ODQ0MiIsInVzZXJfaWQiOjEwMTUsInN1cGVydXNlciI6dHJ1ZSwiaXNfc3RhZmYiOmZhbHNlLCJyb2xlcyI6WyJBRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDAxIiwiY2xpZW50X2NvZGUiOiIwMDAxIn0.YZ2Qt7mn4l8pg9BmxzqvVmxiQJJhhIu5irMKXiglh5I' \
     --header 'content-type: application/json' \
     --data '
{
  "externalId": "8d94c5ba-370b-4d6d-9ee1-d0b4aac52c1d",
  "country": "PER",
  "currency": "PEN",
  "amount": 500.1,
  "paymentMethod": {
    "type": "BankTransfer",
    "code": "0170",
    "flow": "direct"
  },
  "beneficiary": {
    "name": "Beneficiary Name ",
    "lastName": "Beneficiary LastName",
    "type": "INDIVIDUAL",
    "document": {
      "type": "RUC",
      "id": "20608388649"
    },
    "bank": {
      "name": "Banco Name",
      "code": "002",
      "account": {
        "number": "00219400940064207893",
        "type": "S"
      }
    }
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "Sender Name",
    "lastName": "Sender LastName"
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Merchant Name"
  },
  "accountNumber": "604.604.00000005",
  "conceptCode": "0001"
}
'

Successful response

{
  "externalId": "b7ea2c3c-100e-4af8-ad70-2cdf3658042b",
  "internalId": "f75ac7de-3834-4ae3-a5ae-32f4b325d1b4",
  "paymentMethod": {
    "code": "0170",
    "name": "CCE",
    "description": "CCE",
    "paymentMethodType": "BankTransfer"
  },
  "country": "PER",
  "currency": "PEN",
  "amount": 500.1,
  "accountNumber": "604.604.00000005",
  "clientCode": "0001",
  "clientName": "Acme",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Banco Name",
      "code": "002",
      "branch": null,
      "account": {
        "number": "00219400940064207893",
        "type": "S",
        "alias": null,
        "pixKey": null,
        "phone": null
      }
    },
    "type": "INDIVIDUAL",
    "name": "Beneficiary Name ",
    "lastname": "Beneficiary LastName",
    "document": {
      "type": "RUC",
      "id": "20608388649"
    },
    "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 Name",
    "lastname": "Sender LastName",
    "document": null,
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00",
    "nationality": null,
    "address": null
  },
  "comment": null,
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2024-07-17T19:33:52.6915503+00:00",
    "processedDate": "2024-07-17T19:33:52.7857052+00:00"
  },
  "errors": null
}

Create a Payout by Alias

In Peru, we offer the option to send payments using the mobile phone number as the account alias. Please note the following:

  • The field beneficiary.bank.account.alias must contain a number with a length of 9 digits and should start with 9.
  • The fields beneficiary.bank.account.type and beneficiary.bank.account.number do not need to be sent for payments using the mobile phone number as the account alias.
  • The beneficiary.bank.account.alias field can only be used for the wallets' bank codes:
    • 901 - YAPE
    • 902 - PLIN

Request example

--header 'Authorization: {{Token_Generated}} \
--header 'Content-Type: application/json' \
--data-raw ' [
    {
    "externalId": 1748539945,
    "paymentMethod": {
        "type": "Wallet",
        "code": "0111",
        "flow": "direct"
      },
      "country": "PER",
      "currency": "PEN",
      "amount":101,
      "accountNumber": "604.111.00000005",
      "conceptCode": "0003",
      "comment": "PER TEST-GM1",
      "beneficiary": {
        "type": "INDIVIDUAL",
        "name": "Ana",
        "lastName": "Doe",
        "document": {
          "type": "DNI",
          "id": "12345678"
        },
        "email": "[email protected]",
        "phone": {
          "countryCode": "54",
          "areaCode": "11",
          "number": "554197111222"
        },
        "address": {
          "street": "Beneficiary adress",
          "number": "234",
          "city": "City",
          "state": "Villa Rosa",
          "country": "Country",
          "zipCode": "1111",
          "comment": "TEST"
        },
        "birthdate": "1980-10-08",
        "nationality": "beneficiary nationality",
       "bank": {
            "name": "YAPE",
            "code": "901",
            "branch": null,
            "account": {
               "alias": "999999999" 
            }
        },
        "userReference": "Ana_Doe12"
      },
      "merchant": {
        "type": "INDIVIDUAL",
        "name": "Ana",
        "lastName": "Doe",
        "document": {
          "type": "CUIT",
          "id": "20276333079"
        },
        "email": "[email protected]",
        "birthdate": "0001-01-01T00:00:00",
        "nationality": "",
        "userReference": ""
      },
      "sender": {
        "type": "INDIVIDUAL",
        "name": "Bob",
        "lastName": "Dow",
        "document": {
          "type": "DNI",
          "id": "43722333"
        },
        "email": "",
        "birthdate": "0001-01-01T00:00:00",
        "nationality": "",
        "userReference": ""
      },
      "transactionType": "PayOut",
      "clientCode": "0005",
      "createdBy": "[email protected]",
      "processType": "PayOutCreation",
      "requireAuth": false,
      "file": false,
      "internalLoteID": "31488"
      }
]

Successful response

[
    {
        "externalId": "1748539945",
        "internalId": "e47abec9-9d4f-424b-9eb2-220efe",
        "paymentMethod": {
            "code": "0111",
            "name": "WALLET",
            "description": "Wallet",
            "paymentMethodType": "Wallet"
        },
        "country": "PER",
        "currency": "PEN",
        "amount": 101,
        "accountNumber": "6604.111.00000005",
        "clientCode": "0001",
        "clientName": "Acme",
        "status": {
            "code": "100",
            "description": "Received",
            "detail": "The payout was received"
        },
        "beneficiary": {
            "bank": {
                "name": "YAPE",
                "code": "901",
                "countryISOCode3": null,
                "branch": null,
                "account": {
                    "number": null,
                    "type": null,
                    "alias": "999999999",
                    "pixKey": null,
                    "phone": null
                }
            },
            "type": "INDIVIDUAL",
            "name": "Ana",
            "lastname": "Doe",
            "document": {
                "type": "DNI",
                "id": "12345678"
            },
            "userReference": "Ana_Doe12",
            "email": "[email protected]",
            "phone": {
                "countryCode": "54",
                "areaCode": "11",
                "number": "554197111222"
            },
            "birthdate": "1980-10-08T00:00:00",
            "nationality": "beneficiary nationality",
            "address": {
                "street": "Beneficiary adress",
                "number": "234",
                "city": "City",
                "state": "Villa Rosa",
                "country": "Country",
                "zipCode": "1111",
                "comment": "TEST"
            }
        },
        "merchant": {
            "type": "INDIVIDUAL",
            "name": "John",
            "lastname": "Doe",
            "document": {
                "type": "CUIT",
                "id": "20276333079"
            },
            "userReference": "",
            "email": "[email protected]",
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": "",
            "address": null
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "Bob",
            "lastname": "Doe",
            "document": {
                "type": "DNI",
                "id": "43722333"
            },
            "userReference": "",
            "email": "",
            "phone": null,
            "birthdate": "0001-01-01T00:00:00",
            "nationality": "",
            "address": null
        },
        "comment": "PER TEST-GM1",
        "exchangeRateToken": null,
        "date": {
            "creationDate": "2025-05-29T18:32:11.0863051+00:00",
            "processedDate": "2025-05-29T18:32:11.0866569+00:00"
        },
        "errors": null,
        "internalLoteID": "60799"
    }
]

Updated 14 days ago