Ecuador
Example PayOut Request and Response
Last updated
Example PayOut Request and Response
Last updated
POST
https://api.stage.localpayment.com /api/payout
Create a payout order
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
{
"externalId": "1689621521",
"internalId": "ca61ea86-d8cc-4ffa-8761-a927218e50b8",
"paymentMethod": {
"code": "0090",
"name": "Name",
"description": "CC",
"paymentMethodType": "BankTransfer"
},
"country": "ECU",
"currency": "USD",
"amount": 500.1,
"accountNumber": "218.840.00000013",
"clientCode": "0001",
"clientName": "Acme",
"status": {
"code": "100",
"description": "Received",
"detail": "The payout was received"
},
"beneficiary": {
"bank": {
"name": "Banco Name",
"code": "0036",
"branch": null,
"account": {
"number": "02005285735",
"type": "S",
"alias": null,
"pixKey": null,
"phone": null
}
},
"type": "INDIVIDUAL",
"name": "Beneficiary Name ",
"lastname": "Beneficiary LastName",
"document": {
"type": "CI",
"id": "1004922993"
},
"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:18:41.6508295+00:00",
"processedDate": "2023-07-17T19:18:41.7111829+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": "ECU",
"currency": "USD",
"amount": 500.10,
"paymentMethod": {
"type": "BankTransfer",
"code": "0090",
"flow": "direct"
},
"beneficiary": {
"name": "Beneficiary Name ",
"lastName": "Beneficiary LastName",
"type": "INDIVIDUAL",
"document": {
"type": "CI",
"id": "1004922993"
},
"bank": {
"name": "Banco Name",
"code": "0036",
"account": {
"number": "02005285735",
"type": "S"
}
}
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastName": "Sender LastName"
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name"
},
"accountNumber": 218.840.00000013,
"conceptCode": "0001"
}
]
curl --location --request POST {{Api_URL}} \
--header 'Authorization: {{Token_Generated}} \
--header 'Content-Type: application/json' \
--data-raw ' [
{
"externalId": "{{$timestamp}}",
"country": "ECU",
"currency": "USD",
"amount": 500,
"paymentMethod": {
"type": "BankTransfer",
"code": "0090",
"flow": "direct"
},
"beneficiary": {
"type": "INDIVIDUAL",
"name": "Beneficiary Name",
"lastName": "Beneficiary LastName",
"document": {
"type": "CI",
"id": "1793154239023"
},
"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 do Brasil S.A.",
"code": "0036",
"branch": {
"name": "Branch Name",
"code": "69361"
},
"account": {
"number": "02005285735",
"type": "S"
}
}
},
"sender": {
"type": "INDIVIDUAL",
"name": "Sender Name",
"lastName": "Sender LastName",
"document": {
"type": "CPF",
"id": "83223084509"
},
"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"
}
},
"merchant": {
"type": "COMPANY",
"name": "Merchant Name",
"lastName": "Merchant LastName",
"document": {
"type": "CNPJ",
"id": "34669130330133"
},
"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"
}
},
"accountNumber": 218.840.00000013,
"conceptCode": "0001",
"comment": "Addicional information"
}
]
[
{
"externalId": "1689621521",
"internalId": "ca61ea86-d8cc-4ffa-8761-a927218e50b8",
"paymentMethod": {
"code": "0090",
"name": "Name",
"description": "CC",
"paymentMethodType": "BankTransfer"
},
"country": "ECU",
"currency": "USD",
"amount": 500.1,
"accountNumber": "218.840.00000013",
"clientCode": "0001",
"clientName": "Acme",
"status": {
"code": "100",
"description": "Received",
"detail": "The payout was received"
},
"beneficiary": {
"bank": {
"name": "Banco Name",
"code": "0036",
"branch": null,
"account": {
"number": "02005285735",
"type": "S",
"alias": null,
"pixKey": null,
"phone": null
}
},
"type": "INDIVIDUAL",
"name": "Beneficiary Name ",
"lastname": "Beneficiary LastName",
"document": {
"type": "CI",
"id": "1004922993"
},
"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:18:41.6508295+00:00",
"processedDate": "2023-07-17T19:18:41.7111829+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"
}
]
}