curl --request GET \
--url https://app.amplopay.com/api/v1/gateway/producer \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI'
{
"name": "John Doe",
"email": "john@mail.com",
"phone": "(11) 99999-9999",
"document": "12.345.678/0001-00",
"address": {
"zipCode": "12345-000",
"country": "BR",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Alphaville",
"street": "Rua dos Frades",
"number": "33A",
"complement": "Sala 2"
},
"legalRepresentative": {
"name": "Maria Doe",
"phone": "(11) 95555-5555",
"document": "123.456.789-00",
"address": {
"zipCode": "45678-000",
"country": "BR",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulista",
"street": "Rua dos Bobos",
"number": "0",
"complement": "Casa"
}
}
}
Endpoints
Get producer data
Return data for the authenticated producer
GET
/
gateway
/
producer
curl --request GET \
--url https://app.amplopay.com/api/v1/gateway/producer \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI'
{
"name": "John Doe",
"email": "john@mail.com",
"phone": "(11) 99999-9999",
"document": "12.345.678/0001-00",
"address": {
"zipCode": "12345-000",
"country": "BR",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Alphaville",
"street": "Rua dos Frades",
"number": "33A",
"complement": "Sala 2"
},
"legalRepresentative": {
"name": "Maria Doe",
"phone": "(11) 95555-5555",
"document": "123.456.789-00",
"address": {
"zipCode": "45678-000",
"country": "BR",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulista",
"street": "Rua dos Bobos",
"number": "0",
"complement": "Casa"
}
}
}
Returns data for the authenticated producer.
This endpoint requires the
x-public-key and x-secret-key headers.Request example
curl --request GET \
--url https://app.amplopay.com/api/v1/gateway/producer \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI'
Response
string
required
Producer name.
string
required
Producer email address.
string
required
Producer phone number, formatted as
(99) 99999-9999.string
Producer document. It can be CPF or CNPJ, formatted with punctuation. This field is not returned when the producer has not completed KYC.
object
Producer or company address. If the producer has not completed KYC, this field is not returned.
string
ZIP code, formatted with a hyphen.
string
Country in ISO 3166-1 format.
string
State in ISO 3166-2:BR format.
string
City.
string
Neighborhood.
string
Street.
string
Address number.
string
Address complement.
object
Company legal representative information. Returned only for producers registered with a CNPJ document.
string
Company legal representative name.
string
Company legal representative phone number.
string
Company legal representative document.
object
Company legal representative address.
{
"name": "John Doe",
"email": "john@mail.com",
"phone": "(11) 99999-9999",
"document": "12.345.678/0001-00",
"address": {
"zipCode": "12345-000",
"country": "BR",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Alphaville",
"street": "Rua dos Frades",
"number": "33A",
"complement": "Sala 2"
},
"legalRepresentative": {
"name": "Maria Doe",
"phone": "(11) 95555-5555",
"document": "123.456.789-00",
"address": {
"zipCode": "45678-000",
"country": "BR",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulista",
"street": "Rua dos Bobos",
"number": "0",
"complement": "Casa"
}
}
}
Was this page helpful?