Billing Service
The billing endpoint of our API allows you to create, check and download mass billing processing in multiple countries workwide.
Create Billing
POST https://api.stage.localpayment.com /api/billing
Create a billing order
Headers
Request Body
[
"transactionType": "PayOut",
"externalId": "1669662742",
"internalId": "9e62700a-875d-430e-8239-c9be1ef81e75",
"loteOut": null,
"paymentMethod": {
"code": "0031",
"name": "PIX",
"description": "PIX",
"paymentMethodType": "BankTransfer"
},
"country": "BRA",
"currency": "BRL",
"amount": 500.0,
"accountNumber": "076.986.00000039",
"clientCode": "0001",
"clientName": "Acme",
"confirmed": {
"description": null,
"currency": "BRL",
"fxQuote": 1.0,
"amount": 500.0
},
"payment": {
"description": null,
"currency": "BRL",
"fxQuote": 1.0,
"amount": 500.0
},
"fees": {
"description": "Fee",
"currency": "BRL",
"fxQuote": 5.63398605,
"amount": 14.08
},
"localTaxes": [
{
"description": "IOF",
"currency": "BRL",
"fxQuote": 0.0,
"amount": 1.9
}
],
"withHoldings": [],
"status": {
"code": "101",
"description": "Locked",
"detail": "The payout has been confirmed and passed AML validations"
},
"beneficiary": {
"bank": {
"name": "Banco do Brasil S.A.",
"code": "001",
"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": "beneficiary_email@gmail.com",
"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
},
"exchangeRateToken": null,
"date": {
"creationDate": "2022-11-28T19:12:21.3660748+00:00",
"processedDate": "2022-11-28T19:12:21.5408595+00:00"
},
"errors": null
]{
"externalId": "1669663393",
"internalId": "00000000-0000-0000-0000-000000000000",
"status": null,
"errors": [
{
"code": "719",
"description": "Amount must not be empty and more tan 0"
}
]
}curl --location --request POST {{Api_URL}}
--header 'Authorization: {{Token_Generated}}
--header 'Content-Type: application/json'
--data-raw ' [
{
"externalId": "{{$timestamp}}",
"country": "ARG",
"currency": "ARS",
"amount": 500.10,
"paymentMethod": {
"type": "BankTransfer",
"code": "0031",
"flow": "DIRECT"
},
"beneficiary": {
"name": "Beneficiary Name ",
"lastName": "Beneficiary LastName",
"type": "INDIVIDUAL",
"bank": {
"name": "Banco Name",
"code": "007",
"account": {
"number": "0070145330004020870169",
"type": "S"
}
}
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastName": "Sender LastName"
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name"
},
"accountNumber": {{Your Account}},
"conceptCode": "0001"
}
{
"externalId": "{{$timestamp}}",
"country": "ARG",
"currency": "USD",
"amount": 10,
"exchangeRateToken": "76b54005-01a4-4b0c-8cd8-c51d31828b43"
"paymentMethod": {
"type": "BankTransfer",
"code": "0010",
"flow": "direct"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "BACEN",
"lastName": "Villanueva",
"document": {
"type": "dni",
"id": "11111111"
},
"userReference": "Lorem",
"email": "aldana@mail.com",
"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": "Add any relevant information"
},
"bank": {
"name": "Account holder full name",
"code": "007",
"account": {
"number": "0070175030004038500000",
"type": "C"
}
}
},
"sender": {
"type": "COMPANY",
"name": "BACEN",
"lastName": "A",
"document": {
"type": "CPF",
"id": "11111111111"
}
},
"merchant": {
"type": "INDIVIDUAL",
"name": "Brenda Aldana",
"lastName": "Villanueva",
"document": {
"type": "DNI",
"id": "38111222"
},
"email": "string"
},
"accountNumber": "032.840.00000005",
"conceptCode": "0003",
"comment": "Add any relevant informaction",
}curl --location --request POST {{Api_URL}}
--header 'Authorization: {{Token_Generated}}
--header 'Content-Type: application/json'
--data-raw ' [
{
"externalId": "{{$timestamp}}",
"country": "ARG",
"currency": "ARS",
"amount": 500,
"paymentMethod": {
"type": "BankTransfer",
"code": "0010",
"flow": "direct"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Beneficiary Name",
"lastName": "Beneficiary LastName",
"document": {
"type": "CUIL",
"id": "20045893651"
},
"userReference": "Additional information",
"email": "beneficiary_email@gmail.com",
"phone": {
"countryCode": "55",
"areaCode": "55",
"number": "5555555"
},
"birthDate": "1990-01-01",
"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"
},
"bank": {
"name": "Banco Galicia",
"code": "007",
"branch": {
"name": "Branch Name",
"code": "69361"
},
"account": {
"number": "0070145330004020870169",
"type": "S"
}
}
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastName": "Sender LastName",
"document": {
"type": "CUIL",
"id": "23045893669"
},
"userReference": "additional information",
"email": "email@Sender.address",
"phone": {
"countryCode": "55",
"areaCode": "57",
"number": "7777777"
},
"birthDate": "2001-01-01",
"nationality": "Sender Nacionality",
"address": {
"street": "Av Sender 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": "30500056734"
},
"userReference": "additional information",
"email": "email@Merchant.address",
"phone": {
"countryCode": "55",
"areaCode": "55",
"number": "66666666"
},
"birthDate": "2001-01-01",
"nationality": "Merchant Nacionality",
"address": {
"street": "Av Merchant Address",
"number": "1234",
"city": "City Name",
"state": "State Name",
"country": "Country Name",
"zipCode": "Zip Code",
"comment": "Additional address information"
}
},
"accountNumber": {{Your Account}},,
"conceptCode": "0001",
"comment": "Addicional informetion"
}{
"externalId": "1690384130",
"internalId": "a437f20c-f88a-41bd-8a0a-e9f086c66afd",
"paymentMethod": {
"code": "0130",
"name": "SPEI",
"description": "SPEI",
"paymentMethodType": "BankTransfer"
},
"country": "MEX",
"currency": "MXN",
"amount": 10.3,
"accountNumber": "484.484.00000011",
"clientCode": "0001",
"clientName": "Acme",
"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": "Name Test",
"lastname": "LastName Test",
"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": " LastName",
"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-07-26T15:08:50.499478+00:00",
"processedDate": "2023-07-26T15:08:50.5975421+00:00"
},
"errors": null
} {
"externalId": "1669696323",
"internalId": "00000000-0000-0000-0000-000000000000",
"status": {
"code": "300",
"description": "Rejected",
"detail": "Invalid param + [param name] + [reason]"
},
"errors": [
{
"code": "300",
"description": "Invalid param + Beneficiary.Bank.branch.[code] + must not be null"
},
{
"code": "300",
"description": "Invalid param + Beneficiary.Bank.branch.code + must not be null"
}
]
}jsLast updated