Documentação Malga API (0.5)
Download OpenAPI specification:Download
Os serviços de API da Malga são protegidos através de chaves de acesso. Você pode gerenciar suas chaves de acesso através do seu dashboard.
É importante armazenar suas chaves de maneira privada e segura uma vez que elas possuem privilégios de alteração na sua conta. Não compartilhe suas chaves, não deixe elas fixadas no seu código e nem armazene elas no seu servidor de controle de versão. Recomendamos utilizar variáveis de ambiente secretas para deixar a chave disponível para sua aplicação.
A Autenticação para todos os chamadas da API é feita através de headers HTTP, sendo necessário informar seu identificador de cliente na Malga e a chave secreta de acesso.
Identificador única da sua conta na Malga. Deve ser enviado no header obrigatóriamente em todas as requisições feitas a API.
Security Scheme Type | API Key |
---|---|
Header parameter name | X-Client-ID |
Sua chave de acesso a API. Funciona em par com o client-id devendo ser enviado no header obrigatóriamente em todas as requisições feitas a API.
Security Scheme Type | API Key |
---|---|
Header parameter name | X-Api-Key |
curl --location --request GET 'https://api.malga.io/v1/' \
--header 'X-Client-Id: <YOUR_CLIENT_ID>' \
--header 'X-Api-Key: <YOUR_SECRET_KEY>'
É possível criar chaves públicas de acesso temporária a API com escopo e tempo de expiração limitados.
Recomendamos o uso deste tipo de chave quando você tiver que expor a chave em uma aplicação client side.
Detalhe dos parâmetros da chamada de criação da chave pública:
scope | string Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers" determina o escopo de endpoints que a chave terá acesso |
expires | number Default: 0 prazo de validade da chave em segundos a partir da criação, zero para não expirar |
{- "scope": "customers",
- "expires": 0
}
Retorno da chamada de criação da chave pública:
scope | string Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers" determina o escopo de endpoints que a chave terá acesso |
expires | number prazo de validade da chave em segundos a partir da criação, zero para não expirar |
clientId | string <uuid> identificador do cliente na Malga |
publicKey | string <uuid> chave pública criada |
{- "scope": "customers",
- "expires": 0,
- "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
- "publicKey": "29f62ed2-b67a-44ba-84f5-217ecee94438"
}
Criar nova chave pública para uso no client-side
Authorizations:
Request Body schema: application/json
Creat authentication token
scope | string Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers" determina o escopo de endpoints que a chave terá acesso |
expires | number Default: 0 prazo de validade da chave em segundos a partir da criação, zero para não expirar |
Responses
Request samples
- Payload
{- "scope": [
- "tokens"
], - "expires": 31104000
}
Response samples
- 201
- 400
- 500
{- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "publicKey": "<YOUR_PUBLIC_KEY>",
- "scope": [
- "tokens"
], - "expires": 31104000,
- "createdAt": "20200110 00:00:00"
}
Dados básicos de uma requisição de criação de card token
TokenCard (object) or TokenCvv (object) Pode ser tokenizado o cartão e/ou cvv de acordo com a passagem dos atributos | |||||||||
One of
|
null
Criar um novo token
Authorizations:
Request Body schema: application/json
Tokenizar
TokenCard (object) or TokenCvv (object) Pode ser tokenizado o cartão e/ou cvv de acordo com a passagem dos atributos | |||||||||
One of
|
Responses
Request samples
- Payload
- Python
{- "cardHolderName": "JOSE DAS NEVES",
- "cardNumber": "4019598346009339",
- "cardCvv": "123",
- "cardExpirationDate": "12/2026"
}
Response samples
- 201
- 400
- 500
{- "tokenId": "cc0b1e41-2936-45c5-947f-93995ffcdc00"
}
Dados básicos de um objeto cartão
id | string ID do cartão | ||||||||||||||||||||||||||||||||||||||||||
expirationMonth | string Data de expiração MM | ||||||||||||||||||||||||||||||||||||||||||
expirationYear | string Data de expiração YYYY | ||||||||||||||||||||||||||||||||||||||||||
brand | string Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners" Bandeira | ||||||||||||||||||||||||||||||||||||||||||
cvvChecked | boolean Identifica se o CVV foi verificado | ||||||||||||||||||||||||||||||||||||||||||
fingerprint | string Hash de identificação única do cartão com base nos dados sensíveis | ||||||||||||||||||||||||||||||||||||||||||
first6digits | string Primeiros 6 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
last4digits | string Últimos 4 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "failed" "active" "pending" Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente) | ||||||||||||||||||||||||||||||||||||||||||
statusReason | string Contém uma string com um breve descritivo informando o motivo do status do cartão. Em alguns casos uma string vazia é retornada. | ||||||||||||||||||||||||||||||||||||||||||
createdAt | string Data de criação do cartão | ||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Data de atualização do cartão | ||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||
|
{- "id": "string",
- "expirationMonth": "string",
- "expirationYear": "string",
- "brand": "American Express",
- "cvvChecked": true,
- "fingerprint": "string",
- "first6digits": "string",
- "last4digits": "string",
- "status": "failed",
- "statusReason": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "customer": {
- "id": "string",
- "createdAt": "string",
- "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
- "name": "string",
- "email": "string",
- "phoneNumber": "string",
- "document": {
- "type": "string",
- "number": "string",
- "country": "AL"
}, - "address": {
- "street": "string",
- "streetNumber": "string",
- "complement": "string",
- "zipCode": "string",
- "country": "AL",
- "state": "string",
- "city": "string",
- "district": "string"
}
}
}
Criar novo cartão a partir de token
Authorizations:
Request Body schema: application/json
Create credit card
tokenId required | string <uuid> Identificador do token gerado |
merchantId | string <uuid> Caso queria validar o cartão via zero dollar, informe o merchantId que possui pelo menos 1 provedor com suporte a validação zero dollar. |
cvvCheck | boolean Mesmo informando o merchantId, é possível desabilitar a validação do cvv (zero dollar). Informe true para validar ou false para pular a validação. Caso você informe false, a verificação será pulada e o cartão será criado como pending necessitando validar via uma transação. |
Responses
Request samples
- Payload
- Python
{- "tokenId": "82aba896-9e37-45b6-aa90-d510c9050596"
}
Response samples
- 201
- 400
- 424
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "status": "active",
- "statusReason": null,
- "createdAt": "2012-08-11T19:02:56.713Z",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "brand": "Visa",
- "cardHolderName": "JOAO DA SILVA",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "expirationMonth": "12",
- "expirationYear": "2026"
}
Listar cartões
Authorizations:
query Parameters
page | number número da página |
limit | number quantidade de itens por página |
Responses
Response Schema: application/json
object | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
- 400
- 500
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "expirationMonth": "12",
- "expirationYear": "2026",
- "brand": "Visa",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "status": "active"
}
]
}
Recuperar detalhes de cartão
Authorizations:
path Parameters
id required | string <uuid> ID do cartão |
Responses
Response Schema: application/json
id | string ID do cartão | ||||||||||||||||||||||||||||||||||||||||||
expirationMonth | string Data de expiração MM | ||||||||||||||||||||||||||||||||||||||||||
expirationYear | string Data de expiração YYYY | ||||||||||||||||||||||||||||||||||||||||||
brand | string Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners" Bandeira | ||||||||||||||||||||||||||||||||||||||||||
cvvChecked | boolean Identifica se o CVV foi verificado | ||||||||||||||||||||||||||||||||||||||||||
fingerprint | string Hash de identificação única do cartão com base nos dados sensíveis | ||||||||||||||||||||||||||||||||||||||||||
first6digits | string Primeiros 6 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
last4digits | string Últimos 4 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "failed" "active" "pending" Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente) | ||||||||||||||||||||||||||||||||||||||||||
statusReason | string Contém uma string com um breve descritivo informando o motivo do status do cartão. Em alguns casos uma string vazia é retornada. | ||||||||||||||||||||||||||||||||||||||||||
createdAt | string Data de criação do cartão | ||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Data de atualização do cartão | ||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 400
- 424
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "status": "active",
- "statusReason": null,
- "createdAt": "2012-08-11T19:02:56.713Z",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "brand": "Visa",
- "cardHolderName": "JOAO DA SILVA",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "expirationMonth": "12",
- "expirationYear": "2026"
}
Através da API de customers
é possível realizar a criação, edição, listagem e exclusão de dados de compradores para uso nos serviços de tokenização de cartões, cobrança por PIX, Boleto, uso em análise de motores de antifraude e recorrência.
A fim de manter maior integridade dos dados, as informações de email e documento (CPF/CNJP) são únicos para customers na sua conta Malga, não podendo existir dois compradores iguais.
Consulte a tabela de tipos de paises e documentos suportados para criação de customer
Criação de novo customer para cobrança
Authorizations:
Request Body schema: application/json
name required | string nome do usuario | ||||||||||||||||
email required | string email do usuario | ||||||||||||||||
phoneNumber required | string telefone de contato do usuario | ||||||||||||||||
required | object | ||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "name": "Customer test",
- "email": "jose2@gmail.com",
- "phoneNumber": "21 98889999099",
- "document": {
- "number": "97055503019",
- "type": "cpf",
- "country": "BR"
}, - "address": {
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon",
- "zipCode": "25650011",
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203"
}
}
Listagem de customers cadastrados
Authorizations:
query Parameters
page | number número da página |
limit | number quantidade de itens por página |
sort | string Enum: "ASC" "DESC" ordenação dos itens |
id | string identificador de um customer |
document.type | string tipo de documento |
document.number | string numero do documento |
Responses
Response Schema: application/json
object | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "name": "Customer test",
- "email": "jose2@gmail.com",
- "phoneNumber": "21 98889999099",
- "document": {
- "number": "97055503019",
- "type": "cpf",
- "country": "BR"
}, - "address": {
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon",
- "zipCode": "25650011",
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203"
}
}
]
}
Recuperar detalhes de customer
Authorizations:
path Parameters
id required | string <uuid> id do customers que deseja recuperar |
Responses
Response Schema: application/json
id | string identificador do customer | ||||||||||||||||
createdAt | string data de criação | ||||||||||||||||
clientId | string <uuid> identificador do client | ||||||||||||||||
name | string nome do usuario | ||||||||||||||||
string email do usuario | |||||||||||||||||
phoneNumber | string telefones de contato do usuario | ||||||||||||||||
object | |||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "id": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "name": "Customer test",
- "email": "jose2@gmail.com",
- "document": {
- "number": "97055503019",
- "type": "cpf",
- "country": "BR"
}, - "phoneNumber": "21 98889999099",
- "address": {
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon",
- "zipCode": "25650011",
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203"
}
}
Atualizar customer pelo id
Authorizations:
path Parameters
id required | string <uuid> id do customers que deseja alterar |
Request Body schema: application/json
name | string nome do usuario | ||||||||||||||||
phoneNumber | string telefone de contato do usuario | ||||||||||||||||
object | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "name": "string",
- "phoneNumber": "string",
- "address": {
- "street": "string",
- "streetNumber": "string",
- "complement": "string",
- "zipCode": "string",
- "country": "AL",
- "state": "string",
- "city": "string",
- "district": "string"
}
}
Adicionar cartão de crédito ao customer
Authorizations:
path Parameters
customer_id required | string <uuid> id do customers que deseja alterar |
Request Body schema: application/json
cardId required | string Identificador do cartão a ser associado |
Responses
Request samples
- Payload
{- "cardId": "82aba896-9e37-45b6-aa90-d510c9050596"
}
Listagem dos cartões do customer
Authorizations:
path Parameters
customer_id required | string <uuid> id do customers que deseja alterar |
Responses
Response Schema: application/json
object | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "expirationMonth": "12",
- "expirationYear": "2026",
- "brand": "Visa",
- "cvvChecked": true,
- "fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
- "first6digits": "401959",
- "last4digits": "9339",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "status": "active"
}
]
}
Para realizar uma cobrança deve criar um objeto charge
. É possível recuperar detalhes de transações individuais ou listar todas as cobranças realizadas em um determinado merchant
. Os charges
são identificados a partir de um id 'único'.
Dados básicos de um objeto do tipo charge
id | string identificador da transação | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clientId | string <uuid> identificador do cliente na Malga | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merchantId | string <uuid> identificador do merchant id utilizado na transação | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerId | string <uuid> identificador do customer id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Descrição da cobrança para consulta futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount | number valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string Default: "BRL" Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statementDescriptor | string descrição a ser exibida na fatura do comprador | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
capture | boolean determina se a transação deve ser capturada automaticamente | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isDispute | boolean determina se a transação está em disputa | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back" status da transação na Malga | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) or PaymentMethodDripObject (object) or PaymentMethodVoucherObject (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string Data de criação do cartão | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Data de atualização do cartão | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para analise de fraude | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Campos adicionais para uso em condicionais dos fluxos inteligentes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (3DSecure2Response) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Informações sobre a rastreabilidade da cobrança | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
Realizar nova cobrança
Authorizations:
Request Body schema: application/json
merchantId required | string <uuid> Identificação do merchant id a ser utilizado | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount required | number Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string Default: "BRL" Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statementDescriptor | string Descrição a ser exibida fatura do comprador | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
capture | boolean Default: false Determina se a transação deve ser capturada automaticamente | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Descrição da cobrança para consulta futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerId | string <uuid> Identificador de comprador para consulta futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) or PaymentMethodNuPay (object) or PaymentMethodDrip (object) or PaymentMethodVoucher (object) Define o método de cobrança | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) or SourceTypeCardCvv (object) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SplitRules) [ items ] Parâmetros adicionais para transacionar com Split | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Campos adicionais para uso em condicionais dos fluxos inteligentes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para transacionar com 3D Secure 2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Informações sobre a rastreabilidade da cobrança | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}, - "merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
- "amount": 150,
- "currency": "BRL",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}
}
Response samples
- 201
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
Listar cobranças
Authorizations:
query Parameters
page | number numero da pagina ativa |
limit | number quantidade de registros por página 1-100 |
sort | string Enum: "ASC" "DESC" tipo de ordenação decrescente ou crescente |
merchantId | string <uuid> id do merchant processado na cobrança |
id | string <uuid> id da cobrança |
originalAmount | number valor em centavos da cobrança |
status | string Enum: "pending" "pre_authorized" "authorized" "voided" "refund_pending" "canceled" "charged_back" status da cobrança |
paymentType | string Enum: "credit" "pix" "boleto" tipo de pagamento |
orderId | string id da cobrança gerado pelo cliente |
created | string Example: created=2022-03-12T12:43:53 registros criados em uma data específica |
created.gt | string Example: created.gt=2022-03-12T12:43:53 registros com data maior que |
created.lt | string Example: created.lt=2022-03-12T12:43:53 registros com data menor que |
Responses
Response Schema: application/json
object | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
- 400
- 500
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
]
}
Recuperar detalhes de cobrança
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja recuperar |
Responses
Response Schema: application/json
object | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
Alterar o status de uma cobrança no ambiente de sandbox
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja alterar no sandbox |
Request Body schema: application/json
status | string Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "charged_back" "created" "processed" "capture_pending" "refund_pending" status da transação |
Responses
Response Schema: application/json
id | string identificador da transação | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clientId | string <uuid> identificador do cliente na Malga | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merchantId | string <uuid> identificador do merchant id utilizado na transação | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerId | string <uuid> identificador do customer id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Descrição da cobrança para consulta futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount | number valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string Default: "BRL" Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statementDescriptor | string descrição a ser exibida na fatura do comprador | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
capture | boolean determina se a transação deve ser capturada automaticamente | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isDispute | boolean determina se a transação está em disputa | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back" status da transação na Malga | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) or PaymentMethodDripObject (object) or PaymentMethodVoucherObject (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string Data de criação do cartão | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Data de atualização do cartão | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para analise de fraude | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Campos adicionais para uso em condicionais dos fluxos inteligentes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (3DSecure2Response) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Informações sobre a rastreabilidade da cobrança | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "status": "charged_back"
}
Response samples
- 200
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
Alterar o status do antifraude no ambiente de sandbox
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja alterar no sandbox |
Request Body schema: application/json
status | string Enum: "approved" "reproved" "failed" status do antifraude |
Responses
Response Schema: application/json
id | string identificador da transação | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clientId | string <uuid> identificador do cliente na Malga | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
merchantId | string <uuid> identificador do merchant id utilizado na transação | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerId | string <uuid> identificador do customer id | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Descrição da cobrança para consulta futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount | number valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string Default: "BRL" Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statementDescriptor | string descrição a ser exibida na fatura do comprador | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
capture | boolean determina se a transação deve ser capturada automaticamente | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isDispute | boolean determina se a transação está em disputa | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back" status da transação na Malga | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) or PaymentMethodDripObject (object) or PaymentMethodVoucherObject (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | string Data de criação do cartão | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Data de atualização do cartão | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para analise de fraude | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Campos adicionais para uso em condicionais dos fluxos inteligentes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (3DSecure2Response) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Informações sobre a rastreabilidade da cobrança | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Request samples
- Payload
{- "status": "approved"
}
Response samples
- 200
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
Capturar cobrança pre-autorizada
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja capturar |
Request Body schema: application/json
amount | number valor da captura em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00 |
Responses
Request samples
- Payload
{- "amount": 150
}
Response samples
- 201
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
Estornar cobrança aprovada
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja estornar |
Request Body schema: application/json
amount | number valor do estorno em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00 |
delayToCompose | number número de dias para compor o valor a ser estornado. Utilizado apenas pela NuPay. |
Responses
Request samples
- Payload
{- "amount": 150
}
Response samples
- 201
- 400
- 500
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "currency": "BRL",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "statementDescriptor": "LOJA JOAO",
- "description": "Descrição longa da cobrança",
- "capture": false,
- "isDispute": false,
- "status": "pre_authorized",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
], - "appInfo": {
- "platform": {
- "integrator": "malga",
- "name": "pluging-vtex-ppp",
- "version": "1.12"
}, - "device": {
- "name": "iOS",
- "version": "10.12"
}, - "system": {
- "name": "VTEX",
- "version": "13.12"
}
}
}
Através da API de sessões é possível criar um pedido, composto por itens, métodos de pagamento e outros atributos, que pode ser pago através de um endpoint ou integrado ao MalgaCheckout.
- Crie uma
sessão
informando os dados básicos necessários - Utilize a
publicKey
retornada na criação ou recuperada na rota de detalhes noX-Api-Key
para autenticar o pagamento
Dados básicos de um objeto do tipo session
id | string Identificação da sessão a ser utilizada | ||||||||||
name | string Nome que identifica a sessão | ||||||||||
status | string Enum: "created" "paid" "canceled" "voided" Status da sessão | ||||||||||
isActive | boolean Determina se a sessão está ativa | ||||||||||
clientId | string Identificador do cliente na Malga | ||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||
amount | number Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||
currency | string Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||
capture | boolean Determina se a transação deve ser capturada automaticamente | ||||||||||
merchantId | string Identificação do merchant id a ser utilizado | ||||||||||
dueDate | string Data de expiração de uma sessão | ||||||||||
description | string Descrição da sessão | ||||||||||
statementDescriptor | string Descrição a ser exibida fatura do comprador | ||||||||||
Array of objects (SessionItemObject) [ items ] Itens do pedido | |||||||||||
Array
| |||||||||||
paymentLink | string Link para acessar o Link de Pagamento desta sessão | ||||||||||
PaymentMethodCardObject (array) or PaymentMethodPixObject (array) or PaymentMethodBoletoObject (array) or PaymentMethodDripObjectRequest (array) Métodos de pagamento disponíveis na sessão | |||||||||||
One of array | |||||||||||
createdAt | string Data de criação da sessão | ||||||||||
updatedAt | string Data da atualização da sessão | ||||||||||
publicKey | string Chave de acesso com escopo restrito, usada para pagar a sessão |
{- "id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "name": "Nome da sessão",
- "status": "created",
- "isActive": true,
- "clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "orderId": null,
- "amount": 100,
- "currency": "BRL",
- "capture": true,
- "merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
- "dueDate": "2022-10-25T09:28:45.000Z",
- "description": "Promoção Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "paymentMethods": [
- {
- "paymentType": "credit",
- "installments": 1
}
], - "items": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "name": "Item 1",
- "description": "Descrição do item",
- "unitPrice": 10000,
- "quantity": 1,
- "tangible": false
}
], - "createdAt": "2022-10-25T09:28:45.000Z",
- "updatedAt": "2022-10-25T09:28:45.000Z",
- "publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1"
}
Criar nova sessão
Authorizations:
Request Body schema: application/json
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||
amount required | number Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||
currency | string Default: "BRL" Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||
isActive | boolean Determina se a sessão está ativa | ||||||||||
capture | boolean Determina se a transação deve ser capturada automaticamente | ||||||||||
merchantId required | string Identificação do merchant id a ser utilizado | ||||||||||
dueDate required | string Data de expiração de uma sessão | ||||||||||
name required | string Nome que identifica a sessão | ||||||||||
description | string Descrição da sessão | ||||||||||
statementDescriptor | string Descrição a ser exibida fatura do comprador | ||||||||||
createLink | boolean Determina se a sessão terá um Link de Pagamento | ||||||||||
required | PaymentMethodCardObject (object) or PaymentMethodPixObjectRequest (object) or PaymentMethodBoletoObjectRequest (object) or PaymentMethodDripObjectRequest (object) Métodos de pagamento disponíveis na sessão | ||||||||||
Any of
| |||||||||||
required | Array of objects (SessionItemObject) [ items ] Itens do pedido | ||||||||||
Array
|
Responses
Request samples
- Payload
{- "amount": 100,
- "name": "Loja 1",
- "merchantId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "dueDate": "2022-10-25T09:28:45.000Z",
- "paymentMethods": [
- {
- "paymentType": "pix",
- "expiresIn": 30
}
], - "items": [
- {
- "name": "Item 1",
- "description": "Item do carrinho",
- "unitPrice": 1000,
- "quantity": 1,
- "tangible": false
}
]
}
Response samples
- 201
{- "id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
- "name": "Pedido 1",
- "status": "created",
- "isActive": true,
- "clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
- "orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
- "amount": 100,
- "currency": "BRL",
- "capture": true,
- "merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
- "dueDate": "2022-10-26T19:32:08.000Z",
- "description": "Pedido Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "items": [
- {
- "name": "Item 1",
- "description": "Item do carrinho",
- "unitPrice": 1000,
- "quantity": 1,
- "tangible": false
}
], - "paymentMethods": [
- {
- "paymentType": "pix",
- "expiresIn": 30
}
], - "createdAt": "2022-10-25T22:49:06.588Z",
- "updatedAt": "2022-10-25T22:49:06.588Z",
- "publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}
Recuperar detalhes de uma sessão
Authorizations:
path Parameters
id required | string <uuid> Identificação da sessão a ser recuperada |
Responses
Response samples
- 201
{- "id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
- "name": "Pedido 1",
- "status": "created",
- "isActive": true,
- "clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
- "orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
- "amount": 100,
- "currency": "BRL",
- "capture": true,
- "merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
- "dueDate": "2022-10-26T19:32:08.000Z",
- "description": "Pedido Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "items": [
- {
- "name": "Item 1",
- "description": "Item do carrinho",
- "unitPrice": 1000,
- "quantity": 1,
- "tangible": false
}
], - "paymentMethods": [
- {
- "paymentType": "pix",
- "expiresIn": 30
}
], - "createdAt": "2022-10-25T22:49:06.588Z",
- "updatedAt": "2022-10-25T22:49:06.588Z",
- "publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}
Pagar uma sessão
Authorizations:
path Parameters
id required | string <uuid> Identificação da sessão a ser paga |
Request Body schema: application/json
customerId | string <uuid> Identificador de comprador para consulta futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) or PaySessionPaymentMethodDripObjectRequest (object) Define o método de cobrança | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}
}
Response samples
- 201
{- "id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "merchantId": "148d5db0-f1c3-439f-902d-f1f268086e1d",
- "description": "Descrição longa da cobrança",
- "orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
- "createdAt": "2012-06-30 23:59:59 +0000",
- "amount": 150,
- "originalAmount": 150,
- "currency": "BRL",
- "statementDescriptor": "LOJA JOAO",
- "status": "pending",
- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
}, - "transactionRequests": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
- "providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
- "providerType": "STRIPE",
- "transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
- "amount": 1500,
- "authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
- "requestStatus": "success",
- "requestType": "authorization",
- "responseTs": "2633ms",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:42.212Z",
- "providerAuthorization": {
- "networkAuthorizationCode": "00",
- "networkResponseCode": ""
}
}
]
}
Recuperar o histórico da sessão
Authorizations:
path Parameters
id required | string <uuid> Identificação da sessão a ser recuperada |
Responses
Response samples
- 201
[- {
- "status": "created",
- "id": "82aba896-9e37-45b6-aa90-d510c9050596",
- "createdAt": "2022-11-11T16:35:38.870Z",
- "updatedAt": "2022-11-11T16:35:38.870Z"
}
]
Recupera sessão com os dados das configurações da empresa
Authorizations:
path Parameters
id required | string <uuid> Identificação da sessão a ser recuperada |
Responses
Response samples
- 201
{- "id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "name": "Nome da sessão",
- "status": "created",
- "isActive": true,
- "clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "orderId": null,
- "amount": 100,
- "currency": "BRL",
- "capture": true,
- "merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
- "dueDate": "2022-10-25T09:28:45.000Z",
- "description": "Promoção Black Friday",
- "statementDescriptor": "LOJA JOAO",
- "paymentMethods": [
- {
- "paymentType": "credit",
- "installments": 1
}
], - "items": [
- {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "name": "Item 1",
- "description": "Descrição do item",
- "unitPrice": 10000,
- "quantity": 1,
- "tangible": false
}
], - "createdAt": "2022-10-25T09:28:45.000Z",
- "updatedAt": "2022-10-25T09:28:45.000Z",
- "publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "settings": {
- "id": "78601913-a176-4d71-b7e8-abb6fc49a340",
- "email": "company@email.com",
- "phone": "5551996225566",
- "statementDescription": "LOJA JOAO",
- "mainColor": "#fff000",
- "secondaryColor": "#fff000",
- "attentionColor": "#333333",
- "errorColor": "#ff0000",
- "successColor": "#00FF00",
- "backgroundColor": "#fff000",
- "companyName": "Company Name",
- "clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "documentNumber": "011001001001000010",
- "language": "pt_BR"
}
}
Para realizar uma cobrança com Split, antes é necessário criar um seller
. Os sellers
são identificados a partir de um id 'único'.
Através das APIs de sellers
é possível realizar a criação e configuração de recebedores que serão beneficiados em um Split. Uma recebedor, ou um seller
, é um cadastro de pessoa física ou jurídica para quem você tenha interesse em repassar automaticamente valores de uma determinada cobrança.
Observe que os campos owner
e business
são opcionais. Entretanto se o provider for Zoop e o campo business
for enviado, o owner
se torna obrigatório.
merchantId required | string identificação do merchant id a ser utilizado | ||||||||||||||||||||||||||||||||||||||||||||||
mcc required | number código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code. | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
required | object | ||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
required | object | ||||||||||||||||||||||||||||||||||||||||||||||
|
{- "merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
- "owner": {
- "name": "Seller test",
- "email": "seller@gmail.com",
- "phoneNumber": "21 98889999099",
- "birthdate": "27-01-1995",
- "document": {
- "type": "cpf",
- "number": "36243319067",
- "country": "BR"
}, - "address": {
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203",
- "zipCode": "25650011",
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon"
}
}, - "business": {
- "name": "Seller business test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "website": "www.sellerbusiness.com.br",
- "description": "Seller business",
- "facebook": "facebook Seller business",
- "twitter": "twitter Seller business",
- "openingDate": "27-01-1995",
- "address": {
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "sala 100",
- "zipCode": "61000-320",
- "country": "BR",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "type": "cnpj",
- "number": "94938591000196",
- "country": "BR"
}
}, - "mcc": 4040,
- "bankAccount": {
- "holderName": "Seller Name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "12",
- "type": "conta_corrente"
}, - "transferPolicy": {
- "transferDay": 5,
- "transferEnabled": true,
- "transferInterval": "weekly",
- "automaticAnticipationEnabled": false,
- "anticipatableVolumePercentage": "",
- "automaticAnticipationType": "",
- "automaticAnticipationDays": "",
- "automaticAnticipation1025Delay": ""
}
}
Criação de um novo recebedor
Authorizations:
Request Body schema: application/json
merchantId | string Identificação do merchant | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
mcc | string Código de segmento do lojista no adquirente | ||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
- "owner": {
- "name": "Seller test",
- "email": "seller@gmail.com",
- "phoneNumber": "21 98889999099",
- "birthdate": "27-01-1995",
- "document": {
- "type": "cpf",
- "number": "36243319067",
- "country": "BR"
}, - "address": {
- "street": "Av Geraldo Cardoso",
- "streetNumber": "205",
- "complement": "Apto 203",
- "zipCode": "25650011",
- "country": "BR",
- "state": "Rio de Janeiro",
- "city": "Rio de Janeiro",
- "district": "Leblon"
}
}, - "business": {
- "name": "Seller business test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "website": "www.sellerbusiness.com.br",
- "description": "Seller business",
- "facebook": "facebook Seller business",
- "twitter": "twitter Seller business",
- "openingDate": "27-01-1995",
- "address": {
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "sala 100",
- "zipCode": "61000-320",
- "country": "BR",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "type": "cnpj",
- "number": "94938591000196",
- "country": "BR"
}
}, - "mcc": 4040,
- "bankAccount": {
- "holderName": "Seller Name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "12",
- "type": "conta_corrente"
}, - "transferPolicy": {
- "transferDay": 5,
- "transferEnabled": true,
- "transferInterval": "weekly",
- "automaticAnticipationEnabled": false,
- "anticipatableVolumePercentage": "",
- "automaticAnticipationType": "",
- "automaticAnticipationDays": "",
- "automaticAnticipation1025Delay": ""
}
}
Response samples
- 201
- 400
- 500
{- "id": "19d05a45-0e92-478e-8366-955231bcf3d6",
- "providers": {
- "providerType": "SANDBOX",
- "externalId": "1966811",
- "externalStatus": "active",
- "externalStatusReason": "ok",
- "status": "pending",
- "createdAt": "2022-12-21T23:10:13.498Z",
- "updatedAt": "2022-12-21T20:10:13.951Z"
}, - "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "clientid": "e234eeb3-483d-4df2-87eb-1e2be5cdaccd",
- "metadata": null,
- "owner": {
- "id": "8231ba21-3758-4bd7-b664-5b5fdeda37a0",
- "updatedAt": "2023-07-11T23:02:51.581Z",
- "createdAt": "2023-07-11T23:02:51.581Z",
- "name": "Seller",
- "email": "seller@email.com",
- "phoneNumber": "85988350264",
- "birthdate": "1995-01-27T02:00:00.000Z",
- "address": {
- "country": "BR",
- "id": "883631f0-fea0-4682-ae1a-f4ac6349e0d9",
- "updatedAt": "2023-07-11T23:02:51.585Z",
- "createdAt": "2023-07-11T23:02:51.585Z",
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "casa 4",
- "zipCode": "61000-320",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "country": "BR",
- "id": "32543bbe-42c1-4000-9b68-d01a2735708e",
- "updatedAt": "2023-07-11T23:02:51.588Z",
- "createdAt": "2023-07-11T23:02:51.588Z",
- "type": "cpf",
- "number": "36243319067"
}
}, - "business": {
- "id": "607bb56a-974a-4d1d-9f56-cda865dfafbd",
- "updatedAt": "2023-07-11T23:02:51.571Z",
- "createdAt": "2023-07-11T23:02:51.571Z",
- "name": "Seller business",
- "phoneNumber": "85988350264",
- "email": "seller@email.com",
- "website": "www.sellerbusiness.com.br",
- "description": "Seller business",
- "facebook": "facebook Seller business",
- "twitter": "twitter Seller business",
- "openingDate": "1995-01-27",
- "address": {
- "country": "BR",
- "id": "b681dd2e-ebdb-4fad-8c8b-e703a17825ce",
- "updatedAt": "2023-07-11T23:02:51.574Z",
- "createdAt": "2023-07-11T23:02:51.574Z",
- "street": "Rua Nova Lua",
- "streetNumber": "30",
- "complement": "sala 100",
- "zipCode": "61000-320",
- "state": "CE",
- "city": "Maracanaú",
- "district": "AB"
}, - "document": {
- "country": "BR",
- "id": "b9380f2c-a657-4f47-a7da-21f3bf08182c",
- "updatedAt": "2023-07-11T23:02:51.578Z",
- "createdAt": "2023-07-11T23:02:51.578Z",
- "type": "cnpj",
- "number": "94938591000196"
}
}, - "bankAccount": {
- "id": "f7ac3221-8f69-4276-b88b-34ddbe5ec24a",
- "updatedAt": "2023-07-11T23:02:51.563Z",
- "createdAt": "2023-07-11T23:02:51.563Z",
- "holderName": "Seller name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "22",
- "type": "conta_corrente"
}, - "transferPolicy": {
- "id": "a04bca24-f7d1-4cb5-acce-41f12680e5bf",
- "updatedAt": "2023-07-11T23:02:51.567Z",
- "createdAt": "2023-07-11T23:02:51.567Z",
- "transferDay": "5",
- "transferEnabled": true,
- "transferInterval": "weekly",
- "automaticAnticipationEnabled": false,
- "anticipatableVolumePercentage": "",
- "automaticAnticipationType": "",
- "automaticAnticipationDays": "",
- "automaticAnticipation1025Delay": ""
}, - "mcc": 4040,
- "status": "active"
}
Consultar um recebedor pelo ID
Authorizations:
path Parameters
id required | string <uuid> Identificador do seller |
Responses
Response Schema: application/json
merchantId | string Identificação do merchant | ||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
|