Authorize
Localpayment's API works 24/7/365, to review our payment execution times and notification times please review our SLA page:
Last updated
Localpayment's API works 24/7/365, to review our payment execution times and notification times please review our SLA page:
Last updated
POST
https://api.stage.localpayment.com /api/payout
Create a payout order
[
"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 'https://api.stage.localpayment.com/api/payout/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjkwODE2NDAwLCJqdGkiOiJiMzE5NzlmZDM1ODA0NzJiOGU0ZmMwYjUyNmRjZWFhOSIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.9kIXBnENIFNv0jlHuRz0tFtN-OrfktvcFIUlPgCdnX0' \
--data-raw '{
"requireAuth": true,
"externalId": "2533a6a5-ab33-4e1a-8b65-b29c16eb84ec",
"country": "ARG",
"currency": "ARS",
"amount": 163,
"paymentMethod": {
"type": "BankTransfer",
"code": "0010",
"flow": "direct"
},
"beneficiary": {
"type": "COMPANY",
"name": "BeneficiaryFirstName",
"document": {
"type": "CUIL",
"id": "20045893651"
},
"userReference": "User",
"email": "email@lp.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": "TEST"
},
"bank": {
"name": "BankName",
"code": "007",
"account": {
"type": "S",
"number": "0070145330004020870169"
}
}
},
"sender": {
"type": "INDIVIDUAL",
"name": "SenderFirstName",
"lastname": "SenderLastName",
"document": {
"type": "CUIT",
"id": "20276209079"
}
},
"merchant": {
"type": "INDIVIDUAL",
"name": "MerchantName",
"lastname": "MerchantLastName",
"document": {
"type": "CUIT",
"id": "20276209079"
},
"email": "email@lp.com"
},
"accountNumber": "032.032.00000015",
"conceptCode": "0003",
"comment": "TEST"
}'
{
"externalId": "3cd45e06-e8dc-4879-bd45-66f4f56e5601",
"internalId": "7d7f7fca-e411-4ba6-b46f-b9fed4d5f3d0",
"paymentMethod": {
"code": "0010",
"name": "INTERBANKING",
"description": "Banco",
"paymentMethodType": "BankTransfer"
},
"country": "ARG",
"currency": "ARS",
"amount": 163.0,
"accountNumber": "032.032.00000015",
"clientCode": "0001",
"clientName": "Acme",
"status": {
"code": "104",
"description": "PendingAuth",
"detail": "The payout is pending of authorization by client"
},
"beneficiary": {
"bank": {
"name": "BankName",
"code": "007",
"branch": null,
"account": {
"number": "0070145330004020870169",
"type": "S",
"alias": null,
"pixKey": null,
"phone": null
}
},
"type": "COMPANY",
"name": "BeneficiaryFirstName",
"lastname": null,
"document": {
"type": "CUIL",
"id": "20045893651"
},
"userReference": "User",
"email": "email@lp.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": "TEST"
}
},
"merchant": {
"type": "INDIVIDUAL",
"name": "MerchantName",
"lastname": "MerchantLastName",
"document": {
"type": "CUIT",
"id": "20276209079"
},
"userReference": null,
"email": "email@lp.com",
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"sender": {
"type": "INDIVIDUAL",
"name": "SenderFirstName",
"lastname": "SenderLastName",
"document": {
"type": "CUIT",
"id": "20276209079"
},
"userReference": null,
"email": null,
"phone": null,
"birthdate": "0001-01-01T00:00:00",
"nationality": null,
"address": null
},
"comment": "TEST",
"exchangeRateToken": null,
"date": {
"creationDate": "2023-07-31T15:10:07.323299+00:00",
"processedDate": "2023-07-31T15:10:07.3858616+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"
}
]
}js
You must execute the end point "Authorize" , to change the status to Received, you can do it through InternalID, externalID or date range as shown below.
curl --location 'https://api.stage.localpayment.com/api/payout/authorize' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjkwOTkzOTM1LCJqdGkiOiIyYjAwY2MzNjBjODY0YjVlOTVkMjY1MzZlMTNhMjU4OCIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.KooB87GGby-YP_SaEyvodvY37QnC7j2fy6jx4DUukS8' \
--data ' [
{
"internalId": "7d7f7fca-e411-4ba6-b46f-b9fed4d5f3d0"
},
{
"internalID": "ff2b9935-82fa-4813-a474-5b10ce793a68"
}
]'
{
"status": 200,
"message": "The request will be processed."
}
{
"errors": {
"payOutBy": [
"The payOutBy field is required."
],
"[0].internalId": [
"Error converting value \"7d7f7fca-e411-4ba6-b4f-b9fed4d5f3d2\" to type 'System.Guid'. Path '[0].internalId', line 1, position 53."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-6af59d173e66ad4eb215987cd15d57af-bea3981476c0f347-00"
}
curl --location 'https://api.stage.localpayment.com/api/payout/authorize' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjkwOTk0NDUzLCJqdGkiOiI1MmY0NzM1ZWMzNzE0YTkxYWQ2MTYwODYyNGE5NDQ3NyIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.a3VntXrH_SjwoDyv5NZ5qEsbppxxavvlb_eqTBFOMCI' \
--data ' [
{
"externalId": "157e6df3-7df1-4fdf-b8fc-6323a5a4e924"
},
{
"externalId": "174016ec-7fff-444f-bd92-1235cd2e60bf"
}
]'
{
"status": 200,
"message": "The request will be processed."
}
curl --location 'https://api.stage.localpayment.com/api/payout/authorize' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjkwOTk0ODkwLCJqdGkiOiJjMGQ0ZmZiZmQyM2U0ZjAwYmE2ODU2YjcwZTU0MjQ3YSIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQUxMIl0sImNvdW50cmllcyI6WyJBTEwiXSwiY29tcGFueSI6IjAwMDEiLCJjbGllbnRfY29kZSI6IjAwMDEifQ.pr3KIvVz2MQ4xA9ER9QH-2OT59L4BknVVXO6RHsUiYE' \
--data ' [
{
"dateFrom": "2023-07-27",
"dateTo": "2023-07-28"
}
]'
{
"status": 200,
"message": "The request will be processed."
}
{
"Status": 400,
"Message": "DateTo must be after DateFrom.",
"TraceId": "f55ae37d-7be3-4f1c-8752-0875a3ab9d24"
}
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|